erbrowser/include/menu.h

Go to the documentation of this file.
00001 #ifndef __MENU_H__
00002 #define __MENU_H__
00003 
00004 /**
00005  * File Name  : menu.h
00006  *
00007  * Description: Control the popup menus
00008  */
00009 
00010 /*
00011  * This file is part of erbrowser.
00012  *
00013  * erbrowser is free software: you can redistribute it and/or modify
00014  * it under the terms of the GNU General Public License as published by
00015  * the Free Software Foundation, either version 2 of the License, or
00016  * (at your option) any later version.
00017  *
00018  * erbrowser is distributed in the hope that it will be useful,
00019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00021  * GNU General Public License for more details.
00022  *
00023  * You should have received a copy of the GNU General Public License
00024  * along with this program. If not, see <http://www.gnu.org/licenses/>.
00025  */
00026 
00027 /**
00028  * Copyright (C) 2009 iRex Technologies B.V.
00029  * All rights reserved.
00030  */
00031 
00032 
00033 //----------------------------------------------------------------------------
00034 // Include Files
00035 //----------------------------------------------------------------------------
00036 
00037 G_BEGIN_DECLS
00038 
00039 
00040 //----------------------------------------------------------------------------
00041 // Definitions
00042 //---------------------------------------------------------------------------- 
00043 
00044 
00045 //----------------------------------------------------------------------------
00046 // Forward Declarations
00047 //----------------------------------------------------------------------------
00048 
00049 
00050 //----------------------------------------------------------------------------
00051 // Type Declarations
00052 //----------------------------------------------------------------------------
00053 
00054 
00055 //----------------------------------------------------------------------------
00056 // Global Constants
00057 //----------------------------------------------------------------------------
00058 
00059 
00060 //============================================================================
00061 // Public Functions
00062 //============================================================================
00063 
00064 /**---------------------------------------------------------------------------
00065  *
00066  * Name :  menu_init
00067  *
00068  * @brief  Initialise popup menus
00069  *
00070  * @param  --
00071  *
00072  * @return --
00073  *
00074  *--------------------------------------------------------------------------*/
00075 void menu_init ( void );
00076 
00077 
00078 /**---------------------------------------------------------------------------
00079  *
00080  * Name :  menu_destroy
00081  *
00082  * @brief  Remove the popup menus
00083  *
00084  * @param  --
00085  *
00086  * @return --
00087  *
00088  *--------------------------------------------------------------------------*/
00089 void menu_destroy ( void );
00090 
00091 
00092 /**---------------------------------------------------------------------------
00093  *
00094  * Name :  menu_show
00095  *
00096  * @brief  Display the proper popup menu for the current context
00097  *
00098  * @param  --
00099  *
00100  * @return --
00101  *
00102  *--------------------------------------------------------------------------*/
00103 void menu_show ( void );
00104 
00105 
00106 /**---------------------------------------------------------------------------
00107  *
00108  * Name :  menu_set_text
00109  *
00110  * @brief  Initiliase text items in popup menu(s)
00111  *
00112  * @param  --
00113  *
00114  * @return --
00115  *
00116  *--------------------------------------------------------------------------*/
00117 void menu_set_text ( void );
00118 
00119 
00120 //----------------------------------------------------------------------------
00121 // Callbacks from popupmenu
00122 //----------------------------------------------------------------------------
00123 
00124 /**---------------------------------------------------------------------------
00125  *
00126  * Name :  menu_on_item_activated
00127  *
00128  * @brief  Handle a menu button that has been pressed by the user
00129  *
00130  * @param  [in] item  - item name of the activated item
00131  * @param  [in] group - name of the parent group of the activated item
00132  * @param  [in] menu  - name of the current menu
00133  * @param  [in] state - state of the item when activated
00134  *
00135  * @return --
00136  *
00137  *--------------------------------------------------------------------------*/
00138 void menu_on_item_activated ( const gchar *item,
00139                               const gchar *group,
00140                               const gchar *menu,
00141                               const gchar *state );
00142 
00143 void menu_set_full_screen   ( gboolean mode );
00144 void menu_set_zoom_level    ( gfloat zoom_level );
00145 
00146 G_END_DECLS
00147 
00148 #endif /* __MENU_H__ */
Generated by  doxygen 1.6.2-20100208