~ubuntu-branches/ubuntu/oneiric/gnome-panel/oneiric : revision 1.13.7

1

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

2

<html>

3

<head>

4

5

<title>PanelApplet</title>

6

7

8

9

10

11

12

13

</head>

14

15

16

17

18

19

20

<th width="100%" align="center">Panel Applet Library Reference Manual</th>

21

22

</tr>

23

24

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.signals" class="shortcut">Signals</a>

33

</td></tr>

34

</table>

35

36

37

38

39

<h2><span class="refentrytitle"><a name="panel-applet-panel-applet.top_of_page"></a>PanelApplet</span></h2>

40

<p>PanelApplet — The PanelApplet object.</p>

41

</td>

42

43

</tr></table></div>

44

45

<a name="panel-applet-panel-applet.synopsis"></a><h2>Synopsis</h2>

46

47

#include <panel-applet.h>

48

49

<a class="link" href="panel-applet-panel-applet.html#PanelApplet-struct" title="PanelApplet">PanelApplet</a>;

50

typedef <a class="link" href="panel-applet-panel-applet.html#PanelAppletOrient" title="PanelAppletOrient">PanelAppletOrient</a>;

51

#define <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-ORIENT-UP:CAPS" title="PANEL_APPLET_ORIENT_UP">PANEL_APPLET_ORIENT_UP</a>

52

#define <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-ORIENT-DOWN:CAPS" title="PANEL_APPLET_ORIENT_DOWN">PANEL_APPLET_ORIENT_DOWN</a>

53

#define <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-ORIENT-LEFT:CAPS" title="PANEL_APPLET_ORIENT_LEFT">PANEL_APPLET_ORIENT_LEFT</a>

54

#define <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-ORIENT-RIGHT:CAPS" title="PANEL_APPLET_ORIENT_RIGHT">PANEL_APPLET_ORIENT_RIGHT</a>

55

enum <a class="link" href="panel-applet-panel-applet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType">PanelAppletBackgroundType</a>;

56

enum <a class="link" href="panel-applet-panel-applet.html#PanelAppletFlags" title="enum PanelAppletFlags">PanelAppletFlags</a>;

57

<span class="returnvalue">gboolean</span> (<a class="link" href="panel-applet-panel-applet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()">*PanelAppletFactoryCallback</a>) (<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,

58

<em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>,

59

<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);

60

<span class="returnvalue">GtkWidget</span> * <a class="link" href="panel-applet-panel-applet.html#panel-applet-new" title="panel_applet_new ()">panel_applet_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);

61

<a class="link" href="panel-applet-panel-applet.html#PanelAppletOrient" title="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>);

62

<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>);

63

<a class="link" href="panel-applet-panel-applet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="returnvalue">PanelAppletBackgroundType</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>,

64

<em class="parameter"><code><span class="type">GdkColor</span> *color</code></em>,

65

<em class="parameter"><code><span class="type">GdkPixmap</span> **pixmap</code></em>);

66

<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>);

67

<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>,

68

<em class="parameter"><code>const <span class="type">gchar</span> *schema_dir</code></em>,

69

<em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);

70

<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>);

71

<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>,

72

<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>);

73

<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>,

74

<em class="parameter"><code>const <span class="type">int</span> *size_hints</code></em>,

75

<em class="parameter"><code><span class="type">int</span> n_elements</code></em>,

76

<em class="parameter"><code><span class="type">int</span> base_size</code></em>);

77

<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>);

78

<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>,

79

<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);

80

<span class="returnvalue">BonoboControl</span> * <a class="link" href="panel-applet-panel-applet.html#panel-applet-get-control" title="panel_applet_get_control ()">panel_applet_get_control</a> (<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);

81

<span class="returnvalue">BonoboUIComponent</span> * <a class="link" href="panel-applet-panel-applet.html#panel-applet-get-popup-component" title="panel_applet_get_popup_component ()">panel_applet_get_popup_component</a> (<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);

82

<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>,

83

<em class="parameter"><code>const <span class="type">gchar</span> *xml</code></em>,

84

<em class="parameter"><code>const <span class="type">BonoboUIVerb</span> *verb_list</code></em>,

85

<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);

86

<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>,

87

<em class="parameter"><code>const <span class="type">gchar</span> *opt_datadir</code></em>,

88

<em class="parameter"><code>const <span class="type">gchar</span> *file</code></em>,

89

<em class="parameter"><code>const <span class="type">gchar</span> *opt_app_name</code></em>,

90

<em class="parameter"><code>const <span class="type">BonoboUIVerb</span> *verb_list</code></em>,

91

<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);

92

<span class="returnvalue">int</span> <a class="link" href="panel-applet-panel-applet.html#panel-applet-factory-main" title="panel_applet_factory_main ()">panel_applet_factory_main</a> (<em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>,

93

<em class="parameter"><code><span class="type">GType</span> applet_type</code></em>,

94

<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="type">PanelAppletFactoryCallback</span></a> callback</code></em>,

95

<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);

96

<span class="returnvalue">int</span> <a class="link" href="panel-applet-panel-applet.html#panel-applet-factory-main-closure" title="panel_applet_factory_main_closure ()">panel_applet_factory_main_closure</a> (<em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>,

97

<em class="parameter"><code><span class="type">GType</span> applet_type</code></em>,

98

<em class="parameter"><code><span class="type">GClosure</span> *closure</code></em>);

99

#define <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-BONOBO-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_FACTORY()">PANEL_APPLET_BONOBO_FACTORY</a> (iid,

100

type,

101

name,

102

version,

103

callback,

104

data)

105

<span class="returnvalue">Bonobo_Unknown</span> <a class="link" href="panel-applet-panel-applet.html#panel-applet-shlib-factory" title="panel_applet_shlib_factory ()">panel_applet_shlib_factory</a> (<em class="parameter"><code>const <span class="type">char</span> *iid</code></em>,

106

<em class="parameter"><code><span class="type">GType</span> applet_type</code></em>,

107

<em class="parameter"><code><span class="type">PortableServer_POA</span> poa</code></em>,

108

<em class="parameter"><code><span class="type">gpointer</span> impl_ptr</code></em>,

109

<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="type">PanelAppletFactoryCallback</span></a> callback</code></em>,

110

<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,

111

<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);

112

<span class="returnvalue">Bonobo_Unknown</span> <a class="link" href="panel-applet-panel-applet.html#panel-applet-shlib-factory-closure" title="panel_applet_shlib_factory_closure ()">panel_applet_shlib_factory_closure</a> (<em class="parameter"><code>const <span class="type">char</span> *iid</code></em>,

113

<em class="parameter"><code><span class="type">GType</span> applet_type</code></em>,

114

<em class="parameter"><code><span class="type">PortableServer_POA</span> poa</code></em>,

115

<em class="parameter"><code><span class="type">gpointer</span> impl_ptr</code></em>,

116

<em class="parameter"><code><span class="type">GClosure</span> *closure</code></em>,

117

<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);

118

#define <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_SHLIB_FACTORY()">PANEL_APPLET_BONOBO_SHLIB_FACTORY</a> (iid,

119

type,

120

descr,

121

callback,

122

data)

123

</pre>

124

</div>

125

126

<a name="panel-applet-panel-applet.object-hierarchy"></a><h2>Object Hierarchy</h2>

127

128

GObject

129

+----GInitiallyUnowned

130

+----GtkObject

131

+----GtkWidget

132

+----GtkContainer

133

+----GtkBin

134

+----GtkEventBox

135

+----PanelApplet

136

</pre>

137

</div>

138

139

<a name="panel-applet-panel-applet.implemented-interfaces"></a><h2>Implemented Interfaces</h2>

140

<p>

141

PanelApplet implements

142

AtkImplementorIface and GtkBuildable.</p>

143

</div>

144

145

<a name="panel-applet-panel-applet.signals"></a><h2>Signals</h2>

146

147

"<a class="link" href="panel-applet-panel-applet.html#PanelApplet-change-background" title='The "change-background" signal'>change-background</a>" : Run Last

148

"<a class="link" href="panel-applet-panel-applet.html#PanelApplet-change-orient" title='The "change-orient" signal'>change-orient</a>" : Run Last

149

"<a class="link" href="panel-applet-panel-applet.html#PanelApplet-change-size" title='The "change-size" signal'>change-size</a>" : Run Last

150

"<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>" : Run Last / Action

151

</pre>

152

</div>

153

154

<a name="panel-applet-panel-applet.description"></a><h2>Description</h2>

155

<p>

156

The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> object is an object which encapsulates an applet. It

157

is a <span class="type">GtkContainer</span> which may contain a single widget. This widget, in

158

turn, should contain all widgets exposed by the applet.

159

</p>

160

<p>

161

A <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> is associated with a <span class="type">BonoboControl</span>. The control makes

162

the cross process UI emmbedding required by applets possible.

163

</p>

164

</div>

165

166

<a name="panel-applet-panel-applet.details"></a><h2>Details</h2>

167

168

<a name="PanelApplet-struct"></a><h3>PanelApplet</h3>

169

<pre class="programlisting">typedef struct _PanelApplet PanelApplet;</pre>

170

<p>

171

The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> struct contains private data only.

172

</p>

173

</div>

174

<hr>

175

176

<a name="PanelAppletOrient"></a><h3>PanelAppletOrient</h3>

177

<pre class="programlisting">typedef GNOME_Vertigo_PanelOrient PanelAppletOrient;

178

</pre>

179

<p>

180

The <a class="link" href="panel-applet-panel-applet.html#PanelAppletOrient" title="PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> type specifies the orientation of the applet. The

181

values may seem backward (e.g. <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-ORIENT-LEFT:CAPS" title="PANEL_APPLET_ORIENT_LEFT"><code class="literal">PANEL_APPLET_ORIENT_LEFT</code></a> means the panel

182

is on the right hand side), but this is because the value is representative

183

of the applet's <span class="emphasis"><em>orientation</em></span>, not the panel's position.

184

</p>

185

</div>

186

<hr>

187

188

<a name="PANEL-APPLET-ORIENT-UP:CAPS"></a><h3>PANEL_APPLET_ORIENT_UP</h3>

189

<pre class="programlisting">#define PANEL_APPLET_ORIENT_UP GNOME_Vertigo_PANEL_ORIENT_UP

190

</pre>

191

<p>

192

The applet is orientated up (i.e. the panel is at the bottom of the screen).

193

</p>

194

</div>

195

<hr>

196

197

<a name="PANEL-APPLET-ORIENT-DOWN:CAPS"></a><h3>PANEL_APPLET_ORIENT_DOWN</h3>

198

<pre class="programlisting">#define PANEL_APPLET_ORIENT_DOWN GNOME_Vertigo_PANEL_ORIENT_DOWN

199

</pre>

200

<p>

201

The applet is orientated down (i.e. the panel is at the top of the screen).

202

</p>

203

</div>

204

<hr>

205

206

<a name="PANEL-APPLET-ORIENT-LEFT:CAPS"></a><h3>PANEL_APPLET_ORIENT_LEFT</h3>

207

<pre class="programlisting">#define PANEL_APPLET_ORIENT_LEFT GNOME_Vertigo_PANEL_ORIENT_LEFT

208

</pre>

209

<p>

210

The applet is orientated left (i.e. the panel is at the right hand side of the screen).

211

</p>

212

</div>

213

<hr>

214

215

<a name="PANEL-APPLET-ORIENT-RIGHT:CAPS"></a><h3>PANEL_APPLET_ORIENT_RIGHT</h3>

216

<pre class="programlisting">#define PANEL_APPLET_ORIENT_RIGHT GNOME_Vertigo_PANEL_ORIENT_RIGHT

217

</pre>

218

<p>

219

The applet is orientated right (i.e. the panel is at the left hand side of the screen).

220

</p>

221

</div>

222

<hr>

223

224

<a name="PanelAppletBackgroundType"></a><h3>enum PanelAppletBackgroundType</h3>

225

<pre class="programlisting">typedef enum {

226

PANEL_NO_BACKGROUND,

227

PANEL_COLOR_BACKGROUND,

228

PANEL_PIXMAP_BACKGROUND

229

} PanelAppletBackgroundType;

230

</pre>

231

<p>

232

The <a class="link" href="panel-applet-panel-applet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="type">PanelAppletBackgroundType</span></a> enumerated type specifies the type of

233

background of a panel.

234

</p>

235

236

237

<tbody>

238

<tr>

239

<td><p><a name="PANEL-NO-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_NO_BACKGROUND</code></span></p></td>

240

<td>The panel has no background, the default is used.

241

</td>

242

</tr>

243

<tr>

244

<td><p><a name="PANEL-COLOR-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_COLOR_BACKGROUND</code></span></p></td>

245

<td>The panel has a color, i.e rgb value,

246

background.

247

</td>

248

</tr>

249

<tr>

250

<td><p><a name="PANEL-PIXMAP-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_PIXMAP_BACKGROUND</code></span></p></td>

251

<td> The panel has either an image background

252

or is translucent.

253

</td>

254

</tr>

255

</tbody>

256

</table></div>

257

</div>

258

<hr>

259

260

<a name="PanelAppletFlags"></a><h3>enum PanelAppletFlags</h3>

261

<pre class="programlisting">typedef enum {

262

PANEL_APPLET_FLAGS_NONE = 0,

263

PANEL_APPLET_EXPAND_MAJOR = 1 << 0,

264

PANEL_APPLET_EXPAND_MINOR = 1 << 1,

265

PANEL_APPLET_HAS_HANDLE = 1 << 2

266

} PanelAppletFlags;

267

</pre>

268

<p>

269

The <a class="link" href="panel-applet-panel-applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> associated with the applet are boolean flags which

270

the panel may read in order to figure out how to handle the applet.

271

</p>

272

273

274

<tbody>

275

<tr>

276

<td><p><a name="PANEL-APPLET-FLAGS-NONE:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_FLAGS_NONE</code></span></p></td>

277

<td>No flags are to be associated with the applet.

278

</td>

279

</tr>

280

<tr>

281

<td><p><a name="PANEL-APPLET-EXPAND-MAJOR:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_EXPAND_MAJOR</code></span></p></td>

282

<td>The applet should expand horizontally on an

283

horizontal panel and vertically on a vertical panel - e.g. the behaviour

284

of the Window List applet.

285

</td>

286

</tr>

287

<tr>

288

<td><p><a name="PANEL-APPLET-EXPAND-MINOR:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_EXPAND_MINOR</code></span></p></td>

289

<td>The applet should expand vertically on an

290

horizontal panel and horizontally on a vertical panel. Most applets should

291

set this flag in order to utilise the full panel width and allow the applet

292

to be Fitt's Law compliant.

293

</td>

294

</tr>

295

<tr>

296

<td><p><a name="PANEL-APPLET-HAS-HANDLE:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_HAS_HANDLE</code></span></p></td>

297

<td>The panel should draw a grab handle around the

298

applet - e.g. the Window List and Notification Area applets both set this

299

flag.

300

</td>

301

</tr>

302

</tbody>

303

</table></div>

304

</div>

305

<hr>

306

307

<a name="PanelAppletFactoryCallback"></a><h3>PanelAppletFactoryCallback ()</h3>

308

<pre class="programlisting"><span class="returnvalue">gboolean</span> (*PanelAppletFactoryCallback) (<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>,

309

<em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>,

310

<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>

311

<p>

312

This callback is invoked when the applet is loaded onto the panel. Typically

313

the callback will check that <em class="parameter"><code>iid</code></em> matches and fill the <em class="parameter"><code>applet</code></em> with the

314

widgets which make up the applet.

315

</p>

316

<p>

317

Prior to the callback being invoked the <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> (or an instance of the

318

sub-class specified by the <span class="type">GType</span> passed to the factory macros) is instantiated

319

and initialized.

320

</p>

321

322

323

<tbody>

324

<tr>

325

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

326

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

327

</td>

328

</tr>

329

<tr>

330

331

<td>The Bonobo IID of the applet requested.

332

</td>

333

</tr>

334

<tr>

335

336

<td>The data passed to the factory macros.

337

</td>

338

</tr>

339

<tr>

340

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

341

<td>

342

<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure.

343

</td>

344

</tr>

345

</tbody>

346

</table></div>

347

</div>

348

<hr>

349

350

<a name="panel-applet-new"></a><h3>panel_applet_new ()</h3>

351

<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * panel_applet_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>

352

<p>

353

Creates a new <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>. This function is typically not

354

useful as the applet is created before the <a class="link" href="panel-applet-panel-applet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="type">PanelAppletFactoryCallback</span></a>

355

is invoked.

356

</p>

357

358

359

360

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

361

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

362

</td>

363

</tr></tbody>

364

</table></div>

365

</div>

366

<hr>

367

368

<a name="panel-applet-get-orient"></a><h3>panel_applet_get_orient ()</h3>

369

<pre class="programlisting"><a class="link" href="panel-applet-panel-applet.html#PanelAppletOrient" title="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>

370

<p>

371

Get the current orientation of the applet.

372

</p>

373

374

375

<tbody>

376

<tr>

377

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

378

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

379

</td>

380

</tr>

381

<tr>

382

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

383

<td>The orientation of the applet.

384

</td>

385

</tr>

386

</tbody>

387

</table></div>

388

</div>

389

<hr>

390

391

<a name="panel-applet-get-size"></a><h3>panel_applet_get_size ()</h3>

392

<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>

393

<p>

394

Get the current size hint for the panel. The size hint is

395

not useful for most applets.

396

</p>

397

<p>

398

Note: The return value is <span class="emphasis"><em>not an integer value

399

specifying the pixel size of the panel.</em></span> Do not

400

use this value to calculate the size of the applet. Use it

401

only as a hint by which to decide the applet's layout.

402

</p>

403

404

405

<tbody>

406

<tr>

407

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

408

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

409

</td>

410

</tr>

411

<tr>

412

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

413

<td>The panel's size hint.

414

</td>

415

</tr>

416

</tbody>

417

</table></div>

418

</div>

419

<hr>

420

421

<a name="panel-applet-get-background"></a><h3>panel_applet_get_background ()</h3>

422

<pre class="programlisting"><a class="link" href="panel-applet-panel-applet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="returnvalue">PanelAppletBackgroundType</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>,

423

<em class="parameter"><code><span class="type">GdkColor</span> *color</code></em>,

424

<em class="parameter"><code><span class="type">GdkPixmap</span> **pixmap</code></em>);</pre>

425

<p>

426

Returns the current background type. If the background

427

type is <a class="link" href="panel-applet-panel-applet.html#PANEL-NO-BACKGROUND:CAPS"><code class="literal">PANEL_NO_BACKGROUND</code></a> both <em class="parameter"><code>color</code></em> and <em class="parameter"><code>pixmap</code></em> will

428

be unaffected. If the background type is <a class="link" href="panel-applet-panel-applet.html#PANEL-COLOR-BACKGROUND:CAPS"><code class="literal">PANEL_COLOR_BACKGROUND</code></a>

429

then <em class="parameter"><code>color</code></em> will contain the current panel background colour.

430

If the background type is <a class="link" href="panel-applet-panel-applet.html#PANEL-PIXMAP-BACKGROUND:CAPS"><code class="literal">PANEL_PIXMAP_BACKGROUND</code></a>, <em class="parameter"><code>pixmap</code></em> will

431

contain a pointer to a <span class="type">GdkPixmap</span> which is a copy of the applet's

432

portion of the panel's background pixmap.

433

</p>

434

435

436

<tbody>

437

<tr>

438

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

439

<td>A <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

440

</td>

441

</tr>

442

<tr>

443

<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>

444

<td>A <span class="type">GdkColor</span> to be filled in.

445

</td>

446

</tr>

447

<tr>

448

<td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>

449

<td>Returned <span class="type">GdkPixmap</span>.

450

</td>

451

</tr>

452

<tr>

453

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

454

<td>The background type.

455

</td>

456

</tr>

457

</tbody>

458

</table></div>

459

</div>

460

<hr>

461

462

<a name="panel-applet-get-preferences-key"></a><h3>panel_applet_get_preferences_key ()</h3>

463

<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>

464

<p>

465

Returns the GConf path to the directory containing the applet's

466

per-instance preference keys. Using this you may construct the

467

full path for the applet's preference keys. See

468

<a class="xref" href="panel-applet-Panel-Applet-GConf-Utilities.html" title="Panel Applet GConf Utilities"><span class="refentrytitle"><a name="panel-applet-Panel-Applet-GConf-Utilities.top_of_page"></a>Panel Applet GConf Utilities</span>(3)</a> for

469

more information.

470

</p>

471

472

473

<tbody>

474

<tr>

475

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

476

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

477

</td>

478

</tr>

479

<tr>

480

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

481

<td>A GConf path.

482

</td>

483

</tr>

484

</tbody>

485

</table></div>

486

</div>

487

<hr>

488

489

<a name="panel-applet-add-preferences"></a><h3>panel_applet_add_preferences ()</h3>

490

<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>,

491

<em class="parameter"><code>const <span class="type">gchar</span> *schema_dir</code></em>,

492

<em class="parameter"><code><span class="type">GError</span> **opt_error</code></em>);</pre>

493

<p>

494

Associates each schema in <em class="parameter"><code>schema_dir</code></em> with a key in the applet's

495

preferences directory (i.e. the directory returned by

496

<a class="link" href="panel-applet-panel-applet.html#panel-applet-get-preferences-key" title="panel_applet_get_preferences_key ()"><code class="function">panel_applet_get_preferences_key()</code></a>). Each applet preference

497

should have an associated schema to ensure that the key has

498

a defined type, sane default and documentation.

499

</p>

500

<p>

501

If you pass <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print

502

a warning message from any <span class="type">GError</span> which GConf may return.

503

</p>

504

505

506

<tbody>

507

<tr>

508

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

509

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

510

</td>

511

</tr>

512

<tr>

513

<td><p><span class="term"><em class="parameter"><code>schema_dir</code></em> :</span></p></td>

514

<td>The GConf path where the applet's schemas are installed

515

e.g. /schemas/apps/my_applet

516

</td>

517

</tr>

518

<tr>

519

<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td>

520

<td>Optional <span class="type">GError</span>.

521

</td>

522

</tr>

523

</tbody>

524

</table></div>

525

</div>

526

<hr>

527

528

<a name="panel-applet-get-flags"></a><h3>panel_applet_get_flags ()</h3>

529

<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>

530

<p>

531

Retrieve the <a class="link" href="panel-applet-panel-applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> associated with the applet.

532

</p>

533

534

535

<tbody>

536

<tr>

537

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

538

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

539

</td>

540

</tr>

541

<tr>

542

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

543

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a>.

544

</td>

545

</tr>

546

</tbody>

547

</table></div>

548

</div>

549

<hr>

550

551

<a name="panel-applet-set-flags"></a><h3>panel_applet_set_flags ()</h3>

552

<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>,

553

<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>

554

<p>

555

Set the <a class="link" href="panel-applet-panel-applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> associated with the applet. See

556

<a class="link" href="panel-applet-panel-applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> for more details on the possible uses of

557

these flags.

558

</p>

559

560

561

<tbody>

562

<tr>

563

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

564

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

565

</td>

566

</tr>

567

<tr>

568

<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>

569

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> to associate.

570

</td>

571

</tr>

572

</tbody>

573

</table></div>

574

</div>

575

<hr>

576

577

<a name="panel-applet-set-size-hints"></a><h3>panel_applet_set_size_hints ()</h3>

578

<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>,

579

<em class="parameter"><code>const <span class="type">int</span> *size_hints</code></em>,

580

<em class="parameter"><code><span class="type">int</span> n_elements</code></em>,

581

582

<p>

583

Set a list of desired size ranges for an applet with the

584

<a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-EXPAND-MAJOR:CAPS"><span class="type">PANEL_APPLET_EXPAND_MAJOR</span></a> flags set. <em class="parameter"><code>size_hints</code></em> is an

585

array of (max, min) pairs where min(i) > max(i + 1).

586

</p>

587

<p>

588

The panel will endeavour to allocate the applet a size

589

in one of the (<em class="parameter"><code>base</code></em> + max, <em class="parameter"><code>base</code></em> + min) ranges.

590

</p>

591

592

593

<tbody>

594

<tr>

595

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

596

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

597

</td>

598

</tr>

599

<tr>

600

<td><p><span class="term"><em class="parameter"><code>size_hints</code></em> :</span></p></td>

601

<td>Array of size_hints.

602

</td>

603

</tr>

604

<tr>

605

<td><p><span class="term"><em class="parameter"><code>n_elements</code></em> :</span></p></td>

606

<td>Number of elements in the array. <span class="emphasis"><em>

607

Not</em></span> the number of pairs.

608

</td>

609

</tr>

610

<tr>

611

612

<td>The base size of the applet.

613

</td>

614

</tr>

615

</tbody>

616

</table></div>

617

</div>

618

<hr>

619

620

<a name="panel-applet-get-locked-down"></a><h3>panel_applet_get_locked_down ()</h3>

621

<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>

622

<p>

623

Check if the <em class="parameter"><code>applet</code></em> is locked down. A locked down applet should not allow any change to its configuration.

624

</p>

625

626

627

<tbody>

628

<tr>

629

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

630

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

631

</td>

632

</tr>

633

<tr>

634

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

635

<td>

636

<code class="literal">TRUE</code> if the <em class="parameter"><code>applet</code></em> is locked down, <code class="literal">FALSE</code> otherwise.

637

</td>

638

</tr>

639

</tbody>

640

</table></div>

641

</div>

642

<hr>

643

644

<a name="panel-applet-request-focus"></a><h3>panel_applet_request_focus ()</h3>

645

<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>,

646

<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>

647

<p>

648

Set keyboard focus to <em class="parameter"><code>applet</code></em>.

649

</p>

650

651

652

<tbody>

653

<tr>

654

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

655

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

656

</td>

657

</tr>

658

<tr>

659

<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>

660

<td>timestamp of the event triggering the window focus

661

</td>

662

</tr>

663

</tbody>

664

</table></div>

665

</div>

666

<hr>

667

668

<a name="panel-applet-get-control"></a><h3>panel_applet_get_control ()</h3>

669

<pre class="programlisting"><span class="returnvalue">BonoboControl</span> * panel_applet_get_control (<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);</pre>

670

<p>

671

Retrieves the <span class="type">BonoboControl</span> associated with <em class="parameter"><code>applet</code></em>.

672

</p>

673

674

675

<tbody>

676

<tr>

677

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

678

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

679

</td>

680

</tr>

681

<tr>

682

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

683

<td>A <span class="type">BonoboControl</span>.

684

</td>

685

</tr>

686

</tbody>

687

</table></div>

688

</div>

689

<hr>

690

691

<a name="panel-applet-get-popup-component"></a><h3>panel_applet_get_popup_component ()</h3>

692

<pre class="programlisting"><span class="returnvalue">BonoboUIComponent</span> * panel_applet_get_popup_component (<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a> *applet</code></em>);</pre>

693

<p>

694

Retrieves the <span class="type">BonoboUIComponent</span> used for popup menus associated

695

with <em class="parameter"><code>applet</code></em>.

696

</p>

697

698

699

<tbody>

700

<tr>

701

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

702

<td>The <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

703

</td>

704

</tr>

705

<tr>

706

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

707

<td>A <span class="type">BonoboUIComponent</span>.

708

</td>

709

</tr>

710

</tbody>

711

</table></div>

712

</div>

713

<hr>

714

715

<a name="panel-applet-setup-menu"></a><h3>panel_applet_setup_menu ()</h3>

716

<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>,

717

<em class="parameter"><code>const <span class="type">gchar</span> *xml</code></em>,

718

<em class="parameter"><code>const <span class="type">BonoboUIVerb</span> *verb_list</code></em>,

719

<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>

720

<p>

721

Sets up a popup menu for <em class="parameter"><code>applet</code></em> described by the xml

722

string, <em class="parameter"><code>xml</code></em>. See <a class="xref" href="applet-writing.html" title="Writing Applets"><i>Writing Applets</i></a> section

723

for a description of the format of the xml.

724

</p>

725

726

727

<tbody>

728

<tr>

729

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

730

<td>A <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

731

</td>

732

</tr>

733

<tr>

734

735

<td>The xml character string describing the popup menu.

736

</td>

737

</tr>

738

<tr>

739

740

<td>The list of <span class="type">BonoboUIVerbs</span> for the menu.

741

</td>

742

</tr>

743

<tr>

744

745

<td>The user data pointer for the menu.

746

</td>

747

</tr>

748

</tbody>

749

</table></div>

750

</div>

751

<hr>

752

753

<a name="panel-applet-setup-menu-from-file"></a><h3>panel_applet_setup_menu_from_file ()</h3>

754

<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>,

755

<em class="parameter"><code>const <span class="type">gchar</span> *opt_datadir</code></em>,

756

<em class="parameter"><code>const <span class="type">gchar</span> *file</code></em>,

757

<em class="parameter"><code>const <span class="type">gchar</span> *opt_app_name</code></em>,

758

<em class="parameter"><code>const <span class="type">BonoboUIVerb</span> *verb_list</code></em>,

759

<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>

760

<p>

761

Sets up a popup menu for <em class="parameter"><code>applet</code></em> described by the xml

762

file, <em class="parameter"><code>file</code></em>. See <a class="xref" href="applet-writing.html" title="Writing Applets"><i>Writing Applets</i></a> for a description of

763

the format of the xml.

764

</p>

765

766

767

<tbody>

768

<tr>

769

<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>

770

<td>A <a class="link" href="panel-applet-panel-applet.html#PanelApplet"><span class="type">PanelApplet</span></a>.

771

</td>

772

</tr>

773

<tr>

774

<td><p><span class="term"><em class="parameter"><code>opt_datadir</code></em> :</span></p></td>

775

<td>The data directory - i.e. ${prefix}/share (optional).

776

</td>

777

</tr>

778

<tr>

779

780

<td>The file's name.

781

</td>

782

</tr>

783

<tr>

784

785

<td>The application's name (optional).

786

</td>

787

</tr>

788

<tr>

789

790

<td>The list of <span class="type">BonoboUIVerbs</span> for the menu.

791

</td>

792

</tr>

793

<tr>

794

795

<td>The user data pointer for the menu.

796

</td>

797

</tr>

798

</tbody>

799

</table></div>

800

</div>

801

<hr>

802

803

<a name="panel-applet-factory-main"></a><h3>panel_applet_factory_main ()</h3>

804

<pre class="programlisting"><span class="returnvalue">int</span> panel_applet_factory_main (<em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>,

805

<em class="parameter"><code><span class="type">GType</span> applet_type</code></em>,

806

<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="type">PanelAppletFactoryCallback</span></a> callback</code></em>,

807

<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>

808

<p>

809

A generic 'main' routine for applets. This should not normally be

810

used directly because it is invoked by <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-BONOBO-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_FACTORY()"><span class="type">PANEL_APPLET_BONOBO_FACTORY</span></a>.

811

</p>

812

813

814

<tbody>

815

<tr>

816

817

<td>The bonobo-activation iid of the factory.

818

</td>

819

</tr>

820

<tr>

821

<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td>

822

<td>The <span class="type">GType</span> to instantiate.

823

</td>

824

</tr>

825

<tr>

826

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

827

<td>The factory callback.

828

</td>

829

</tr>

830

<tr>

831

832

<td>The factory user data pointer.

833

</td>

834

</tr>

835

<tr>

836

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

837

<td>0 on success, 1 on failure.

838

</td>

839

</tr>

840

</tbody>

841

</table></div>

842

</div>

843

<hr>

844

845

<a name="panel-applet-factory-main-closure"></a><h3>panel_applet_factory_main_closure ()</h3>

846

<pre class="programlisting"><span class="returnvalue">int</span> panel_applet_factory_main_closure (<em class="parameter"><code>const <span class="type">gchar</span> *iid</code></em>,

847

<em class="parameter"><code><span class="type">GType</span> applet_type</code></em>,

848

<em class="parameter"><code><span class="type">GClosure</span> *closure</code></em>);</pre>

849

<p>

850

A generic 'main' routine for applets. This should not normally be

851

used directly because it is invoked by <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-BONOBO-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_FACTORY()"><span class="type">PANEL_APPLET_BONOBO_FACTORY</span></a>.

852

</p>

853

854

855

<tbody>

856

<tr>

857

858

<td>The bonobo-activation iid of the factory.

859

</td>

860

</tr>

861

<tr>

862

<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td>

863

<td>The <span class="type">GType</span> to instantiate.

864

</td>

865

</tr>

866

<tr>

867

<td><p><span class="term"><em class="parameter"><code>closure</code></em> :</span></p></td>

868

<td>The factory callback closure.

869

</td>

870

</tr>

871

<tr>

872

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

873

<td>0 on success, 1 on failure.

874

</td>

875

</tr>

876

</tbody>

877

</table></div>

878

</div>

879

<hr>

880

881

<a name="PANEL-APPLET-BONOBO-FACTORY:CAPS"></a><h3>PANEL_APPLET_BONOBO_FACTORY()</h3>

882

<pre class="programlisting">#define PANEL_APPLET_BONOBO_FACTORY(iid, type, name, version, callback, data)</pre>

883

<p>

884

Defines a 'main' routine for the applet factory.

885

</p>

886

887

888

<tbody>

889

<tr>

890

891

<td>The bonobo-activation iid of the factory.

892

</td>

893

</tr>

894

<tr>

895

896

<td>The <span class="type">GType</span> to instantiate.

897

</td>

898

</tr>

899

<tr>

900

901

<td>The applet ID string.

902

</td>

903

</tr>

904

<tr>

905

<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>

906

<td>The applet version string.

907

</td>

908

</tr>

909

<tr>

910

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

911

<td>The factory callback.

912

</td>

913

</tr>

914

<tr>

915

916

<td>The factory user data pointer.

917

</td>

918

</tr>

919

</tbody>

920

</table></div>

921

</div>

922

<hr>

923

924

<a name="panel-applet-shlib-factory"></a><h3>panel_applet_shlib_factory ()</h3>

925

<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span> panel_applet_shlib_factory (<em class="parameter"><code>const <span class="type">char</span> *iid</code></em>,

926

<em class="parameter"><code><span class="type">GType</span> applet_type</code></em>,

927

<em class="parameter"><code><span class="type">PortableServer_POA</span> poa</code></em>,

928

<em class="parameter"><code><span class="type">gpointer</span> impl_ptr</code></em>,

929

<em class="parameter"><code><a class="link" href="panel-applet-panel-applet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="type">PanelAppletFactoryCallback</span></a> callback</code></em>,

930

<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,

931

<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);</pre>

932

<p>

933

A generic shared library factory routine for applets. This should not

934

normally be used directly as it is invoked by <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_SHLIB_FACTORY()"><span class="type">PANEL_APPLET_BONOBO_SHLIB_FACTORY</span></a>.

935

</p>

936

937

938

<tbody>

939

<tr>

940

941

<td>The bonobo-activation iid of the factory.

942

</td>

943

</tr>

944

<tr>

945

<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td>

946

<td>The <span class="type">GType</span> to instantiate.

947

</td>

948

</tr>

949

<tr>

950

951

<td>The <span class="type">PortableServer_POA</span> passed to the shlib factory

952

callback.

953

</td>

954

</tr>

955

<tr>

956

957

<td>The <span class="type">gpointer</span> passed to the shlib factory callback.

958

</td>

959

</tr>

960

<tr>

961

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

962

<td>The applet factory callback.

963

</td>

964

</tr>

965

<tr>

966

967

<td>The factory user data pointer.

968

</td>

969

</tr>

970

<tr>

971

972

<td>The $CORBA_Environment passed to the shlib factory callback.

973

</td>

974

</tr>

975

<tr>

976

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

977

<td>A <span class="type">Bonobo_Unknown</span> to return from the shlib factory

978

callback.

979

</td>

980

</tr>

981

</tbody>

982

</table></div>

983

</div>

984

<hr>

985

986

<a name="panel-applet-shlib-factory-closure"></a><h3>panel_applet_shlib_factory_closure ()</h3>

987

<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span> panel_applet_shlib_factory_closure (<em class="parameter"><code>const <span class="type">char</span> *iid</code></em>,

988

<em class="parameter"><code><span class="type">GType</span> applet_type</code></em>,

989

<em class="parameter"><code><span class="type">PortableServer_POA</span> poa</code></em>,

990

<em class="parameter"><code><span class="type">gpointer</span> impl_ptr</code></em>,

991

<em class="parameter"><code><span class="type">GClosure</span> *closure</code></em>,

992

<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);</pre>

993

<p>

994

A generic shared library factory routine for applets. This should not

995

normally be used directly as it is invoked by <a class="link" href="panel-applet-panel-applet.html#PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_SHLIB_FACTORY()"><span class="type">PANEL_APPLET_BONOBO_SHLIB_FACTORY</span></a>.

996

</p>

997

998

999

<tbody>

1000

<tr>

1001

1002

<td>The bonobo-activation iid of the factory.

1003

</td>

1004

</tr>

1005

<tr>

1006

<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td>

1007

<td>The <span class="type">GType</span> to instantiate.

1008

</td>

1009

</tr>

1010

<tr>

1011

1012

<td>The <span class="type">PortableServer_POA</span> passed to the shlib factory

1013

callback.

1014

</td>

1015

</tr>

1016

<tr>

1017

1018

<td>The <span class="type">gpointer</span> passed to the shlib factory callback.

1019

</td>

1020

</tr>

1021

<tr>

1022

<td><p><span class="term"><em class="parameter"><code>closure</code></em> :</span></p></td>

1023

<td>The applet factory closure.

1024

</td>

1025

</tr>

1026

<tr>

1027

1028

<td>The $CORBA_Environment passed to the shlib factory callback.

1029

</td>

1030

</tr>

1031

<tr>

1032

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

1033

<td>A <span class="type">Bonobo_Unknown</span> to return from the shlib factory

1034

callback.

1035

</td>

1036

</tr>

1037

</tbody>

1038

</table></div>

1039

</div>

1040

<hr>

1041

1042

<a name="PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS"></a><h3>PANEL_APPLET_BONOBO_SHLIB_FACTORY()</h3>

1043

<pre class="programlisting">#define PANEL_APPLET_BONOBO_SHLIB_FACTORY(iid, type, descr, callback, data)</pre>

1044

<p>

1045

Defines a Bonobo Activation shared library plugin and associated

1046

factory callback.

1047

</p>

1048

1049

1050

<tbody>

1051

<tr>

1052

1053

<td>The bonobo-activation iid of the factory.

1054

</td>

1055

</tr>

1056

<tr>

1057

1058

<td>The <span class="type">GType</span> to instantiate.

1059

</td>

1060

</tr>

1061

<tr>

1062

<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>

1063

<td>A description of the applet.

1064

</td>

1065

</tr>

1066

<tr>

1067

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

1068

<td>The factory callback.

1069

</td>

1070

</tr>

1071

<tr>

1072

1073

<td>The factory user data pointer.

1074

</td>

1075

</tr>

1076

</tbody>

1077

</table></div>

1078

</div>

1079

</div>

1080

1081

<a name="panel-applet-panel-applet.signal-details"></a><h2>Signal Details</h2>

1082

1083

<a name="PanelApplet-change-background"></a><h3>The <code class="literal">"change-background"</code> signal</h3>

1084

<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> *panelapplet,

1085

<a class="link" href="panel-applet-panel-applet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="type">PanelAppletBackgroundType</span></a> arg1,

1086

<span class="type">GdkColor</span> *arg2,

1087

<span class="type">GdkPixmap</span> *arg3,

1088

<span class="type">gpointer</span> user_data) : Run Last</pre>

1089

<p>

1090

Emitted when the background of the panel changes. Use <em class="parameter"><code>type</code></em> to

1091

determine which, if any, of <em class="parameter"><code>color</code></em> and <em class="parameter"><code>pimxap</code></em> is valid.

1092

</p>

1093

1094

1095

<tbody>

1096

<tr>

1097

<td><p><span class="term"><em class="parameter"><code>panelapplet</code></em> :</span></p></td>

1098

<td>The object which received the signal.

1099

</td>

1100

</tr>

1101

<tr>

1102

1103

<td>

1104

</td>

1105

</tr>

1106

<tr>

1107

1108

<td>

1109

</td>

1110

</tr>

1111

<tr>

1112

1113

<td>

1114

</td>

1115

</tr>

1116

<tr>

1117

1118

<td>user data set when the signal handler was connected.</td>

1119

</tr>

1120

</tbody>

1121

</table></div>

1122

</div>

1123

<hr>

1124

1125

<a name="PanelApplet-change-orient"></a><h3>The <code class="literal">"change-orient"</code> signal</h3>

1126

<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> *panelapplet,

1127

<span class="type">guint</span> arg1,

1128

<span class="type">gpointer</span> user_data) : Run Last</pre>

1129

<p>

1130

Emitted when the orientation of the panel changes.

1131

</p>

1132

1133

1134

<tbody>

1135

<tr>

1136

<td><p><span class="term"><em class="parameter"><code>panelapplet</code></em> :</span></p></td>

1137

<td>The object which received the signal.

1138

</td>

1139

</tr>

1140

<tr>

1141

<td><p><span class="term"><em class="parameter"><code>orient</code></em> :</span></p></td>

1142

<td>The new <a class="link" href="panel-applet-panel-applet.html#PanelAppletOrient" title="PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> of the applet.

1143

</td>

1144

</tr>

1145

<tr>

1146

1147

<td>user data set when the signal handler was connected.</td>

1148

</tr>

1149

</tbody>

1150

</table></div>

1151

</div>

1152

<hr>

1153

1154

<a name="PanelApplet-change-size"></a><h3>The <code class="literal">"change-size"</code> signal</h3>

1155

<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> *panelapplet,

1156

<span class="type">gint</span> arg1,

1157

<span class="type">gpointer</span> user_data) : Run Last</pre>

1158

<p>

1159

Emitted when the size of the panel changes.

1160

</p>

1161

<p>

1162

Note: this is different for size negotiation which is handled by

1163

<code class="function">size_request()</code> and <code class="function">size_allocate()</code> as usual. This signal should

1164

be used to determine what font size or widget layout to use

1165

depending on the size of the panel. See <a class="link" href="panel-applet-panel-applet.html#panel-applet-get-size" title="panel_applet_get_size ()"><code class="function">panel_applet_get_size()</code></a>.

1166

</p>

1167

1168

1169

<tbody>

1170

<tr>

1171

<td><p><span class="term"><em class="parameter"><code>panelapplet</code></em> :</span></p></td>

1172

<td>The object which received the signal.

1173

</td>

1174

</tr>

1175

<tr>

1176

1177

<td>The size hint of the panel.

1178

</td>

1179

</tr>

1180

<tr>

1181

1182

<td>user data set when the signal handler was connected.</td>

1183

</tr>

1184

</tbody>

1185

</table></div>

1186

</div>

1187

<hr>

1188

1189

<a name="PanelApplet-move-focus-out-of-applet"></a><h3>The <code class="literal">"move-focus-out-of-applet"</code> signal</h3>

1190

<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> *panelapplet,

1191

<span class="type">GtkDirectionType</span> arg1,

1192

<span class="type">gpointer</span> user_data) : Run Last / Action</pre>

1193

<p>

1194

Emitted when the applet has lost focus. This signal is used internally and is not meant to be used by applets themselves.

1195

</p>

1196

1197

1198

<tbody>

1199

<tr>

1200

<td><p><span class="term"><em class="parameter"><code>panelapplet</code></em> :</span></p></td>

1201

<td>The object which received the signal.

1202

</td>

1203

</tr>

1204

<tr>

1205

<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>

1206

<td>The direction of focus movement.

1207

</td>

1208

</tr>

1209

<tr>

1210

1211

<td>user data set when the signal handler was connected.</td>

1212

</tr>

1213

</tbody>

1214

</table></div>

1215

</div>

1216

</div>

1217

</div>

1218

1219

<hr>

1220

Generated by GTK-Doc V1.14</div>

1221

</body>

1222

</html>

b'\\ No newline at end of file'