Editing Documentation/Maemo 5 Developer Guide/Using Multimedia Components/Using Games Start-up Screen
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
Warning: This page is 59 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
- | The | + | = Using Games Start-up Screen = |
+ | The osso-games-startup application is a generic game start-up interface, providing a common hildonized user interface view for game start-up control and configuration. | ||
+ | |||
+ | <div align="CENTER"> | ||
+ | |||
+ | {| summary="Basic osso-games-startup application screen" | ||
+ | |+ align="BOTTOM" |'''Figure 8.1:''' Basic osso-games-startup application screen | ||
+ | |- | ||
+ | | | ||
+ | <div align="CENTER">[[Image:basic_screen_with_plugins_chinook.png|Image basic_screen_with_plugins_chinook]]</div> | ||
+ | |} | ||
+ | |||
+ | </div> | ||
+ | |||
==Application Functionality == | ==Application Functionality == | ||
+ | To execute the game, the osso-games-startup application should be called. The game configuration file should be passed as an argument. Once loaded, osso-games-startup will create a common interface for all games and, if needed, will load a specific plug-in for each game. Games are activated through an auto-activating D-BUS message, which tells the game either to start, restart or to continue. In cases where no clean-up routine within the plug-in exists, it can also start the game to clean its state data. In these cases, the game usually does not open its own window, but kills the state data in the background instead. | ||
- | + | When the Play button is pressed, the D-BUS service defined in the configuration file will be executed. Games that do not use the glib mainloop must integrate some functionality to their mainloop (for more information about games without a glib mainloop see section [[#Integrating-non-gtk+ Games]]). | |
- | + | The service is called every time any communication between osso-games-startup and the game is needed. | |
- | |||
- | The | + | {| summary="The Games Start-up screen with a simple plug-in containing difficulty level and sound configuration" |
+ | |+ align="BOTTOM" |'''Figure 8.2:''' The Games Start-up screen with a simple plug-in containing difficulty level and sound configuration | ||
+ | |- | ||
+ | | | ||
+ | <div align="CENTER">[[Image:basic_screen_with_plugins_chinook.png|Image basic_screen_with_plugins_chinook]]</div> | ||
+ | |} | ||
- | [[Image:diagram_chinook.png]] | + | |
+ | |||
+ | The following diagram illustrates the operational execution flow of the osso-games-startup application. | ||
+ | |||
+ | {| summary="Activity Diagram" | ||
+ | |+ align="BOTTOM" |Activity Diagram | ||
+ | |- | ||
+ | | | ||
+ | <div align="CENTER">[[Image:diagram_chinook.png|Image diagram_chinook]]</div> | ||
+ | |} | ||
==Integration == | ==Integration == | ||
Line 19: | Line 46: | ||
* Games based on GTK+ | * Games based on GTK+ | ||
* Games based on other toolkits, such as SDL | * Games based on other toolkits, such as SDL | ||
+ | |||
===Integrating GTK+ Games === | ===Integrating GTK+ Games === | ||
+ | To integrate games based on GTK+, a configuration file should be created, defining the information necessary for the osso-games-startup application. The following example illustrates the contents of the configuration file: | ||
- | + | <div class="graybox"> | |
- | < | + | <nowiki> |
- | [Startup Entry] | + | [Startup Entry] |
- | # the name of the application | + | # the name of the application |
- | Name=example | + | Name=example |
- | # the current version of the application | + | # the current version of the application |
- | Version=0.2.0 | + | Version=0.2.0 |
- | # the title that | + | # the title that will be used, if not specified by the GettextPackage |
- | Title=Example | + | Title=Example |
- | # the GettextPackage to be used to locate the title string | + | # the GettextPackage to be used to locate the title string |
- | GettextPackage=example | + | GettextPackage=example |
- | # if the TitleId is defined, it | + | # if the TitleId is defined, it will search for it inside the gettext package |
- | TitleId=example_title | + | TitleId=example_title |
- | # if the game has a plug-in | + | # if the game has a plug-in |
- | PluginPath=/usr/share/example/example_plugin.so | + | PluginPath=/usr/share/example/example_plugin.so |
- | # the games-startup screen image | + | # the games-startup screen image |
- | Image=/usr/share/example/pixmaps/example.png | + | Image=/usr/share/example/pixmaps/example.png |
- | # the D- | + | # the D-BUS service, path and interface names |
- | ServiceName=com.domain.example | + | ServiceName=com.domain.example |
- | PathName=/com/domain/example | + | PathName=/com/domain/example |
- | InterfaceName=com.domain.example | + | InterfaceName=com.domain.example |
- | </ | + | </nowiki> |
- | + | </div> | |
- | |||
- | + | The game should be integrated with libosso to enable it to receive and send D-BUS messages, such as "pause", "restart" and "continue". In order to receive messages from the osso-games-startup application, the game must register the service as defined in the configuration file. | |
- | + | When sending messages to osso-games-startup, the game must use the service, path and interface name defined in the configuration file, but with a "_startup" suffix. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | Then a D-BUS service (a .service file) should be created, using the name of the service that executes the game binary, as defined in the configuration file. The following example illustrates the contents of the file: | |
- | < | + | <div class="graybox"> |
+ | [D-BUS Service] | ||
+ | Name=com.domain.example | ||
+ | Exec=/usr/games/wrapper/games/wrapper.l | ||
+ | </div> | ||
+ | |||
+ | |||
+ | Finally, the game must create a shell script that calls the osso-games-startup application executable, and passes the game configuration file as an argument. The following example illustrates the contents of the script: | ||
+ | |||
+ | <div class="graybox"> | ||
/usr/bin/osso_games_startup /usr/share/example/example.conf | /usr/bin/osso_games_startup /usr/share/example/example.conf | ||
- | </ | + | </div> |
+ | |||
+ | |||
===Integrating non-GTK+ Games === | ===Integrating non-GTK+ Games === | ||
+ | In order to integrate non-GTK+ applications to osso-games-startup, the only thing different is the actual game implementation. The same steps should be followed to create osso desktop files and registering dbus services as for GTK+ based games; the only difference is that Nokia is providing a hildon-games-wrapper library to deal with dbus messaging without the use of libosso. | ||
- | + | To initialize game application to receive events from osso-games-startup, the developer can use following approach: snippets/games_integrating_non-gtk+-hgw__init | |
- | + | If and when hgw pointer is not null, the game is ready to receive dbus messages that are intended for the game application. The next step is to check, what state the game was started in. This happens by calling hgw_context_get_start_command(). The return values indicate the state the game should be going into. This is necessery, for example, when the game has been paused previously, the state of the game has been saved and the player wishes to continue the current game or restart the on-going game. Again, check the header file for HgwStartCommand for possible start values. | |
- | + | In the game's event loop, the user has to check if events are available by calling hgw_msg_check_incoming(). It will return HGW_ERR_COMMUNICATION if there are messages available, and other values if there are not or if there was error. (see hgw/hgw.h for more details about HgwError enum) Example: snippets/games_integrating_non-gtk+-HGW_ERR_ | |
- | + | Pointer *msg will then hold information about the received dbus message and the game application should then be able to process and act accordingly. Actual information about the received events is stored in msg->e_val which is an enumeration mapped against HgwCallback. | |
- | + | When the game ends or the game is requested to pause or quit, a call to hgw_context_destroy() should be made with initialized hgw as a parameter. | |
- | + | Also, hildon-games-wrapper library provides an interface to gconf. Gconf should be used to store persistent data like the level of difficulty, sounds on/off etc. This way is preferred, because the data stored in gconf is automatically backed up and restored, when the user so chooses (from desktop, back-up manager). However, this interface is read-only, as writing should be happening in the game-specific plug-in in the osso-games-startup screen. | |
- | + | ||
- | Also, | + | |
== Creating Game-Specific Plug-in == | == Creating Game-Specific Plug-in == | ||
- | + | Each game can create a plug-in for specific settings, such as sound control or difficulty level (see figure [localhost#fig:games_startup_app_screen_with_simple_plug-in 8.2]). Basically, each plug-in must implement some pre-defined functions that are executed by the osso-games-startup application. | |
- | Each game can create a plug-in for specific settings, such as sound control or difficulty level. Basically, each plug-in must implement some pre-defined functions that are executed by the | + | |
The functions that can be implemented by each plug-in are: | The functions that can be implemented by each plug-in are: | ||
- | * | + | * static GtkWidget *load_plugin (void) This function creates the game-specific plug-in. |
- | * | + | * static void unload_plugin (void) This function destroys global variables, if necessary. |
- | * | + | * static void write_config (void) This function saves the game configuration chosen by the player using the plug-in options. |
- | If the game needs a submenu in the | + | If the game needs a submenu in the osso-games-startup screen main menu (see figure [localhost#fig:basic_osso-games-startup_app_screen 8.1]), the following functions must be used: |
- | * | + | * static GtkWidget **load_menu (guint *) This function creates the game-specific submenu that is added to the osso-games-startup main menu. |
- | * | + | * static void update_menu (void) This function updates the game-specific menu. |
- | The struct below must be filled and sent to the | + | The struct below must be filled and sent to the osso-games-startup application. It specifies which plug-in functions the start-up must call. snippets/games_integrating_non-gtk+-StartupPluginInfo |
The last item on the struct is necessary only if the game plug-in requires items such as "save", "save as" or "open" to be a submenu in the default Game submenu. | The last item on the struct is necessary only if the game plug-in requires items such as "save", "save as" or "open" to be a submenu in the default Game submenu. | ||
- | Each plug-in must contain a reference to the | + | Each plug-in must contain a reference to the osso-games-startup info. The reference is given when STARTUP_INIT_PLUGIN is called. The following example illustrates a reference to osso-games-startup: snippets/games_integrating_non-gtk+-GameStartupInfo |
- | The following example illustrates the | + | The following example illustrates the STARTUP_INIT_PLUGIN that initializes the plug-in. The parameters, in the order they are shown, are: |
* Pointer for plug-in information (see the struct shown above) | * Pointer for plug-in information (see the struct shown above) | ||
- | * | + | * GameStartupInfo |
- | * Definition on whether the | + | * Definition on whether the osso-games-startup should send a D-BUS message on closing |
- | * Definition on whether the | + | * Definition on whether the osso-games-startup menu has open/save game options |
snippets/games_integrating_non-gtk+-STARTUP_INIT_PLUGIN | snippets/games_integrating_non-gtk+-STARTUP_INIT_PLUGIN | ||
- | In order to inform | + | In order to inform osso-games-startup that the game has a plug-in, the .conf configuration file of the game must include the PluginPath entry, such as PluginPath=datadir/game01/game01_plugin.so. |
- | + | ||
- | |||
+ | ===Building Example Plug-in for CrazyParking === | ||
This section illustrates the plug-in for CrazyParking implementation. The plug-in allows the player to set the initial level of the game, and to define whether the game uses sounds. | This section illustrates the plug-in for CrazyParking implementation. The plug-in allows the player to set the initial level of the game, and to define whether the game uses sounds. | ||
'''Games Start-up screen with CrazyParking plug-in's level and sound configuration''': | '''Games Start-up screen with CrazyParking plug-in's level and sound configuration''': | ||
- | [[Image: | + | <div align="CENTER">[[Image:game01_screen_chinook.png|Image game01_screen_chinook]]</div> |
- | + | The following code examples illustrate how the Games Start-up screen works, but the best way to learn to use it is to tinker with the game itself. The source code can be used as wished: as a basic skeleton for the game, or simply to gain a better understanding of the game start-up. | |
- | + | Since the plug-in and osso-games-startup are written with GTK+-2.0, they must include startup_plugin.h from osso-games-startup. In addition, Gconf is used to save the user settings. crazyparking/src/plugin/plugin.c | |
- | + | <tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><stdio.h></font></span> | |
+ | <span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><gtk/gtk.h></font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><startup_plugin.h></font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><gconf/gconf.h></font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><gconf/gconf-client.h></font></span> | ||
+ | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> MENU_SOUND <span><font color="#993399">15</font></span> | ||
+ | </tt> | ||
- | + | The following example illustrates the labels for retrieving information at GConf: crazyparking/src/plugin/plugin.c | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | <tt><span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> SETTINGS_LEVEL <span><font color="#FF0000">"/apps/osso/crazyparking/level"</font></span> | |
- | + | <span>'''<span><font color="#000080"><nowiki>#define</nowiki></font></span>'''</span> SETTINGS_SOUND <span><font color="#FF0000">"/apps/osso/crazyparking/sound"</font></span></tt> | |
- | < | + | |
- | #define | + | |
- | # | + | |
- | </ | + | |
The following example illustrates the functions that are implemented: | The following example illustrates the functions that are implemented: | ||
- | < | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span><span>'''<span><font color="#000000">load_plugin</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">);</font></span> |
- | static GtkWidget *load_plugin (void); | + | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">unload_plugin</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">);</font></span> |
- | static void unload_plugin (void); | + | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">write_config</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">);</font></span> |
- | static void write_config (void); | + | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>**</nowiki></font></span><span>'''<span><font color="#000000">load_menu</font></span>'''</span> <span><font color="#990000">(</font></span>guint <span><font color="#990000"><nowiki>*);</nowiki></font></span> |
- | static GtkWidget **load_menu (guint *); | + | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">update_menu</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">);</font></span> |
- | static | + | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">plugin_callback</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>menu_item<span><font color="#990000">,</font></span> <span><font color="#008080">gpointer</font></span> data<span><font color="#990000">);</font></span> |
- | + | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">settings_callback</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>widget<span><font color="#990000">,</font></span> <span><font color="#008080">gpointer</font></span> data<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">sound_callback</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>widget<span><font color="#990000">,</font></span> <span><font color="#008080">gpointer</font></span> data<span><font color="#990000">);</font></span></tt> | |
- | + | ||
- | </ | + | |
- | + | ||
- | + | ||
- | + | ||
- | < | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | static | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | </ | + | |
- | + | ||
- | + | ||
- | + | ||
- | < | + | |
- | static | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | </ | + | |
- | + | ||
- | + | ||
- | + | ||
- | < | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | + | ||
- | + | ||
- | < | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | The following example illustrates some global variables: crazyparking/src/plugin/plugin.c | |
- | + | ||
- | + | <tt><span><font color="#008080">GConfClient</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>gcc <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>board_box<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_1_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_2_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_3_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_4_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_5_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_6_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_7_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_8_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_9_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_10_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_11_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>level_12_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>settings_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>settings_menu<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>difficulty_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>difficulty_menu<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#008080">GameStartupInfo</font></span> gs<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>menu_items<span><font color="#990000">[</font></span><span><font color="#993399">2</font></span><span><font color="#990000">];</font></span> | ||
+ | <span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">int</font></span> changed <span><font color="#990000"><nowiki>=</nowiki></font></span> FALSE<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | GSList <span><font color="#990000"><nowiki>*</nowiki></font></span> group <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>sound_check <span><font color="#990000"><nowiki>=</nowiki></font></span> NULL<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>sound_item<span><font color="#990000"><nowiki>;</nowiki></font></span> </tt> | ||
- | + | The implemented functions of the plug-in must be sent to osso-games-startup: in this case, a GTK_SPIN_BUTTON and a GTK_CHECK_ITEM. If the plug-in has no specific menu, load_menu and update_menu must be NULL. crazyparking/src/plugin/plugin.c | |
- | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#008080">StartupPluginInfo</font></span> plugin_info <span><font color="#990000"><nowiki>=</nowiki></font></span> <span><font color="#FF0000">{</font></span> | |
- | + | load_plugin<span><font color="#990000">,</font></span> | |
+ | unload_plugin<span><font color="#990000">,</font></span> | ||
+ | write_config<span><font color="#990000">,</font></span> | ||
+ | load_menu<span><font color="#990000">,</font></span> | ||
+ | update_menu<span><font color="#990000">,</font></span> | ||
+ | NULL | ||
+ | <span><font color="#FF0000">}</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> </tt> | ||
- | + | The following example illustrates the initializing plug-in that informs the application that there is a plug-in: crazyparking/src/plugin/plugin.c | |
- | + | <tt><span>'''<span><font color="#000000">STARTUP_INIT_PLUGIN</font></span>'''</span><span><font color="#990000">(</font></span>plugin_info<span><font color="#990000">,</font></span> gs<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">);</font></span></tt> | |
- | + | The following example illustrates the function that initializes the widgets that localize the osso-games-startup standard buttons: crazyparking/src/plugin/plugin.c | |
- | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span><span>'''<span><font color="#000000">load_plugin</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">)</font></span> | |
- | } | + | <span><font color="#FF0000">{</font></span> |
- | </ | + | <span><font color="#009900">int</font></span> board<span><font color="#990000">,</font></span> enable_sound<span><font color="#990000"><nowiki>;</nowiki></font></span> |
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>game_hbox<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>board_hbox<span><font color="#990000">,</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>board_label<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>sound_hbox<span><font color="#990000">,</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>sound_label<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">g_type_init</font></span>'''</span><span><font color="#990000">();</font></span> | ||
+ | gcc <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gconf_client_get_default</font></span>'''</span><span><font color="#990000">();</font></span> | ||
+ | board <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gconf_client_get_int</font></span>'''</span><span><font color="#990000">(</font></span>gcc<span><font color="#990000">,</font></span> SETTINGS_LEVEL<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span> | ||
+ | enable_sound <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gconf_client_get_int</font></span>'''</span><span><font color="#990000">(</font></span>gcc<span><font color="#990000">,</font></span> SETTINGS_SOUND<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span> | ||
+ | |||
+ | game_hbox <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_hbox_new</font></span>'''</span> <span><font color="#990000">(</font></span>TRUE<span><font color="#990000">,</font></span> <span><font color="#993399">0</font></span><span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_assert</font></span>'''</span> <span><font color="#990000">(</font></span>game_hbox<span><font color="#990000">);</font></span> | ||
+ | |||
+ | board_hbox <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_hbox_new</font></span>'''</span> <span><font color="#990000">(</font></span>FALSE<span><font color="#990000">,</font></span> <span><font color="#993399">4</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | board_box <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_spin_button_new_with_range</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#993399">1</font></span><span><font color="#990000">,</font></span> <span><font color="#993399">12</font></span><span><font color="#990000">,</font></span> <span><font color="#993399">1</font></span><span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_assert</font></span>'''</span> <span><font color="#990000">(</font></span>board_box<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">gtk_spin_button_set_value</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_SPIN_BUTTON</font></span>'''</span> <span><font color="#990000">(</font></span>board_box<span><font color="#990000">),</font></span> board<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_signal_connect</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span><span><font color="#990000">(</font></span>board_box<span><font color="#990000">),</font></span> <span><font color="#FF0000">"value-changed"</font></span><span><font color="#990000">,</font></span> <span>'''<span><font color="#000000">G_CALLBACK</font></span>'''</span><span><font color="#990000">(</font></span>settings_callback<span><font color="#990000">),</font></span> NULL<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">gtk_box_pack_end</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_BOX</font></span>'''</span> <span><font color="#990000">(</font></span>board_hbox<span><font color="#990000">),</font></span> board_box<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> <span><font color="#993399">0</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | board_label <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_label_new</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#FF0000">"Starting level"</font></span><span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_assert</font></span>'''</span><span><font color="#990000">(</font></span>board_label<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">gtk_box_pack_end</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_BOX</font></span>'''</span> <span><font color="#990000">(</font></span>board_hbox<span><font color="#990000">),</font></span> board_label<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> <span><font color="#993399">0</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">gtk_box_pack_start</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_BOX</font></span>'''</span> <span><font color="#990000">(</font></span>game_hbox<span><font color="#990000">),</font></span> board_hbox<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> <span><font color="#993399">2</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | sound_hbox <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_hbox_new</font></span>'''</span> <span><font color="#990000">(</font></span>FALSE<span><font color="#990000">,</font></span> <span><font color="#993399">4</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | sound_check <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_check_button_new</font></span>'''</span><span><font color="#990000">();</font></span> | ||
+ | <span>'''<span><font color="#000000">g_assert</font></span>'''</span> <span><font color="#990000">(</font></span>sound_check<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">gtk_toggle_button_set_active</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_TOGGLE_BUTTON</font></span>'''</span><span><font color="#990000">(</font></span>sound_check<span><font color="#990000">),</font></span> enable_sound<span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_signal_connect</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span><span><font color="#990000">(</font></span>sound_check<span><font color="#990000">),</font></span> <span><font color="#FF0000">"clicked"</font></span><span><font color="#990000">,</font></span> | ||
+ | <span>'''<span><font color="#000000">G_CALLBACK</font></span>'''</span><span><font color="#990000">(</font></span>sound_callback<span><font color="#990000">),</font></span> NULL<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">gtk_box_pack_end</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_BOX</font></span>'''</span> <span><font color="#990000">(</font></span>sound_hbox<span><font color="#990000">),</font></span> sound_check<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> <span><font color="#993399">0</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | sound_label <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_label_new</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#FF0000">"Sound"</font></span><span><font color="#990000">);</font></span> | ||
+ | <span>'''<span><font color="#000000">g_assert</font></span>'''</span> <span><font color="#990000">(</font></span>sound_label<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">gtk_box_pack_end</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_BOX</font></span>'''</span> <span><font color="#990000">(</font></span>sound_hbox<span><font color="#990000">),</font></span> sound_label<span><font color="#990000">,</font></span> TRUE<span><font color="#990000">,</font></span> TRUE<span><font color="#990000">,</font></span> <span><font color="#993399">0</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">gtk_box_pack_start</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_BOX</font></span>'''</span> <span><font color="#990000">(</font></span>game_hbox<span><font color="#990000">),</font></span> sound_hbox<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> FALSE<span><font color="#990000">,</font></span> <span><font color="#993399">2</font></span><span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#000000">printf</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#FF0000">"%s : %s : %d</font></span><span><font color="#CC33CC">\n</font></span><span><font color="#FF0000">"</font></span><span><font color="#990000">,</font></span> __FILE__<span><font color="#990000">,</font></span> __FUNCTION__<span><font color="#990000">,</font></span> __LINE__<span><font color="#990000">);</font></span> | ||
+ | |||
+ | <span>'''<span><font color="#0000FF">return</font></span>'''</span> game_hbox<span><font color="#990000"><nowiki>;</nowiki></font></span> | ||
+ | <span><font color="#FF0000">}</font></span></tt> | ||
- | The following example illustrates the function that is responsible for using | + | The following example illustrates the function that is responsible for using Gconf to store the user preferences (as is recommended, since the back-up application stores the GConf database): crazyparking/src/plugin/plugin.c |
- | < | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">write_config</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">)</font></span> |
- | static void write_config (void) | + | <span><font color="#FF0000">{</font></span> |
- | { | + | <span><font color="#009900">int</font></span> value<span><font color="#990000"><nowiki>;</nowiki></font></span> |
- | + | value <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_spin_button_get_value_as_int</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_SPIN_BUTTON</font></span>'''</span><span><font color="#990000">(</font></span>board_box<span><font color="#990000">));</font></span> | |
- | + | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>value <span><font color="#990000"><</font></span> <span><font color="#993399">1</font></span><span><font color="#990000">)</font></span> value <span><font color="#990000"><nowiki>=</nowiki></font></span> <span><font color="#993399">1</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span>'''<span><font color="#0000FF">else</font></span>'''</span> <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>value <span><font color="#990000">></font></span> <span><font color="#993399">12</font></span><span><font color="#990000">)</font></span> value <span><font color="#990000"><nowiki>=</nowiki></font></span> <span><font color="#993399">12</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span>'''<span><font color="#000000">gconf_client_set_int</font></span>'''</span><span><font color="#990000">(</font></span>gcc<span><font color="#990000">,</font></span> SETTINGS_LEVEL<span><font color="#990000">,</font></span> value<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gconf_client_set_int</font></span>'''</span><span><font color="#990000">(</font></span>gcc<span><font color="#990000">,</font></span> SETTINGS_SOUND<span><font color="#990000">,</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_toggle_button_get_active</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_TOGGLE_BUTTON</font></span>'''</span><span><font color="#990000">(</font></span>sound_check<span><font color="#990000">)),</font></span> NULL<span><font color="#990000">);</font></span> | |
- | + | <span><font color="#FF0000">}</font></span></tt> | |
- | } | + | |
- | </ | + | |
- | The following example illustrates the function that initializes the game-specific plug-in menu, which is between the Game and Close submenus of osso-games-startup: | + | The following example illustrates the function that initializes the game-specific plug-in menu, which is between the Game and Close submenus of osso-games-startup: crazyparking/src/plugin/plugin.c |
- | < | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>**</nowiki></font></span><span>'''<span><font color="#000000">load_menu</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#008080">guint</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>nitems<span><font color="#990000">)</font></span> |
- | static GtkWidget **load_menu (guint *nitems) | + | <span><font color="#FF0000">{</font></span> |
- | { | + | <span><font color="#009900">int</font></span> enable_sound<span><font color="#990000"><nowiki>;</nowiki></font></span> |
- | + | <span>''<span><font color="#9A1900">//number of entries in maemo-games-startup main menu for this game </font></span>''</span> | |
- | + | <span><font color="#990000"><nowiki>*</nowiki></font></span>nitems <span><font color="#990000"><nowiki>=</nowiki></font></span> <span><font color="#993399">1</font></span><span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | settings_item <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_menu_item_new_with_label</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#FF0000">"Settings"</font></span><span><font color="#990000">);</font></span> | |
- | + | settings_menu <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_menu_new</font></span>'''</span> <span><font color="#990000">();</font></span> | |
- | + | menu_items<span><font color="#990000">[</font></span><span><font color="#993399">0</font></span><span><font color="#990000">]</font></span> <span><font color="#990000"><nowiki>=</nowiki></font></span> settings_item<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_item_set_submenu</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU_ITEM</font></span>'''</span> <span><font color="#990000">(</font></span>settings_item<span><font color="#990000">),</font></span> settings_menu<span><font color="#990000">);</font></span> | |
- | + | <span>''<span><font color="#9A1900">//difficulty settings </font></span>''</span> | |
- | + | difficulty_menu <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_menu_new</font></span>'''</span> <span><font color="#990000">();</font></span> | |
- | + | difficulty_item <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_menu_item_new_with_label</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#FF0000">"Difficulty"</font></span><span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_item_set_submenu</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU_ITEM</font></span>'''</span> <span><font color="#990000">(</font></span>difficulty_item<span><font color="#990000">),</font></span> difficulty_menu<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_append</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU</font></span>'''</span> <span><font color="#990000">(</font></span>settings_menu<span><font color="#990000">),</font></span> difficulty_item<span><font color="#990000">);</font></span> | |
- | + | level_1_item <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_radio_menu_item_new_with_label</font></span>'''</span> <span><font color="#990000">(</font></span>group<span><font color="#990000">,</font></span> <span><font color="#FF0000">"Level 1"</font></span><span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_append</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU</font></span>'''</span> <span><font color="#990000">(</font></span>difficulty_menu<span><font color="#990000">),</font></span> level_1_item<span><font color="#990000">);</font></span> | |
- | + | group <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_radio_menu_item_group</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_RADIO_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>level_1_item<span><font color="#990000">));</font></span> | |
- | + | level_2_item <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_radio_menu_item_new_with_label</font></span>'''</span> <span><font color="#990000">(</font></span>group<span><font color="#990000">,</font></span> <span><font color="#FF0000">"Level 2"</font></span><span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_append</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU</font></span>'''</span> <span><font color="#990000">(</font></span>difficulty_menu<span><font color="#990000">),</font></span> level_2_item<span><font color="#990000">);</font></span> | |
- | + | group <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_radio_menu_item_group</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_RADIO_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>level_2_item<span><font color="#990000">));</font></span> | |
- | + | level_3_item <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_radio_menu_item_new_with_label</font></span>'''</span> <span><font color="#990000">(</font></span>group<span><font color="#990000">,</font></span> <span><font color="#FF0000">"Level 3"</font></span><span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_append</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU</font></span>'''</span> <span><font color="#990000">(</font></span>difficulty_menu<span><font color="#990000">),</font></span> level_3_item<span><font color="#990000">);</font></span> | |
- | + | group <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_radio_menu_item_group</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_RADIO_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>level_3_item<span><font color="#990000">));</font></span> | |
- | + | <span>''<span><font color="#9A1900">/* ... Listing cut for brevity ...*/</font></span>''</span> | |
- | + | level_12_item <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_radio_menu_item_new_with_label</font></span>'''</span> <span><font color="#990000">(</font></span>group<span><font color="#990000">,</font></span> <span><font color="#FF0000">"Level 12"</font></span><span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_append</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU</font></span>'''</span> <span><font color="#990000">(</font></span>difficulty_menu<span><font color="#990000">),</font></span> level_12_item<span><font color="#990000">);</font></span> | |
- | + | group <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_radio_menu_item_group</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_RADIO_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>level_12_item<span><font color="#990000">));</font></span> | |
- | + | <span>'''<span><font color="#000000">g_signal_connect</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span> <span><font color="#990000">(</font></span>level_1_item<span><font color="#990000">),</font></span> <span><font color="#FF0000">"toggled"</font></span><span><font color="#990000">,</font></span> | |
- | + | <span>'''<span><font color="#000000">G_CALLBACK</font></span>'''</span> <span><font color="#990000">(</font></span>plugin_callback<span><font color="#990000">),</font></span> <span><font color="#990000">(</font></span>gpointer<span><font color="#990000">)</font></span> LEVEL_1<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">g_signal_connect</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span> <span><font color="#990000">(</font></span>level_2_item<span><font color="#990000">),</font></span> <span><font color="#FF0000">"toggled"</font></span><span><font color="#990000">,</font></span> | |
- | + | <span>'''<span><font color="#000000">G_CALLBACK</font></span>'''</span> <span><font color="#990000">(</font></span>plugin_callback<span><font color="#990000">),</font></span> <span><font color="#990000">(</font></span>gpointer<span><font color="#990000">)</font></span> LEVEL_2<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">g_signal_connect</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span> <span><font color="#990000">(</font></span>level_3_item<span><font color="#990000">),</font></span> <span><font color="#FF0000">"toggled"</font></span><span><font color="#990000">,</font></span> | |
- | + | <span>'''<span><font color="#000000">G_CALLBACK</font></span>'''</span> <span><font color="#990000">(</font></span>plugin_callback<span><font color="#990000">),</font></span> <span><font color="#990000">(</font></span>gpointer<span><font color="#990000">)</font></span> LEVEL_3<span><font color="#990000">);</font></span> | |
- | + | <span>''<span><font color="#9A1900">/* ... Listing cut for brevity ...*/</font></span>''</span> | |
- | + | <span>'''<span><font color="#000000">g_signal_connect</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span> <span><font color="#990000">(</font></span>level_12_item<span><font color="#990000">),</font></span> <span><font color="#FF0000">"toggled"</font></span><span><font color="#990000">,</font></span> | |
- | + | <span>'''<span><font color="#000000">G_CALLBACK</font></span>'''</span> <span><font color="#990000">(</font></span>plugin_callback<span><font color="#990000">),</font></span> <span><font color="#990000">(</font></span>gpointer<span><font color="#990000">)</font></span> LEVEL_12<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_append</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU</font></span>'''</span> <span><font color="#990000">(</font></span>settings_menu<span><font color="#990000">),</font></span> <span>'''<span><font color="#000000">gtk_menu_item_new</font></span>'''</span><span><font color="#990000">());</font></span> | |
- | + | <span>''<span><font color="#9A1900">//sound settings </font></span>''</span> | |
- | + | sound_item <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_check_menu_item_new_with_label</font></span>'''</span><span><font color="#990000">(</font></span><span><font color="#FF0000">"Sound"</font></span><span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_menu_append</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_MENU</font></span>'''</span> <span><font color="#990000">(</font></span>settings_menu<span><font color="#990000">),</font></span> sound_item<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">g_signal_connect</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">G_OBJECT</font></span>'''</span> <span><font color="#990000">(</font></span>sound_item<span><font color="#990000">),</font></span> <span><font color="#FF0000">"toggled"</font></span><span><font color="#990000">,</font></span> | |
- | + | <span>'''<span><font color="#000000">G_CALLBACK</font></span>'''</span> <span><font color="#990000">(</font></span>plugin_callback<span><font color="#990000">),</font></span> <span><font color="#990000">(</font></span>gpointer<span><font color="#990000">)</font></span> MENU_SOUND<span><font color="#990000">);</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_check_menu_item_set_state</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_CHECK_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>sound_item<span><font color="#990000">),</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_toggle_button_get_active</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_TOGGLE_BUTTON</font></span>'''</span> <span><font color="#990000">(</font></span>sound_check<span><font color="#990000">)));</font></span> | |
- | + | <span>'''<span><font color="#0000FF">return</font></span>'''</span> menu_items<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | } | + | </tt> |
- | </ | + | |
- | The following example illustrates the function that is called when any configuration is performed in the menu. This function updates the | + | The following example illustrates the function that is called when any configuration is performed in the menu. This function updates the GTK_SPIN_BUTTON (level change) or the GTK_CHECK_MENU_ITEM (sound change). crazyparking/src/plugin/plugin.c |
- | < | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">plugin_callback</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>menu_item<span><font color="#990000">,</font></span> <span><font color="#008080">gpointer</font></span> data<span><font color="#990000">)</font></span> |
- | static void plugin_callback (GtkWidget *menu_item, gpointer data) | + | <span><font color="#FF0000">{</font></span> |
- | { | + | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>MENU_SOUND <span><font color="#990000"><nowiki>==</nowiki></font></span> <span><font color="#990000">(</font></span><span><font color="#009900">int</font></span><span><font color="#990000">)</font></span> data <span><font color="#990000">&&</font></span> <span><font color="#990000"><nowiki>!</nowiki></font></span>changed<span><font color="#990000">)</font></span><span><font color="#FF0000">{</font></span> |
- | + | changed <span><font color="#990000"><nowiki>=</nowiki></font></span> TRUE<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_toggle_button_set_active</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_TOGGLE_BUTTON</font></span>'''</span> <span><font color="#990000">(</font></span>sound_check<span><font color="#990000">),</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_check_menu_item_get_active</font></span>'''</span> <span><font color="#990000">(</font></span> | |
- | + | <span>'''<span><font color="#000000">GTK_CHECK_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>sound_item<span><font color="#990000">)));</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> <span>'''<span><font color="#0000FF">else</font></span>'''</span> <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(!</font></span>changed<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> | |
- | + | changed <span><font color="#990000"><nowiki>=</nowiki></font></span> TRUE<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_spin_button_set_value</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_SPIN_BUTTON</font></span>'''</span> <span><font color="#990000">(</font></span>board_box<span><font color="#990000">),</font></span> <span><font color="#990000">(</font></span><span><font color="#009900">int</font></span><span><font color="#990000">)</font></span> data<span><font color="#990000">);</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | + | changed <span><font color="#990000"><nowiki>=</nowiki></font></span> FALSE<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | } | + | </tt> |
- | </ | + | |
- | The following example illustrates the function that is called to update the menu level option, when the user chooses the level using the | + | The following example illustrates the function that is called to update the menu level option, when the user chooses the level using the GTK_SPIN_BUTTON: crazyparking/src/plugin/plugin.c |
- | < | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">settings_callback</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>widget<span><font color="#990000">,</font></span> <span><font color="#008080">gpointer</font></span> data<span><font color="#990000">)</font></span> |
- | static void settings_callback (GtkWidget *widget, gpointer data) | + | <span><font color="#FF0000">{</font></span> |
- | { | + | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(!</font></span>changed<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> |
- | + | changed <span><font color="#990000"><nowiki>=</nowiki></font></span> TRUE<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span><font color="#008080">gint</font></span> active <span><font color="#990000"><nowiki>=</nowiki></font></span> <span>'''<span><font color="#000000">gtk_spin_button_get_value_as_int</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_SPIN_BUTTON</font></span>'''</span><span><font color="#990000">(</font></span>widget<span><font color="#990000">));</font></span> | |
- | + | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>active <span><font color="#990000"><nowiki>==</nowiki></font></span> LEVEL_1<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_check_menu_item_set_state</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_CHECK_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>level_1_item<span><font color="#990000">),</font></span> TRUE<span><font color="#990000">);</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | + | <span>'''<span><font color="#0000FF">else</font></span>'''</span> <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>active <span><font color="#990000"><nowiki>==</nowiki></font></span> LEVEL_2<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_check_menu_item_set_state</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_CHECK_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>level_2_item<span><font color="#990000">),</font></span> TRUE<span><font color="#990000">);</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | + | <span>'''<span><font color="#0000FF">else</font></span>'''</span> <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>active <span><font color="#990000"><nowiki>==</nowiki></font></span> LEVEL_3<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_check_menu_item_set_state</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_CHECK_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>level_3_item<span><font color="#990000">),</font></span> TRUE<span><font color="#990000">);</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | + | <span>''<span><font color="#9A1900">/*... Listing cut for brevity ...*/</font></span>''</span> | |
- | + | <span>'''<span><font color="#0000FF">else</font></span>'''</span> <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(</font></span>active <span><font color="#990000"><nowiki>==</nowiki></font></span> LEVEL_12<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_check_menu_item_set_state</font></span>'''</span><span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_CHECK_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>level_12_item<span><font color="#990000">),</font></span> TRUE<span><font color="#990000">);</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | + | changed <span><font color="#990000"><nowiki>=</nowiki></font></span> FALSE<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | } | + | </tt> |
- | </ | + | |
- | The following example illustrates the function that handles changes to the sound setup: | + | The following example illustrates the function that handles changes to the sound setup: crazyparking/src/plugin/plugin.c |
- | < | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">sound_callback</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#008080">GtkWidget</font></span> <span><font color="#990000"><nowiki>*</nowiki></font></span>widget<span><font color="#990000">,</font></span> <span><font color="#008080">gpointer</font></span> data<span><font color="#990000">)</font></span> |
- | static void sound_callback (GtkWidget *widget, gpointer data) | + | <span><font color="#FF0000">{</font></span> |
- | { | + | <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span><font color="#990000">(!</font></span>changed<span><font color="#990000">)</font></span> <span><font color="#FF0000">{</font></span> |
- | + | changed <span><font color="#990000"><nowiki>=</nowiki></font></span> TRUE<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_check_menu_item_set_state</font></span>'''</span> <span><font color="#990000">(</font></span><span>'''<span><font color="#000000">GTK_CHECK_MENU_ITEM</font></span>'''</span><span><font color="#990000">(</font></span>sound_item<span><font color="#990000">),</font></span> | |
- | + | <span>'''<span><font color="#000000">gtk_toggle_button_get_active</font></span>'''</span><span><font color="#990000">(</font></span> | |
- | + | <span>'''<span><font color="#000000">GTK_TOGGLE_BUTTON</font></span>'''</span> <span><font color="#990000">(</font></span>widget<span><font color="#990000">)));</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> | |
- | + | changed <span><font color="#990000"><nowiki>=</nowiki></font></span> FALSE<span><font color="#990000"><nowiki>;</nowiki></font></span> | |
- | + | <span><font color="#FF0000">}</font></span></tt> | |
- | } | + | |
- | </ | + | |
- | The following example illustrates the function that is called by | + | The following example illustrates the function that is called by osso-games-startup, if necessary. crazyparking/src/plugin/plugin.c |
- | < | + | <tt><span>'''<span><font color="#0000FF">static</font></span>'''</span> <span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">update_menu</font></span>'''</span> <span><font color="#990000">(</font></span><span><font color="#009900">void</font></span><span><font color="#990000">)</font></span> |
- | static void update_menu (void) | + | <span><font color="#FF0000">{</font></span> |
- | { | + | <span>'''<span><font color="#000000">settings_callback</font></span>'''</span><span><font color="#990000">(</font></span>board_box<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span> |
- | + | <span>'''<span><font color="#000000">sound_callback</font></span>'''</span><span><font color="#990000">(</font></span>sound_check<span><font color="#990000">,</font></span> NULL<span><font color="#990000">);</font></span> | |
- | + | <span><font color="#FF0000">}</font></span> </tt> | |
- | } | + | |
- | </ | + | |
- | + | <br /> | |
- | + | ||
- | + |
Learn more about Contributing to the wiki.