← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gnome-panel/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/panel-applet/html/panel-applet-Panel-Applet.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2011-05-30 11:04:49 UTC
  • mfrom: (1.3.4 upstream)
  • mto: This revision was merged to the branch mainline in revision 204.
  • Revision ID: james.westby@ubuntu.com-20110530110449-ut1tc5t61rpvf9e3
Tags: upstream-3.0.2
Import upstream version 3.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/panel-applet/html/panel-applet-Panel-Applet.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>Panel Applet</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Panel Applet Library Reference Manual">
 
8
<link rel="up" href="reference.html" title="Part IV. API Reference">
 
9
<link rel="prev" href="reference.html" title="Part IV. API Reference">
 
10
<link rel="next" href="panel-applet-Panel-Applet-Factory.html" title="Panel Applet Factory">
 
11
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="reference.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="reference.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Panel Applet Library Reference Manual</th>
 
21
<td><a accesskey="n" href="panel-applet-Panel-Applet-Factory.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#panel-applet-Panel-Applet.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#panel-applet-Panel-Applet.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#panel-applet-Panel-Applet.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#panel-applet-Panel-Applet.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#panel-applet-Panel-Applet.properties" class="shortcut">Properties</a>
 
33
                   | 
 
34
                  <a href="#panel-applet-Panel-Applet.signals" class="shortcut">Signals</a>
 
35
</td></tr>
 
36
</table>
 
37
<div class="refentry">
 
38
<a name="panel-applet-Panel-Applet"></a><div class="titlepage"></div>
 
39
<div class="refnamediv"><table width="100%"><tr>
 
40
<td valign="top">
 
41
<h2><span class="refentrytitle"><a name="panel-applet-Panel-Applet.top_of_page"></a>Panel Applet</span></h2>
 
42
<p>Panel Applet — a widget embedded in a panel.</p>
 
43
</td>
 
44
<td valign="top" align="right"></td>
 
45
</tr></table></div>
 
46
<div class="refsect1">
 
47
<a name="panel-applet-Panel-Applet.stability-level"></a><h2>Stability Level</h2>
 
48
Unstable, unless otherwise indicated
 
49
</div>
 
50
<div class="refsynopsisdiv">
 
51
<a name="panel-applet-Panel-Applet.synopsis"></a><h2>Synopsis</h2>
 
52
<a name="PanelApplet"></a><pre class="synopsis">
 
53
#include &lt;panel-applet.h&gt;
 
54
 
 
55
struct              <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet-struct" title="struct PanelApplet">PanelApplet</a>;
 
56
enum                <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletOrient" title="enum PanelAppletOrient">PanelAppletOrient</a>;
 
57
enum                <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags">PanelAppletFlags</a>;
 
58
<a class="link" href="panel-applet-Panel-Applet.html#PanelAppletOrient" title="enum PanelAppletOrient"><span class="returnvalue">PanelAppletOrient</span></a>   <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-get-orient" title="panel_applet_get_orient ()">panel_applet_get_orient</a>             (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);
 
59
<span class="returnvalue">guint</span>               <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-get-size" title="panel_applet_get_size ()">panel_applet_get_size</a>               (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);
 
60
<span class="returnvalue">void</span>                <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-set-size-hints" title="panel_applet_set_size_hints ()">panel_applet_set_size_hints</a>         (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
61
                                                         <em class="parameter"><code>const <span class="type">int</span> *size_hints</code></em>,
 
62
                                                         <em class="parameter"><code><span class="type">int</span> n_elements</code></em>,
 
63
                                                         <em class="parameter"><code><span class="type">int</span> base_size</code></em>);
 
64
<a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-pattern-t.html#cairo-pattern-t"><span class="returnvalue">cairo_pattern_t</span></a> *   <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-get-background" title="panel_applet_get_background ()">panel_applet_get_background</a>         (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);
 
65
<span class="returnvalue">void</span>                <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-set-background-widget" title="panel_applet_set_background_widget ()">panel_applet_set_background_widget</a>  (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
66
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
 
67
<a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a>    <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-get-flags" title="panel_applet_get_flags ()">panel_applet_get_flags</a>              (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);
 
68
<span class="returnvalue">void</span>                <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-set-flags" title="panel_applet_set_flags ()">panel_applet_set_flags</a>              (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
69
                                                         <em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> flags</code></em>);
 
70
<span class="returnvalue">gboolean</span>            <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-get-locked-down" title="panel_applet_get_locked_down ()">panel_applet_get_locked_down</a>        (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);
 
71
<span class="returnvalue">GSettings</span> *         <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-settings-new" title="panel_applet_settings_new ()">panel_applet_settings_new</a>           (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
72
                                                         <em class="parameter"><code>const <span class="type">char</span> *schema</code></em>);
 
73
<span class="returnvalue">void</span>                <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-add-preferences" title="panel_applet_add_preferences ()">panel_applet_add_preferences</a>        (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
74
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *schema_dir</code></em>,
 
75
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
76
<span class="returnvalue">gchar</span> *             <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-get-preferences-key" title="panel_applet_get_preferences_key ()">panel_applet_get_preferences_key</a>    (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);
 
77
<span class="returnvalue">void</span>                <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-request-focus" title="panel_applet_request_focus ()">panel_applet_request_focus</a>          (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
78
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
 
79
<span class="returnvalue">void</span>                <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-setup-menu" title="panel_applet_setup_menu ()">panel_applet_setup_menu</a>             (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
80
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *xml</code></em>,
 
81
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkActionGroup.html"><span class="type">GtkActionGroup</span></a> *action_group</code></em>);
 
82
<span class="returnvalue">void</span>                <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-setup-menu-from-file" title="panel_applet_setup_menu_from_file ()">panel_applet_setup_menu_from_file</a>   (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
83
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
 
84
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkActionGroup.html"><span class="type">GtkActionGroup</span></a> *action_group</code></em>);
 
85
</pre>
 
86
</div>
 
87
<div class="refsect1">
 
88
<a name="panel-applet-Panel-Applet.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
89
<pre class="synopsis">
 
90
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
91
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
92
         +----<a href="http://library.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
 
93
               +----<a href="http://library.gnome.org/devel/gtk/GtkContainer.html">GtkContainer</a>
 
94
                     +----<a href="http://library.gnome.org/devel/gtk/GtkBin.html">GtkBin</a>
 
95
                           +----<a href="http://library.gnome.org/devel/gtk/GtkEventBox.html">GtkEventBox</a>
 
96
                                 +----PanelApplet
 
97
</pre>
 
98
</div>
 
99
<div class="refsect1">
 
100
<a name="panel-applet-Panel-Applet.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
101
<p>
 
102
PanelApplet implements
 
103
 AtkImplementorIface and  <a href="http://library.gnome.org/devel/gtk/GtkBuildable.html">GtkBuildable</a>.</p>
 
104
</div>
 
105
<div class="refsect1">
 
106
<a name="panel-applet-Panel-Applet.properties"></a><h2>Properties</h2>
 
107
<pre class="synopsis">
 
108
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--background" title='The "background" property'>background</a>"               <span class="type">gchar</span>*                : Read / Write
 
109
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--closure" title='The "closure" property'>closure</a>"                  <span class="type">gpointer</span>              : Read / Write / Construct Only
 
110
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--connection" title='The "connection" property'>connection</a>"               <span class="type">GDBusConnection</span>*      : Read / Write / Construct Only
 
111
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--flags" title='The "flags" property'>flags</a>"                    <span class="type">guint</span>                 : Read / Write
 
112
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--id" title='The "id" property'>id</a>"                       <span class="type">gchar</span>*                : Read / Write / Construct Only
 
113
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--locked-down" title='The "locked-down" property'>locked-down</a>"              <span class="type">gboolean</span>              : Read / Write
 
114
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--orient" title='The "orient" property'>orient</a>"                   <span class="type">guint</span>                 : Read / Write
 
115
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--prefs-key" title='The "prefs-key" property'>prefs-key</a>"                <span class="type">gchar</span>*                : Read / Write
 
116
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--settings-path" title='The "settings-path" property'>settings-path</a>"            <span class="type">gchar</span>*                : Read / Write
 
117
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--size" title='The "size" property'>size</a>"                     <span class="type">guint</span>                 : Read / Write
 
118
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet--size-hints" title='The "size-hints" property'>size-hints</a>"               <span class="type">gpointer</span>              : Read / Write
 
119
</pre>
 
120
</div>
 
121
<div class="refsect1">
 
122
<a name="panel-applet-Panel-Applet.signals"></a><h2>Signals</h2>
 
123
<pre class="synopsis">
 
124
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet-change-background" title='The "change-background" signal'>change-background</a>"                              : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
125
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet-change-orient" title='The "change-orient" signal'>change-orient</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
126
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet-change-size" title='The "change-size" signal'>change-size</a>"                                    : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
127
  "<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet-move-focus-out-of-applet" title='The "move-focus-out-of-applet" signal'>move-focus-out-of-applet</a>"                       : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
 
128
</pre>
 
129
</div>
 
130
<div class="refsect1">
 
131
<a name="panel-applet-Panel-Applet.description"></a><h2>Description</h2>
 
132
<p>
 
133
Applets are small applications that are embedded in the GNOME panel. They
 
134
can be used to give quick access to some features, or to display the state
 
135
of something specific.
 
136
</p>
 
137
<p>
 
138
The <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> API hides all of the embedding process as it handles all
 
139
the communication with the GNOME panel. It is a subclass of <a href="http://library.gnome.org/devel/gtk/GtkBin.html"><span class="type">GtkBin</span></a>, so you
 
140
can add any kind of widgets to it.
 
141
</p>
 
142
<p>
 
143
See the <a class="link" href="getting-started.html" title="Part II. Getting Started with the Panel Applet library">Getting Started</a> section to
 
144
learn how to properly use <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.
 
145
</p>
 
146
</div>
 
147
<div class="refsect1">
 
148
<a name="panel-applet-Panel-Applet.details"></a><h2>Details</h2>
 
149
<div class="refsect2">
 
150
<a name="PanelApplet-struct"></a><h3>struct PanelApplet</h3>
 
151
<pre class="programlisting">struct PanelApplet;</pre>
 
152
<p>
 
153
</p>
 
154
</div>
 
155
<hr>
 
156
<div class="refsect2">
 
157
<a name="PanelAppletOrient"></a><h3>enum PanelAppletOrient</h3>
 
158
<pre class="programlisting">typedef enum {
 
159
        PANEL_APPLET_ORIENT_UP,
 
160
        PANEL_APPLET_ORIENT_DOWN,
 
161
        PANEL_APPLET_ORIENT_LEFT,
 
162
        PANEL_APPLET_ORIENT_RIGHT
 
163
} PanelAppletOrient;
 
164
</pre>
 
165
<p>
 
166
Type defining the orientation of the applet. The values may seem backward
 
167
(e.g. <a class="link" href="panel-applet-Panel-Applet.html#PANEL-APPLET-ORIENT-RIGHT:CAPS"><code class="literal">PANEL_APPLET_ORIENT_RIGHT</code></a> means the panel is on the left side), but
 
168
this represents the direction the applet is oriented to.
 
169
</p>
 
170
<div class="variablelist"><table border="0">
 
171
<col align="left" valign="top">
 
172
<tbody>
 
173
<tr>
 
174
<td><p><a name="PANEL-APPLET-ORIENT-UP:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_ORIENT_UP</code></span></p></td>
 
175
<td>The <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> is on a horizontal panel, at the
 
176
bottom of the screen. It is oriented towards the top of the screen.
 
177
</td>
 
178
</tr>
 
179
<tr>
 
180
<td><p><a name="PANEL-APPLET-ORIENT-DOWN:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_ORIENT_DOWN</code></span></p></td>
 
181
<td>The <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> is on a horizontal panel, at the
 
182
top of the screen. It is oriented towards the bottom of the screen.
 
183
</td>
 
184
</tr>
 
185
<tr>
 
186
<td><p><a name="PANEL-APPLET-ORIENT-LEFT:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_ORIENT_LEFT</code></span></p></td>
 
187
<td>The <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> is on a vertical panel, at the
 
188
right of the screen. It is oriented towards the left of the screen.
 
189
</td>
 
190
</tr>
 
191
<tr>
 
192
<td><p><a name="PANEL-APPLET-ORIENT-RIGHT:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_ORIENT_RIGHT</code></span></p></td>
 
193
<td>The <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> is on a vertical panel, at the
 
194
left of the screen. It is oriented towards the right of the screen.
 
195
</td>
 
196
</tr>
 
197
</tbody>
 
198
</table></div>
 
199
</div>
 
200
<hr>
 
201
<div class="refsect2">
 
202
<a name="PanelAppletFlags"></a><h3>enum PanelAppletFlags</h3>
 
203
<pre class="programlisting">typedef enum {
 
204
        PANEL_APPLET_FLAGS_NONE   = 0,
 
205
        PANEL_APPLET_EXPAND_MAJOR = 1 &lt;&lt; 0,
 
206
        PANEL_APPLET_EXPAND_MINOR = 1 &lt;&lt; 1,
 
207
        PANEL_APPLET_HAS_HANDLE   = 1 &lt;&lt; 2
 
208
} PanelAppletFlags;
 
209
</pre>
 
210
<p>
 
211
Flags to be used with <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-get-flags" title="panel_applet_get_flags ()"><code class="function">panel_applet_get_flags()</code></a>/<a class="link" href="panel-applet-Panel-Applet.html#panel-applet-set-flags" title="panel_applet_set_flags ()"><code class="function">panel_applet_set_flags()</code></a>, to
 
212
indicate to the panel a specific behavior requested by the <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.
 
213
</p>
 
214
<div class="variablelist"><table border="0">
 
215
<col align="left" valign="top">
 
216
<tbody>
 
217
<tr>
 
218
<td><p><a name="PANEL-APPLET-FLAGS-NONE:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_FLAGS_NONE</code></span></p></td>
 
219
<td>No flags set.
 
220
</td>
 
221
</tr>
 
222
<tr>
 
223
<td><p><a name="PANEL-APPLET-EXPAND-MAJOR:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_EXPAND_MAJOR</code></span></p></td>
 
224
<td>On horizontal panels, the <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> will be
 
225
allocated as much width as possible. On vertical panels, it will be
 
226
allocated as much height as possible.
 
227
</td>
 
228
</tr>
 
229
<tr>
 
230
<td><p><a name="PANEL-APPLET-EXPAND-MINOR:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_EXPAND_MINOR</code></span></p></td>
 
231
<td>On horizontal panels, the <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> will be
 
232
allocated the full height of the panel. On vertical panels, it will be
 
233
allocated the full width. Most applets should set this flag in order to use
 
234
the full panel size and allow the applet to be Fitt's Law compliant.
 
235
</td>
 
236
</tr>
 
237
<tr>
 
238
<td><p><a name="PANEL-APPLET-HAS-HANDLE:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_HAS_HANDLE</code></span></p></td>
 
239
<td>The panel will draw a handle for the
 
240
<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>. This handle will be usable to move the applet, and to open the
 
241
context menu of the applet.
 
242
</td>
 
243
</tr>
 
244
</tbody>
 
245
</table></div>
 
246
</div>
 
247
<hr>
 
248
<div class="refsect2">
 
249
<a name="panel-applet-get-orient"></a><h3>panel_applet_get_orient ()</h3>
 
250
<pre class="programlisting"><a class="link" href="panel-applet-Panel-Applet.html#PanelAppletOrient" title="enum PanelAppletOrient"><span class="returnvalue">PanelAppletOrient</span></a>   panel_applet_get_orient             (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);</pre>
 
251
<p>
 
252
Gets the <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletOrient" title="enum PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> of <em class="parameter"><code>applet</code></em>.
 
253
</p>
 
254
<div class="variablelist"><table border="0">
 
255
<col align="left" valign="top">
 
256
<tbody>
 
257
<tr>
 
258
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
259
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
260
</tr>
 
261
<tr>
 
262
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
263
<td>the <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletOrient" title="enum PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> of <em class="parameter"><code>applet</code></em>.</td>
 
264
</tr>
 
265
</tbody>
 
266
</table></div>
 
267
</div>
 
268
<hr>
 
269
<div class="refsect2">
 
270
<a name="panel-applet-get-size"></a><h3>panel_applet_get_size ()</h3>
 
271
<pre class="programlisting"><span class="returnvalue">guint</span>               panel_applet_get_size               (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);</pre>
 
272
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
273
<h3 class="title">Warning</h3>
 
274
<p><code class="literal">panel_applet_get_size</code> has been deprecated since version 3.0 and should not be used in newly-written code. Use the allocation of <em class="parameter"><code>applet</code></em> instead.</p>
 
275
</div>
 
276
<p>
 
277
Gets the size of the panel <em class="parameter"><code>applet</code></em> is on. For a horizontal panel, the
 
278
size if the height of the panel; for a vertical panel, the size is the width
 
279
of the panel.
 
280
</p>
 
281
<div class="variablelist"><table border="0">
 
282
<col align="left" valign="top">
 
283
<tbody>
 
284
<tr>
 
285
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
286
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
287
</tr>
 
288
<tr>
 
289
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
290
<td>the size of the panel <em class="parameter"><code>applet</code></em> is on.</td>
 
291
</tr>
 
292
</tbody>
 
293
</table></div>
 
294
</div>
 
295
<hr>
 
296
<div class="refsect2">
 
297
<a name="panel-applet-set-size-hints"></a><h3>panel_applet_set_size_hints ()</h3>
 
298
<pre class="programlisting"><span class="returnvalue">void</span>                panel_applet_set_size_hints         (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
299
                                                         <em class="parameter"><code>const <span class="type">int</span> *size_hints</code></em>,
 
300
                                                         <em class="parameter"><code><span class="type">int</span> n_elements</code></em>,
 
301
                                                         <em class="parameter"><code><span class="type">int</span> base_size</code></em>);</pre>
 
302
<p>
 
303
Give hints to the panel about sizes <em class="parameter"><code>applet</code></em> is comfortable with. This is
 
304
generally useful for applets that can take a lot of space, in case the panel
 
305
gets full and needs to restrict the size of some applets.
 
306
</p>
 
307
<p>
 
308
<em class="parameter"><code>size_hints</code></em> should have an even number of sizes. It is an array of (max,
 
309
min) pairs where min(i) &gt; max(i + 1).
 
310
</p>
 
311
<p>
 
312
<em class="parameter"><code>base_size</code></em> will be added to all sizes in <em class="parameter"><code>size_hints</code></em>, and is therefore a way
 
313
to guarantee a minimum size to <em class="parameter"><code>applet</code></em>.
 
314
</p>
 
315
<p>
 
316
The panel will try to allocate a size that is acceptable to <em class="parameter"><code>applet</code></em>, i.e. in
 
317
one of the (<em class="parameter"><code>base_size</code></em> + max, <em class="parameter"><code>base_size</code></em> + min) ranges.
 
318
</p>
 
319
<p>
 
320
<a class="link" href="panel-applet-Panel-Applet.html#PANEL-APPLET-EXPAND-MAJOR:CAPS"><code class="literal">PANEL_APPLET_EXPAND_MAJOR</code></a> must be set for <em class="parameter"><code>applet</code></em> to use size hints.
 
321
</p>
 
322
<div class="variablelist"><table border="0">
 
323
<col align="left" valign="top">
 
324
<tbody>
 
325
<tr>
 
326
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
327
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
328
</tr>
 
329
<tr>
 
330
<td><p><span class="term"><em class="parameter"><code>size_hints</code></em> :</span></p></td>
 
331
<td>array of sizes.</td>
 
332
</tr>
 
333
<tr>
 
334
<td><p><span class="term"><em class="parameter"><code>n_elements</code></em> :</span></p></td>
 
335
<td>length of <em class="parameter"><code>size_hints</code></em>.</td>
 
336
</tr>
 
337
<tr>
 
338
<td><p><span class="term"><em class="parameter"><code>base_size</code></em> :</span></p></td>
 
339
<td>base size of the applet.</td>
 
340
</tr>
 
341
</tbody>
 
342
</table></div>
 
343
</div>
 
344
<hr>
 
345
<div class="refsect2">
 
346
<a name="panel-applet-get-background"></a><h3>panel_applet_get_background ()</h3>
 
347
<pre class="programlisting"><a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-pattern-t.html#cairo-pattern-t"><span class="returnvalue">cairo_pattern_t</span></a> *   panel_applet_get_background         (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);</pre>
 
348
<p>
 
349
Gets the background pattern for <em class="parameter"><code>applet</code></em>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if there is none.
 
350
</p>
 
351
<div class="variablelist"><table border="0">
 
352
<col align="left" valign="top">
 
353
<tbody>
 
354
<tr>
 
355
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
356
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
357
</tr>
 
358
<tr>
 
359
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
360
<td>a new <a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-pattern-t.html#cairo-pattern-t"><span class="type">cairo_pattern_t</span></a> to use as background for
 
361
<em class="parameter"><code>applet</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
 
362
</td>
 
363
</tr>
 
364
</tbody>
 
365
</table></div>
 
366
</div>
 
367
<hr>
 
368
<div class="refsect2">
 
369
<a name="panel-applet-set-background-widget"></a><h3>panel_applet_set_background_widget ()</h3>
 
370
<pre class="programlisting"><span class="returnvalue">void</span>                panel_applet_set_background_widget  (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
371
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
 
372
<p>
 
373
Configure <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> to automatically draw the background of the applet on
 
374
<em class="parameter"><code>widget</code></em>. It is generally enough to call this function with <em class="parameter"><code>applet</code></em> as
 
375
<em class="parameter"><code>widget</code></em>.
 
376
</p>
 
377
<div class="variablelist"><table border="0">
 
378
<col align="left" valign="top">
 
379
<tbody>
 
380
<tr>
 
381
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
382
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
383
</tr>
 
384
<tr>
 
385
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
 
386
<td>a <a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a>.</td>
 
387
</tr>
 
388
</tbody>
 
389
</table></div>
 
390
</div>
 
391
<hr>
 
392
<div class="refsect2">
 
393
<a name="panel-applet-get-flags"></a><h3>panel_applet_get_flags ()</h3>
 
394
<pre class="programlisting"><a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a>    panel_applet_get_flags              (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);</pre>
 
395
<p>
 
396
Gets the <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> of <em class="parameter"><code>applet</code></em>.
 
397
</p>
 
398
<div class="variablelist"><table border="0">
 
399
<col align="left" valign="top">
 
400
<tbody>
 
401
<tr>
 
402
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
403
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
404
</tr>
 
405
<tr>
 
406
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
407
<td>the <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> of <em class="parameter"><code>applet</code></em>.</td>
 
408
</tr>
 
409
</tbody>
 
410
</table></div>
 
411
</div>
 
412
<hr>
 
413
<div class="refsect2">
 
414
<a name="panel-applet-set-flags"></a><h3>panel_applet_set_flags ()</h3>
 
415
<pre class="programlisting"><span class="returnvalue">void</span>                panel_applet_set_flags              (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
416
                                                         <em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> flags</code></em>);</pre>
 
417
<p>
 
418
Sets the <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> of <em class="parameter"><code>applet</code></em>. Most of the time, at least
 
419
<a class="link" href="panel-applet-Panel-Applet.html#PANEL-APPLET-EXPAND-MINOR:CAPS"><code class="literal">PANEL_APPLET_EXPAND_MINOR</code></a> should be used.
 
420
</p>
 
421
<div class="variablelist"><table border="0">
 
422
<col align="left" valign="top">
 
423
<tbody>
 
424
<tr>
 
425
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
426
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
427
</tr>
 
428
<tr>
 
429
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 
430
<td>
 
431
<a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> to use for <em class="parameter"><code>applet</code></em>.</td>
 
432
</tr>
 
433
</tbody>
 
434
</table></div>
 
435
</div>
 
436
<hr>
 
437
<div class="refsect2">
 
438
<a name="panel-applet-get-locked-down"></a><h3>panel_applet_get_locked_down ()</h3>
 
439
<pre class="programlisting"><span class="returnvalue">gboolean</span>            panel_applet_get_locked_down        (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);</pre>
 
440
<p>
 
441
Gets whether the panel <em class="parameter"><code>applet</code></em> is on is locked down or not. A locked down
 
442
applet should not allow any change to its configuration.
 
443
</p>
 
444
<div class="variablelist"><table border="0">
 
445
<col align="left" valign="top">
 
446
<tbody>
 
447
<tr>
 
448
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
449
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
450
</tr>
 
451
<tr>
 
452
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
453
<td>
 
454
<code class="literal">TRUE</code> if the panel <em class="parameter"><code>applet</code></em> is on is locked down, <code class="literal">FALSE</code> otherwise.</td>
 
455
</tr>
 
456
</tbody>
 
457
</table></div>
 
458
</div>
 
459
<hr>
 
460
<div class="refsect2">
 
461
<a name="panel-applet-settings-new"></a><h3>panel_applet_settings_new ()</h3>
 
462
<pre class="programlisting"><span class="returnvalue">GSettings</span> *         panel_applet_settings_new           (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
463
                                                         <em class="parameter"><code>const <span class="type">char</span> *schema</code></em>);</pre>
 
464
<p>
 
465
Creates a new <span class="type">GSettings</span> object for the per-instance settings of <em class="parameter"><code>applet</code></em>,
 
466
with a given schema.
 
467
</p>
 
468
<div class="variablelist"><table border="0">
 
469
<col align="left" valign="top">
 
470
<tbody>
 
471
<tr>
 
472
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
473
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
474
</tr>
 
475
<tr>
 
476
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
 
477
<td>the name of the schema.</td>
 
478
</tr>
 
479
<tr>
 
480
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
481
<td>a new <span class="type">GSettings</span> object for the per-instance settings of <em class="parameter"><code>applet</code></em>.</td>
 
482
</tr>
 
483
</tbody>
 
484
</table></div>
 
485
</div>
 
486
<hr>
 
487
<div class="refsect2">
 
488
<a name="panel-applet-add-preferences"></a><h3>panel_applet_add_preferences ()</h3>
 
489
<pre class="programlisting"><span class="returnvalue">void</span>                panel_applet_add_preferences        (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
490
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *schema_dir</code></em>,
 
491
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
492
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
493
<h3 class="title">Warning</h3>
 
494
<p><code class="literal">panel_applet_add_preferences</code> has been deprecated since version 3.0 and should not be used in newly-written code. Use <span class="type">GSettings</span> to store per-instance settings.</p>
 
495
</div>
 
496
<p>
 
497
Associates the per-instance GConf directory of <em class="parameter"><code>applet</code></em> to the schemas
 
498
defined in <em class="parameter"><code>schema_dir</code></em>. This must be called if the applet will save
 
499
per-instance settings, to ensure that each key in the per-instance GConf
 
500
directory has a defined type, sane default and documentation.
 
501
</p>
 
502
<div class="variablelist"><table border="0">
 
503
<col align="left" valign="top">
 
504
<tbody>
 
505
<tr>
 
506
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
507
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
508
</tr>
 
509
<tr>
 
510
<td><p><span class="term"><em class="parameter"><code>schema_dir</code></em> :</span></p></td>
 
511
<td>a GConf path of a schema directory.</td>
 
512
</tr>
 
513
<tr>
 
514
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
515
<td>a <span class="type">GError</span>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
 
516
</tr>
 
517
</tbody>
 
518
</table></div>
 
519
</div>
 
520
<hr>
 
521
<div class="refsect2">
 
522
<a name="panel-applet-get-preferences-key"></a><h3>panel_applet_get_preferences_key ()</h3>
 
523
<pre class="programlisting"><span class="returnvalue">gchar</span> *             panel_applet_get_preferences_key    (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);</pre>
 
524
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
525
<h3 class="title">Warning</h3>
 
526
<p><code class="literal">panel_applet_get_preferences_key</code> has been deprecated since version 3.0 and should not be used in newly-written code. Use <span class="type">GSettings</span> to store per-instance settings.</p>
 
527
</div>
 
528
<p>
 
529
Gets the GConf path to the per-instance settings of <em class="parameter"><code>applet</code></em>.
 
530
</p>
 
531
<div class="variablelist"><table border="0">
 
532
<col align="left" valign="top">
 
533
<tbody>
 
534
<tr>
 
535
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
536
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
537
</tr>
 
538
<tr>
 
539
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
540
<td>a copy of the GConf path to the per-instance settings of <em class="parameter"><code>applet</code></em>.</td>
 
541
</tr>
 
542
</tbody>
 
543
</table></div>
 
544
</div>
 
545
<hr>
 
546
<div class="refsect2">
 
547
<a name="panel-applet-request-focus"></a><h3>panel_applet_request_focus ()</h3>
 
548
<pre class="programlisting"><span class="returnvalue">void</span>                panel_applet_request_focus          (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
549
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
 
550
<p>
 
551
Requests focus for <em class="parameter"><code>applet</code></em>. There is no guarantee that <em class="parameter"><code>applet</code></em> will
 
552
successfully get focus after that call.
 
553
</p>
 
554
<div class="variablelist"><table border="0">
 
555
<col align="left" valign="top">
 
556
<tbody>
 
557
<tr>
 
558
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
559
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
560
</tr>
 
561
<tr>
 
562
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 
563
<td>the timestamp of the user interaction (typically a button or key
 
564
press event) which triggered this call.</td>
 
565
</tr>
 
566
</tbody>
 
567
</table></div>
 
568
</div>
 
569
<hr>
 
570
<div class="refsect2">
 
571
<a name="panel-applet-setup-menu"></a><h3>panel_applet_setup_menu ()</h3>
 
572
<pre class="programlisting"><span class="returnvalue">void</span>                panel_applet_setup_menu             (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
573
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *xml</code></em>,
 
574
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkActionGroup.html"><span class="type">GtkActionGroup</span></a> *action_group</code></em>);</pre>
 
575
<p>
 
576
Sets up the context menu of <em class="parameter"><code>applet</code></em>. <em class="parameter"><code>xml</code></em> is a <a href="http://library.gnome.org/devel/gtk/GtkUIManager.html"><span class="type">GtkUIManager</span></a> UI definition,
 
577
describing how to display the menu items. <em class="parameter"><code>action_group</code></em> contains the
 
578
various <a href="http://library.gnome.org/devel/gtk/GtkAction.html"><span class="type">GtkAction</span></a> that are referenced in <em class="parameter"><code>xml</code></em>.
 
579
</p>
 
580
<p>
 
581
See also the <a class="link" href="getting-started.context-menu.html" title="Using a Context Menu">Context
 
582
Menu</a> section.
 
583
</p>
 
584
<div class="variablelist"><table border="0">
 
585
<col align="left" valign="top">
 
586
<tbody>
 
587
<tr>
 
588
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
589
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
590
</tr>
 
591
<tr>
 
592
<td><p><span class="term"><em class="parameter"><code>xml</code></em> :</span></p></td>
 
593
<td>a menu XML string.</td>
 
594
</tr>
 
595
<tr>
 
596
<td><p><span class="term"><em class="parameter"><code>action_group</code></em> :</span></p></td>
 
597
<td>a <a href="http://library.gnome.org/devel/gtk/GtkActionGroup.html"><span class="type">GtkActionGroup</span></a>.</td>
 
598
</tr>
 
599
</tbody>
 
600
</table></div>
 
601
</div>
 
602
<hr>
 
603
<div class="refsect2">
 
604
<a name="panel-applet-setup-menu-from-file"></a><h3>panel_applet_setup_menu_from_file ()</h3>
 
605
<pre class="programlisting"><span class="returnvalue">void</span>                panel_applet_setup_menu_from_file   (<em class="parameter"><code><a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,
 
606
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
 
607
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkActionGroup.html"><span class="type">GtkActionGroup</span></a> *action_group</code></em>);</pre>
 
608
<p>
 
609
Sets up the context menu of <em class="parameter"><code>applet</code></em>. <em class="parameter"><code>filename</code></em> is the path to a menu XML
 
610
file, containing a <a href="http://library.gnome.org/devel/gtk/GtkUIManager.html"><span class="type">GtkUIManager</span></a> UI definition that describes how to display
 
611
the menu items. <em class="parameter"><code>action_group</code></em> contains the various <a href="http://library.gnome.org/devel/gtk/GtkAction.html"><span class="type">GtkAction</span></a> that
 
612
are referenced in <em class="parameter"><code>xml</code></em>.
 
613
</p>
 
614
<p>
 
615
See also the <a class="link" href="getting-started.context-menu.html" title="Using a Context Menu">Context
 
616
Menu</a> section.
 
617
</p>
 
618
<div class="variablelist"><table border="0">
 
619
<col align="left" valign="top">
 
620
<tbody>
 
621
<tr>
 
622
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
623
<td>a <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.</td>
 
624
</tr>
 
625
<tr>
 
626
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 
627
<td>path to a menu XML file.</td>
 
628
</tr>
 
629
<tr>
 
630
<td><p><span class="term"><em class="parameter"><code>action_group</code></em> :</span></p></td>
 
631
<td>a <a href="http://library.gnome.org/devel/gtk/GtkActionGroup.html"><span class="type">GtkActionGroup</span></a>.</td>
 
632
</tr>
 
633
</tbody>
 
634
</table></div>
 
635
</div>
 
636
</div>
 
637
<div class="refsect1">
 
638
<a name="panel-applet-Panel-Applet.property-details"></a><h2>Property Details</h2>
 
639
<div class="refsect2">
 
640
<a name="PanelApplet--background"></a><h3>The <code class="literal">"background"</code> property</h3>
 
641
<pre class="programlisting">  "background"               <span class="type">gchar</span>*                : Read / Write</pre>
 
642
<p>
 
643
Implementation detail.
 
644
</p>
 
645
<p>Default value: NULL</p>
 
646
</div>
 
647
<hr>
 
648
<div class="refsect2">
 
649
<a name="PanelApplet--closure"></a><h3>The <code class="literal">"closure"</code> property</h3>
 
650
<pre class="programlisting">  "closure"                  <span class="type">gpointer</span>              : Read / Write / Construct Only</pre>
 
651
<p>
 
652
Implementation detail.
 
653
</p>
 
654
</div>
 
655
<hr>
 
656
<div class="refsect2">
 
657
<a name="PanelApplet--connection"></a><h3>The <code class="literal">"connection"</code> property</h3>
 
658
<pre class="programlisting">  "connection"               <span class="type">GDBusConnection</span>*      : Read / Write / Construct Only</pre>
 
659
<p>
 
660
Implementation detail.
 
661
</p>
 
662
</div>
 
663
<hr>
 
664
<div class="refsect2">
 
665
<a name="PanelApplet--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
 
666
<pre class="programlisting">  "flags"                    <span class="type">guint</span>                 : Read / Write</pre>
 
667
<p>
 
668
The <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> of the applet.
 
669
</p>
 
670
<p>Allowed values: &lt;= 7</p>
 
671
<p>Default value: 0</p>
 
672
</div>
 
673
<hr>
 
674
<div class="refsect2">
 
675
<a name="PanelApplet--id"></a><h3>The <code class="literal">"id"</code> property</h3>
 
676
<pre class="programlisting">  "id"                       <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
 
677
<p>
 
678
Implementation detail.
 
679
</p>
 
680
<p>Default value: NULL</p>
 
681
</div>
 
682
<hr>
 
683
<div class="refsect2">
 
684
<a name="PanelApplet--locked-down"></a><h3>The <code class="literal">"locked-down"</code> property</h3>
 
685
<pre class="programlisting">  "locked-down"              <span class="type">gboolean</span>              : Read / Write</pre>
 
686
<p>
 
687
Whether the panel the applet is on is locked down.
 
688
</p>
 
689
<p>Default value: FALSE</p>
 
690
</div>
 
691
<hr>
 
692
<div class="refsect2">
 
693
<a name="PanelApplet--orient"></a><h3>The <code class="literal">"orient"</code> property</h3>
 
694
<pre class="programlisting">  "orient"                   <span class="type">guint</span>                 : Read / Write</pre>
 
695
<p>
 
696
The <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletOrient" title="enum PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> of the applet.
 
697
</p>
 
698
<p>
 
699
This property gets set when the applet gets embedded, and can change
 
700
when the panel position changes.
 
701
</p>
 
702
<p>Allowed values: &lt;= 3</p>
 
703
<p>Default value: 0</p>
 
704
</div>
 
705
<hr>
 
706
<div class="refsect2">
 
707
<a name="PanelApplet--prefs-key"></a><h3>The <code class="literal">"prefs-key"</code> property</h3>
 
708
<pre class="programlisting">  "prefs-key"                <span class="type">gchar</span>*                : Read / Write</pre>
 
709
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
710
<h3 class="title">Warning</h3>
 
711
<p><code class="literal">PanelApplet:prefs-key</code> has been deprecated since version 3.0 and should not be used in newly-written code. Use <span class="type">GSettings</span> to store per-instance settings.</p>
 
712
</div>
 
713
<p>
 
714
The GConf path to the per-instance settings of the applet.
 
715
</p>
 
716
<p>
 
717
This property gets set when the applet gets embedded.
 
718
</p>
 
719
<p>Default value: NULL</p>
 
720
</div>
 
721
<hr>
 
722
<div class="refsect2">
 
723
<a name="PanelApplet--settings-path"></a><h3>The <code class="literal">"settings-path"</code> property</h3>
 
724
<pre class="programlisting">  "settings-path"            <span class="type">gchar</span>*                : Read / Write</pre>
 
725
<p>
 
726
The GSettings path to the per-instance settings of the applet.
 
727
</p>
 
728
<p>
 
729
This property gets set when the applet gets embedded.
 
730
</p>
 
731
<p>Default value: NULL</p>
 
732
</div>
 
733
<hr>
 
734
<div class="refsect2">
 
735
<a name="PanelApplet--size"></a><h3>The <code class="literal">"size"</code> property</h3>
 
736
<pre class="programlisting">  "size"                     <span class="type">guint</span>                 : Read / Write</pre>
 
737
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
738
<h3 class="title">Warning</h3>
 
739
<p><code class="literal">PanelApplet:size</code> has been deprecated since version 3.0 and should not be used in newly-written code. Use the allocation of <em class="parameter"><code>applet</code></em> instead.</p>
 
740
</div>
 
741
<p>
 
742
The size of the panel the applet is on. For a horizontal panel, the
 
743
size if the height of the panel; for a vertical panel, the size is
 
744
the width of the panel.
 
745
</p>
 
746
<p>
 
747
This property gets set when the applet gets embedded, and can change
 
748
when the panel size changes.
 
749
</p>
 
750
<p>Default value: 0</p>
 
751
</div>
 
752
<hr>
 
753
<div class="refsect2">
 
754
<a name="PanelApplet--size-hints"></a><h3>The <code class="literal">"size-hints"</code> property</h3>
 
755
<pre class="programlisting">  "size-hints"               <span class="type">gpointer</span>              : Read / Write</pre>
 
756
<p>
 
757
The size hints set for the applet. See <a class="link" href="panel-applet-Panel-Applet.html#panel-applet-set-size-hints" title="panel_applet_set_size_hints ()"><code class="function">panel_applet_set_size_hints()</code></a>.
 
758
</p>
 
759
</div>
 
760
</div>
 
761
<div class="refsect1">
 
762
<a name="panel-applet-Panel-Applet.signal-details"></a><h2>Signal Details</h2>
 
763
<div class="refsect2">
 
764
<a name="PanelApplet-change-background"></a><h3>The <code class="literal">"change-background"</code> signal</h3>
 
765
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>  *applet,
 
766
                                                        <span class="type">CairoPattern</span> *pattern,
 
767
                                                        <span class="type">gpointer</span>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
768
<p>
 
769
Emitted when the background of <em class="parameter"><code>applet</code></em> has changed.
 
770
</p>
 
771
<div class="variablelist"><table border="0">
 
772
<col align="left" valign="top">
 
773
<tbody>
 
774
<tr>
 
775
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
776
<td>the <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> which emitted the signal.</td>
 
777
</tr>
 
778
<tr>
 
779
<td><p><span class="term"><em class="parameter"><code>pattern</code></em> :</span></p></td>
 
780
<td>the new background pattern for <em class="parameter"><code>applet</code></em>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if there is none.</td>
 
781
</tr>
 
782
<tr>
 
783
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
784
<td>user data set when the signal handler was connected.</td>
 
785
</tr>
 
786
</tbody>
 
787
</table></div>
 
788
</div>
 
789
<hr>
 
790
<div class="refsect2">
 
791
<a name="PanelApplet-change-orient"></a><h3>The <code class="literal">"change-orient"</code> signal</h3>
 
792
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet,
 
793
                                                        <span class="type">guint</span>        orient,
 
794
                                                        <span class="type">gpointer</span>     user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
795
<p>
 
796
Emitted when the <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletOrient" title="enum PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> of <em class="parameter"><code>applet</code></em> has changed.
 
797
</p>
 
798
<div class="variablelist"><table border="0">
 
799
<col align="left" valign="top">
 
800
<tbody>
 
801
<tr>
 
802
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
803
<td>the <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> which emitted the signal.</td>
 
804
</tr>
 
805
<tr>
 
806
<td><p><span class="term"><em class="parameter"><code>orient</code></em> :</span></p></td>
 
807
<td>the new <a class="link" href="panel-applet-Panel-Applet.html#PanelAppletOrient" title="enum PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> of <em class="parameter"><code>applet</code></em>.</td>
 
808
</tr>
 
809
<tr>
 
810
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
811
<td>user data set when the signal handler was connected.</td>
 
812
</tr>
 
813
</tbody>
 
814
</table></div>
 
815
</div>
 
816
<hr>
 
817
<div class="refsect2">
 
818
<a name="PanelApplet-change-size"></a><h3>The <code class="literal">"change-size"</code> signal</h3>
 
819
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet,
 
820
                                                        <span class="type">gint</span>         size,
 
821
                                                        <span class="type">gpointer</span>     user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
822
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
823
<h3 class="title">Warning</h3>
 
824
<p><code class="literal">PanelApplet::change-size</code> has been deprecated since version 3.0 and should not be used in newly-written code. Use the <a href="http://library.gnome.org/devel/gtk/GtkWidget.html#GtkWidget-size-allocate"><span class="type">"size-allocate"</span></a> signal instead.</p>
 
825
</div>
 
826
<p>
 
827
Emitted when the size of the panel <em class="parameter"><code>applet</code></em> is on has changed.
 
828
</p>
 
829
<div class="variablelist"><table border="0">
 
830
<col align="left" valign="top">
 
831
<tbody>
 
832
<tr>
 
833
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
834
<td>the <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> which emitted the signal.</td>
 
835
</tr>
 
836
<tr>
 
837
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
 
838
<td>the new size of the panel <em class="parameter"><code>applet</code></em> is on.</td>
 
839
</tr>
 
840
<tr>
 
841
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
842
<td>user data set when the signal handler was connected.</td>
 
843
</tr>
 
844
</tbody>
 
845
</table></div>
 
846
</div>
 
847
<hr>
 
848
<div class="refsect2">
 
849
<a name="PanelApplet-move-focus-out-of-applet"></a><h3>The <code class="literal">"move-focus-out-of-applet"</code> signal</h3>
 
850
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a>     *applet,
 
851
                                                        <a href="http://library.gnome.org/devel/gtk/gtk3-Standard-Enumerations.html#GtkDirectionType"><span class="type">GtkDirectionType</span></a> direction,
 
852
                                                        <span class="type">gpointer</span>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
 
853
<p>
 
854
Emitted when the focus is moved out of <em class="parameter"><code>applet</code></em>. This is an
 
855
implementation detail.
 
856
</p>
 
857
<div class="variablelist"><table border="0">
 
858
<col align="left" valign="top">
 
859
<tbody>
 
860
<tr>
 
861
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
 
862
<td>the <a class="link" href="panel-applet-Panel-Applet.html#PanelApplet"><span class="type">PanelApplet</span></a> which emitted the signal.</td>
 
863
</tr>
 
864
<tr>
 
865
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
 
866
<td>the move direction.</td>
 
867
</tr>
 
868
<tr>
 
869
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
870
<td>user data set when the signal handler was connected.</td>
 
871
</tr>
 
872
</tbody>
 
873
</table></div>
 
874
</div>
 
875
</div>
 
876
</div>
 
877
<div class="footer">
 
878
<hr>
 
879
          Generated by GTK-Doc V1.17.1</div>
 
880
</body>
 
881
</html>
 
 
b'\\ No newline at end of file'