Documentation/Maemo 5 Developer Guide/Application Development/Writing Control Panel Applets - Revision history

imported_>andre: Protected "Documentation/Maemo 5 Developer Guide/Application Development/Writing Control Panel Applets" [edit=autoconfirmed:move=autoconfirmed]

2012-06-14T14:11:26Z

Protected "Documentation/Maemo 5 Developer Guide/Application Development/Writing Control Panel Applets" [edit=autoconfirmed:move=autoconfirmed]

← Older revision	Revision as of 14:11, 14 June 2012
(No difference)

imported_>andre: Reverted edits by 69.194.192.215 (Talk); changed back to last version by Amigadave

2012-06-14T14:11:09Z

Reverted edits by 69.194.192.215 (Talk); changed back to last version by Amigadave

← Older revision		Revision as of 14:11, 14 June 2012
Line 69:		Line 69:
	By default it is <code>/usr/lib/hildon-control-panel</code>.		By default it is <code>/usr/lib/hildon-control-panel</code>.

	~~Anne~~, ~~try our Enhanced File Sending mode~~ and ~~see if it works~~ for ~~you now~~. ~~We recently upradged~~ the ~~functionality~~ to ~~remember your settings and also includes~~ default ~~setting options~~. ~~For example, your activity setting 'do not notify'~~ should ~~now stay selected~~.		==The .desktop file ==

			Any control panel applet needs a desktop file describing it. The file contains metadata like name, icon name and library of the applet. The applet desktop file is much like the desktop file for any other application.

			Here is an example desktop file (<code>applet.desktop</code>) for the applet created above:

			<pre>
			[Desktop Entry]
			Encoding=UTF-8
			Version=1.0
			Name=Control Panel Hello World
			Comment=A control panel example applet
			Type=HildonControlPanelPlugin
			Icon=qgn_list_cp_isetup
			X-control-panel-plugin=libapplet.so
			Categories=general
			</pre>

			Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained with:
			pkg-config hildon-control-panel --variable=plugindesktopentrydir

			By default, it is <code>/usr/share/applications/hildon-control-panel</code>.

			Icon file should be placed in the folder <code>/usr/share/pixmaps</code>. Specify the icon name without the .png suffix.

			[[Category:Development]]
			[[Category:Documentation]]
			[[Category:Fremantle]]

69.194.192.215: /* The .desktop file */

2012-06-14T06:52:54Z

The .desktop file

← Older revision		Revision as of 06:52, 14 June 2012
Line 69:		Line 69:
	By default it is <code>/usr/lib/hildon-control-panel</code>.		By default it is <code>/usr/lib/hildon-control-panel</code>.

	~~==The .desktop file ==~~		Anne, try our Enhanced File Sending mode and see if it works for you now. We recently upradged the functionality to remember your settings and also includes default setting options. For example, your activity setting 'do not notify' should now stay selected.

	~~Any control panel applet needs a desktop file describing it. The file contains metadata like name~~, ~~icon name~~ and ~~library of the applet. The applet desktop file is much like the desktop file~~ for ~~any other application~~.

	~~Here is an example desktop file (<code>applet.desktop</code>) for~~ the ~~applet created above:~~

	~~<pre>~~
	~~[Desktop Entry]~~
	~~Encoding=UTF-8~~
	~~Version=1~~.0
	~~Name=Control Panel Hello World~~
	~~Comment=A control panel~~ example ~~applet~~
	~~Type=HildonControlPanelPlugin~~
	~~Icon=qgn_list_cp_isetup~~
	~~X-control-panel-plugin=libapplet.so~~
	~~Categories=general~~
	~~</pre>~~

	~~Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained with:~~
	~~pkg-config hildon-control-panel --variable=plugindesktopentrydir~~

	~~By default~~, ~~it is <code>/usr/share/applications/hildon-control-panel</code>.~~

	~~Icon file~~ should ~~be placed in the folder <code>/usr/share/pixmaps</code>. Specify the icon name without the .png suffix~~.

	~~[[Category:Development]]~~
	~~[[Category:Documentation]]~~
	~~[[Category:Fremantle]]~~

imported_>amigadave: desktop file link

2010-10-20T13:09:44Z

desktop file link

← Older revision		Revision as of 13:09, 20 October 2010
Line 1:		Line 1:
	The control panel is designed to be extendable, and items can be added to it with dynamic libraries with certain functions and desktop files describing the library.		The control panel is designed to be extendable, and items can be added to it with dynamic libraries with certain functions and [[desktop file format\|desktop files]] describing the library.

	== Functions ==		== Functions ==
Line 73:		Line 73:
	Any control panel applet needs a desktop file describing it. The file contains metadata like name, icon name and library of the applet. The applet desktop file is much like the desktop file for any other application.		Any control panel applet needs a desktop file describing it. The file contains metadata like name, icon name and library of the applet. The applet desktop file is much like the desktop file for any other application.

	Here is an example desktop file (applet.desktop) for the applet created above:		Here is an example desktop file (<code>applet.desktop</code>) for the applet created above:

	<pre>		<pre>

imported_>amigadave: add


2010-09-07T10:38:39Z
add <code>

				
				
				
				
				
				← Older revision
				Revision as of 10:38, 7 September 2010
				
Line 9:
Line 9:
</source> </source>



The first and more important one, execute, is called when the applet is activated from Control Panel. Usually this function creates a dialog and waits until it is done. Any dialog created should be modal to the window in parameter. The first and more important one, <code>execute</code>, is called when the applet is activated from Control Panel. Usually this function creates a dialog and waits until it is done. Any dialog created should be modal to the window in parameter.
 
N.B. The library can be unloaded when execute returns, so no <code>g_timeout</code>s, <code>gconf_notify</code>s or such must be left when done. GTK+ or osso initialization is not needed, because they are already done at this point. N.B. The library can be unloaded when execute returns, so no <code>g_timeout</code>s, <code>gconf_notify</code>s or such must be left when done. GTK+ or osso initialization is not needed, because they are already done at this point.



Line 48:
Line 49:
</source> </source>



The other function is called save_state. It is called when application using the applet is saving state. Usually this does nothing, but if support for state saving is needed, use it. The other function is called <code>save_state</code>. It is called when application using the applet is saving state. Usually this does nothing, but if support for state saving is needed, use it.



<source lang="c"> <source lang="c">
Line 60:
Line 61:
== Building applet == == Building applet ==



To use the applet, build it into a dynamic library aka shared object by giving flag -shared to gcc. To use the applet, build it into a dynamic library aka shared object by passing the <code>-shared</code> flag to gcc.



  [sbox-FREMANTLE_X86: ~] > gcc -shared `pkg-config gtk+-2.0 hildon-control-panel libosso --libs --cflags` libapplet.c -o libapplet.so   [sbox-FREMANTLE_X86: ~] > gcc -shared `pkg-config gtk+-2.0 hildon-control-panel libosso --libs --cflags` libapplet.c -o libapplet.so
Line 89:
Line 90:
  pkg-config hildon-control-panel --variable=plugindesktopentrydir   pkg-config hildon-control-panel --variable=plugindesktopentrydir



By default, it is /usr/share/applications/hildon-control-panel. By default, it is <code>/usr/share/applications/hildon-control-panel</code>.



Icon file should be placed in the folder <code>/usr/share/pixmaps</code>. Specify the icon name without the .png suffix. Icon file should be placed in the folder <code>/usr/share/pixmaps</code>. Specify the icon name without the .png suffix.



imported_>amigadave: /* Building applet */ use 
2010-08-16T14:12:05Z
Building applet:  use <pre>

				
				
				
				
				
				← Older revision
				Revision as of 14:12, 16 August 2010
				
Line 64:
Line 64:
  [sbox-FREMANTLE_X86: ~] > gcc -shared `pkg-config gtk+-2.0 hildon-control-panel libosso --libs --cflags` libapplet.c -o libapplet.so   [sbox-FREMANTLE_X86: ~] > gcc -shared `pkg-config gtk+-2.0 hildon-control-panel libosso --libs --cflags` libapplet.c -o libapplet.so



Install the binary produced by gcc to a path specified in hildon-control-panel pkg-config entry. You can obtain this path with pkg-config hildon-control-panel --variable=pluginlibdir. By default it is <code>/usr/lib/hildon-control-panel</code>. Install the binary produced by gcc to a path specified in hildon-control-panel pkg-config entry. You can obtain this path with:
 pkg-config hildon-control-panel --variable=pluginlibdir
By default it is <code>/usr/lib/hildon-control-panel</code>.



==The .desktop file == ==The .desktop file ==



imported_>amigadave: use  and 

2010-07-20T10:45:44Z
use <source> and <code>
Show changes


imported_>omeriko9: /* The .desktop file */
2010-04-02T20:44:15Z
The .desktop file

				
				
				
				
				
				← Older revision
				Revision as of 20:44, 2 April 2010
				
Line 83:
Line 83:



Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained by  ''`pkg-config hildon-control-panel --variable=plugindesktopentrydir`''. By default, it is /usr/share/applications/hildon-control-panel. Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained by  ''`pkg-config hildon-control-panel --variable=plugindesktopentrydir`''. By default, it is /usr/share/applications/hildon-control-panel.

Icon file should be placed in the folder /usr/share/pixmaps. Specify the icon name without the .png suffix.



[[Category:Development]] [[Category:Development]]
[[Category:Documentation]] [[Category:Documentation]]
[[Category:Fremantle]] [[Category:Fremantle]]



imported_>amigadave: categorise
2010-02-12T12:00:37Z
categorise

				
				
				
				
				
				← Older revision
				Revision as of 12:00, 12 February 2010
				
Line 83:
Line 83:



Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained by  ''`pkg-config hildon-control-panel --variable=plugindesktopentrydir`''. By default, it is /usr/share/applications/hildon-control-panel. Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained by  ''`pkg-config hildon-control-panel --variable=plugindesktopentrydir`''. By default, it is /usr/share/applications/hildon-control-panel.

[[Category:Development]]
[[Category:Documentation]]
[[Category:Fremantle]]



imported_>tapio at 09:34, 12 February 2010
2010-02-12T09:34:08Z


				
				
				
				
				
				← Older revision
				Revision as of 09:34, 12 February 2010
				
Line 4:
Line 4:



== Functions == == Functions ==
A control panel applet ([https://garage.maemo.org/svn/maemoexamples/trunk/maemo-examples/libapplet.c libapplet.c]) needs two functions. These functions are defined in the following: A control panel applet ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/libapplet.c libapplet.c]) needs two functions. These functions are defined in the following:



  <tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000">&lt;hildon-cp-plugin/hildon-cp-plugin-interface.h&gt;</font></span></tt>   <tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000">&lt;hildon-cp-plugin/hildon-cp-plugin-interface.h&gt;</font></span></tt>

← Older revision		Revision as of 10:38, 7 September 2010
Line 9:		Line 9:
	</source>		</source>

	The first and more important one, execute, is called when the applet is activated from Control Panel. Usually this function creates a dialog and waits until it is done. Any dialog created should be modal to the window in parameter.		The first and more important one, <code>execute</code>, is called when the applet is activated from Control Panel. Usually this function creates a dialog and waits until it is done. Any dialog created should be modal to the window in parameter.

	N.B. The library can be unloaded when execute returns, so no <code>g_timeout</code>s, <code>gconf_notify</code>s or such must be left when done. GTK+ or osso initialization is not needed, because they are already done at this point.		N.B. The library can be unloaded when execute returns, so no <code>g_timeout</code>s, <code>gconf_notify</code>s or such must be left when done. GTK+ or osso initialization is not needed, because they are already done at this point.

Line 48:		Line 49:
	</source>		</source>

	The other function is called save_state. It is called when application using the applet is saving state. Usually this does nothing, but if support for state saving is needed, use it.		The other function is called <code>save_state</code>. It is called when application using the applet is saving state. Usually this does nothing, but if support for state saving is needed, use it.

	<source lang="c">		<source lang="c">
Line 60:		Line 61:
	== Building applet ==		== Building applet ==

	To use the applet, build it into a dynamic library aka shared object by ~~giving flag~~ -shared to gcc.		To use the applet, build it into a dynamic library aka shared object by passing the <code>-shared</code> flag to gcc.

	[sbox-FREMANTLE_X86: ~] > gcc -shared `pkg-config gtk+-2.0 hildon-control-panel libosso --libs --cflags` libapplet.c -o libapplet.so		[sbox-FREMANTLE_X86: ~] > gcc -shared `pkg-config gtk+-2.0 hildon-control-panel libosso --libs --cflags` libapplet.c -o libapplet.so
Line 89:		Line 90:
	pkg-config hildon-control-panel --variable=plugindesktopentrydir		pkg-config hildon-control-panel --variable=plugindesktopentrydir

	By default, it is /usr/share/applications/hildon-control-panel.		By default, it is <code>/usr/share/applications/hildon-control-panel</code>.

	Icon file should be placed in the folder <code>/usr/share/pixmaps</code>. Specify the icon name without the .png suffix.		Icon file should be placed in the folder <code>/usr/share/pixmaps</code>. Specify the icon name without the .png suffix.

← Older revision		Revision as of 14:12, 16 August 2010
Line 64:		Line 64:
	[sbox-FREMANTLE_X86: ~] > gcc -shared `pkg-config gtk+-2.0 hildon-control-panel libosso --libs --cflags` libapplet.c -o libapplet.so		[sbox-FREMANTLE_X86: ~] > gcc -shared `pkg-config gtk+-2.0 hildon-control-panel libosso --libs --cflags` libapplet.c -o libapplet.so

	Install the binary produced by gcc to a path specified in hildon-control-panel pkg-config entry. You can obtain this path with pkg-config hildon-control-panel --variable=pluginlibdir. By default it is <code>/usr/lib/hildon-control-panel</code>.		Install the binary produced by gcc to a path specified in hildon-control-panel pkg-config entry. You can obtain this path with:
			pkg-config hildon-control-panel --variable=pluginlibdir
			By default it is <code>/usr/lib/hildon-control-panel</code>.

	==The .desktop file ==		==The .desktop file ==

← Older revision		Revision as of 20:44, 2 April 2010
Line 83:		Line 83:

	Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained by ''`pkg-config hildon-control-panel --variable=plugindesktopentrydir`''. By default, it is /usr/share/applications/hildon-control-panel.		Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained by ''`pkg-config hildon-control-panel --variable=plugindesktopentrydir`''. By default, it is /usr/share/applications/hildon-control-panel.

			Icon file should be placed in the folder /usr/share/pixmaps. Specify the icon name without the .png suffix.

	[[Category:Development]]		[[Category:Development]]
	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:Fremantle]]		[[Category:Fremantle]]

← Older revision		Revision as of 12:00, 12 February 2010
Line 83:		Line 83:

	Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained by ''`pkg-config hildon-control-panel --variable=plugindesktopentrydir`''. By default, it is /usr/share/applications/hildon-control-panel.		Install the desktop file to directory specified in pkg-config file for hildon-control-panel. This directory can be obtained by ''`pkg-config hildon-control-panel --variable=plugindesktopentrydir`''. By default, it is /usr/share/applications/hildon-control-panel.

			[[Category:Development]]
			[[Category:Documentation]]
			[[Category:Fremantle]]

← Older revision		Revision as of 09:34, 12 February 2010
Line 4:		Line 4:

	== Functions ==		== Functions ==
	A control panel applet ([https://~~garage~~.maemo.org/svn/maemoexamples/~~trunk~~/maemo-examples/libapplet.c libapplet.c]) needs two functions. These functions are defined in the following:		A control panel applet ([https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/maemo-examples/libapplet.c libapplet.c]) needs two functions. These functions are defined in the following:

	<tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><hildon-cp-plugin/hildon-cp-plugin-interface.h></font></span></tt>		<tt><span>'''<span><font color="#000080"><nowiki>#include</nowiki></font></span>'''</span> <span><font color="#FF0000"><hildon-cp-plugin/hildon-cp-plugin-interface.h></font></span></tt>