~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

14

15

16

</head>

17

18

19

20

21

22

23

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

24

25

</tr>

26

27

28

|

29

<a href="#PanelApplet.description" class="shortcut">Description</a>

30

|

31

<a href="#PanelApplet.object-hierarchy" class="shortcut">Object Hierarchy</a>

32

|

33

<a href="#PanelApplet.implemented-interfaces" class="shortcut">Implemented Interfaces</a>

34

|

35

<a href="#PanelApplet.signals" class="shortcut">Signals</a>

36

</td></tr>

37

</table>

38

39

40

41

42

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

43

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

44

</td>

45

46

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

47

48

<a name="PanelApplet.synopsis"></a><h2>Synopsis</h2>

49

50

#include <panel-applet.h>

51

52

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

53

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

54

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

55

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

56

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

57

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

58

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

59

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

60

<span class="returnvalue">gboolean</span> (<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()">*PanelAppletFactoryCallback</a>) (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

61

const <span class="returnvalue">gchar</span> *iid,

62

<span class="returnvalue">gpointer</span> user_data);

63

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

64

<a class="link" href="PanelApplet.html#PanelAppletOrient" title="PanelAppletOrient"><span class="returnvalue">PanelAppletOrient</span></a> <a class="link" href="PanelApplet.html#panel-applet-get-orient" title="panel_applet_get_orient ()">panel_applet_get_orient</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);

65

<span class="returnvalue">guint</span> <a class="link" href="PanelApplet.html#panel-applet-get-size" title="panel_applet_get_size ()">panel_applet_get_size</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);

66

<a class="link" href="PanelApplet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="returnvalue">PanelAppletBackgroundType</span></a> <a class="link" href="PanelApplet.html#panel-applet-get-background" title="panel_applet_get_background ()">panel_applet_get_background</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

67

<span class="returnvalue">GdkColor</span> *color,

68

<span class="returnvalue">GdkPixmap</span> **pixmap);

69

<span class="returnvalue">gchar</span> * <a class="link" href="PanelApplet.html#panel-applet-get-preferences-key" title="panel_applet_get_preferences_key ()">panel_applet_get_preferences_key</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);

70

<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-add-preferences" title="panel_applet_add_preferences ()">panel_applet_add_preferences</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

71

const <span class="returnvalue">gchar</span> *schema_dir,

72

<span class="returnvalue">GError</span> **opt_error);

73

<a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a> <a class="link" href="PanelApplet.html#panel-applet-get-flags" title="panel_applet_get_flags ()">panel_applet_get_flags</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);

74

<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-set-flags" title="panel_applet_set_flags ()">panel_applet_set_flags</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

75

<a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a> flags);

76

<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-set-size-hints" title="panel_applet_set_size_hints ()">panel_applet_set_size_hints</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

77

const <span class="returnvalue">int</span> *size_hints,

78

<span class="returnvalue">int</span> n_elements,

79

<span class="returnvalue">int</span> base_size);

80

<span class="returnvalue">gboolean</span> <a class="link" href="PanelApplet.html#panel-applet-get-locked-down" title="panel_applet_get_locked_down ()">panel_applet_get_locked_down</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);

81

<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-request-focus" title="panel_applet_request_focus ()">panel_applet_request_focus</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

82

<span class="returnvalue">guint32</span> timestamp);

83

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

84

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

85

<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-setup-menu" title="panel_applet_setup_menu ()">panel_applet_setup_menu</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

86

const <span class="returnvalue">gchar</span> *xml,

87

const <span class="returnvalue">BonoboUIVerb</span> *verb_list,

88

<span class="returnvalue">gpointer</span> user_data);

89

<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-setup-menu-from-file" title="panel_applet_setup_menu_from_file ()">panel_applet_setup_menu_from_file</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

90

const <span class="returnvalue">gchar</span> *opt_datadir,

91

const <span class="returnvalue">gchar</span> *file,

92

const <span class="returnvalue">gchar</span> *opt_app_name,

93

const <span class="returnvalue">BonoboUIVerb</span> *verb_list,

94

<span class="returnvalue">gpointer</span> user_data);

95

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

96

<span class="returnvalue">GType</span> applet_type,

97

<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="returnvalue">PanelAppletFactoryCallback</span></a> callback,

98

<span class="returnvalue">gpointer</span> data);

99

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

100

<span class="returnvalue">GType</span> applet_type,

101

<span class="returnvalue">GClosure</span> *closure);

102

#define <a class="link" href="PanelApplet.html#PANEL-APPLET-BONOBO-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_FACTORY()">PANEL_APPLET_BONOBO_FACTORY</a> (iid, type, name, version, callback, data)

103

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

104

<span class="returnvalue">GType</span> applet_type,

105

<span class="returnvalue">PortableServer_POA</span> poa,

106

<span class="returnvalue">gpointer</span> impl_ptr,

107

<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="returnvalue">PanelAppletFactoryCallback</span></a> callback,

108

<span class="returnvalue">gpointer</span> user_data,

109

<span class="returnvalue">CORBA_Environment</span> *ev);

110

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

111

<span class="returnvalue">GType</span> applet_type,

112

<span class="returnvalue">PortableServer_POA</span> poa,

113

<span class="returnvalue">gpointer</span> impl_ptr,

114

<span class="returnvalue">GClosure</span> *closure,

115

<span class="returnvalue">CORBA_Environment</span> *ev);

116

#define <a class="link" href="PanelApplet.html#PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_SHLIB_FACTORY()">PANEL_APPLET_BONOBO_SHLIB_FACTORY</a> (iid, type, descr, callback, data)

117

</pre>

118

</div>

119

120

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

121

122

GObject

123

+----GInitiallyUnowned

124

+----GtkObject

125

+----GtkWidget

126

+----GtkContainer

127

+----GtkBin

128

+----GtkEventBox

129

+----PanelApplet

130

</pre>

131

</div>

132

133

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

134

<p>

135

PanelApplet implements

136

AtkImplementorIface and GtkBuildable.</p>

137

</div>

138

139

<a name="PanelApplet.signals"></a><h2>Signals</h2>

140

141

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

142

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

143

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

144

"<a class="link" href="PanelApplet.html#PanelApplet-move-focus-out-of-applet" title='The "move-focus-out-of-applet" signal'>move-focus-out-of-applet</a>" : Run Last / Action

145

</pre>

146

</div>

147

148

<a name="PanelApplet.description"></a><h2>Description</h2>

149

<p>

150

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

151

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

152

turn, should contain all widgets exposed by the applet.

153

</p>

154

<p>

155

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

156

the cross process UI emmbedding required by applets possible.

157

</p>

158

</div>

159

160

<a name="PanelApplet.details"></a><h2>Details</h2>

161

162

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

163

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

164

<p>

165

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

166

</p>

167

</div>

168

<hr>

169

170

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

171

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

172

</pre>

173

<p>

174

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

175

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

176

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

177

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

178

</p>

179

</div>

180

<hr>

181

182

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

183

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

184

</pre>

185

<p>

186

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

187

</p>

188

</div>

189

<hr>

190

191

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

192

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

193

</pre>

194

<p>

195

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

196

</p>

197

</div>

198

<hr>

199

200

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

201

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

202

</pre>

203

<p>

204

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

205

</p>

206

</div>

207

<hr>

208

209

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

210

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

211

</pre>

212

<p>

213

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

214

</p>

215

</div>

216

<hr>

217

218

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

219

<pre class="programlisting">typedef enum {

220

PANEL_NO_BACKGROUND,

221

PANEL_COLOR_BACKGROUND,

222

PANEL_PIXMAP_BACKGROUND

223

} PanelAppletBackgroundType;

224

</pre>

225

<p>

226

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

227

background of a panel.

228

</p>

229

230

231

<tbody>

232

<tr>

233

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

234

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

235

</td>

236

</tr>

237

<tr>

238

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

239

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

240

background.

241

</td>

242

</tr>

243

<tr>

244

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

245

<td> The panel has either an image background

246

or is translucent.

247

</td>

248

</tr>

249

</tbody>

250

</table></div>

251

</div>

252

<hr>

253

254

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

255

<pre class="programlisting">typedef enum {

256

PANEL_APPLET_FLAGS_NONE = 0,

257

PANEL_APPLET_EXPAND_MAJOR = 1 << 0,

258

PANEL_APPLET_EXPAND_MINOR = 1 << 1,

259

PANEL_APPLET_HAS_HANDLE = 1 << 2

260

} PanelAppletFlags;

261

</pre>

262

<p>

263

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

264

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

265

</p>

266

267

268

<tbody>

269

<tr>

270

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

271

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

272

</td>

273

</tr>

274

<tr>

275

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

276

<td>The applet should expand horizontally on an

277

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

278

of the Window List applet.

279

</td>

280

</tr>

281

<tr>

282

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

283

<td>The applet should expand vertically on an

284

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

285

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

286

to be Fitt's Law compliant.

287

</td>

288

</tr>

289

<tr>

290

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

291

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

292

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

293

flag.

294

</td>

295

</tr>

296

</tbody>

297

</table></div>

298

</div>

299

<hr>

300

301

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

302

<pre class="programlisting"><span class="returnvalue">gboolean</span> (*PanelAppletFactoryCallback) (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

303

const <span class="returnvalue">gchar</span> *iid,

304

<span class="returnvalue">gpointer</span> user_data);</pre>

305

<p>

306

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

307

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

308

widgets which make up the applet.

309

</p>

310

<p>

311

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

312

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

313

and initialized.

314

</p>

315

316

317

<tbody>

318

<tr>

319

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

320

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

321

</td>

322

</tr>

323

<tr>

324

325

<td>The Bonobo IID of the applet requested.

326

</td>

327

</tr>

328

<tr>

329

330

<td>The data passed to the factory macros.

331

</td>

332

</tr>

333

<tr>

334

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

335

<td>

336

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

337

</td>

338

</tr>

339

</tbody>

340

</table></div>

341

</div>

342

<hr>

343

344

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

345

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

346

<p>

347

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

348

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

349

is invoked.

350

</p>

351

352

353

354

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

355

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

356

</td>

357

</tr></tbody>

358

</table></div>

359

</div>

360

<hr>

361

362

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

363

<pre class="programlisting"><a class="link" href="PanelApplet.html#PanelAppletOrient" title="PanelAppletOrient"><span class="returnvalue">PanelAppletOrient</span></a> panel_applet_get_orient (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>

364

<p>

365

Get the current orientation of the applet.

366

</p>

367

368

369

<tbody>

370

<tr>

371

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

372

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

373

</td>

374

</tr>

375

<tr>

376

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

377

<td>The orientation of the applet.

378

</td>

379

</tr>

380

</tbody>

381

</table></div>

382

</div>

383

<hr>

384

385

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

386

<pre class="programlisting"><span class="returnvalue">guint</span> panel_applet_get_size (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>

387

<p>

388

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

389

not useful for most applets.

390

</p>

391

<p>

392

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

393

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

394

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

395

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

396

</p>

397

398

399

<tbody>

400

<tr>

401

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

402

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

403

</td>

404

</tr>

405

<tr>

406

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

407

<td>The panel's size hint.

408

</td>

409

</tr>

410

</tbody>

411

</table></div>

412

</div>

413

<hr>

414

415

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

416

<pre class="programlisting"><a class="link" href="PanelApplet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="returnvalue">PanelAppletBackgroundType</span></a> panel_applet_get_background (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

417

<span class="returnvalue">GdkColor</span> *color,

418

<span class="returnvalue">GdkPixmap</span> **pixmap);</pre>

419

<p>

420

Returns the current background type. If the background

421

type is <a class="link" href="PanelApplet.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

422

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

423

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

424

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

425

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

426

portion of the panel's background pixmap.

427

</p>

428

429

430

<tbody>

431

<tr>

432

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

433

<td>A <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

434

</td>

435

</tr>

436

<tr>

437

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

438

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

439

</td>

440

</tr>

441

<tr>

442

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

443

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

444

</td>

445

</tr>

446

<tr>

447

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

448

<td>The background type.

449

</td>

450

</tr>

451

</tbody>

452

</table></div>

453

</div>

454

<hr>

455

456

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

457

<pre class="programlisting"><span class="returnvalue">gchar</span> * panel_applet_get_preferences_key (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>

458

<p>

459

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

460

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

461

full path for the applet's preference keys. See

462

<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

463

more information.

464

</p>

465

466

467

<tbody>

468

<tr>

469

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

470

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

471

</td>

472

</tr>

473

<tr>

474

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

475

<td>A GConf path.

476

</td>

477

</tr>

478

</tbody>

479

</table></div>

480

</div>

481

<hr>

482

483

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

484

<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_add_preferences (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

485

const <span class="returnvalue">gchar</span> *schema_dir,

486

<span class="returnvalue">GError</span> **opt_error);</pre>

487

<p>

488

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

489

preferences directory (i.e. the directory returned by

490

<a class="link" href="PanelApplet.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

491

should have an associated schema to ensure that the key has

492

a defined type, sane default and documentation.

493

</p>

494

<p>

495

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

496

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

497

</p>

498

499

500

<tbody>

501

<tr>

502

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

503

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

504

</td>

505

</tr>

506

<tr>

507

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

508

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

509

e.g. /schemas/apps/my_applet

510

</td>

511

</tr>

512

<tr>

513

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

514

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

515

</td>

516

</tr>

517

</tbody>

518

</table></div>

519

</div>

520

<hr>

521

522

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

523

<pre class="programlisting"><a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a> panel_applet_get_flags (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>

524

<p>

525

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

526

</p>

527

528

529

<tbody>

530

<tr>

531

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

532

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

533

</td>

534

</tr>

535

<tr>

536

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

537

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

538

</td>

539

</tr>

540

</tbody>

541

</table></div>

542

</div>

543

<hr>

544

545

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

546

<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_set_flags (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

547

<a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a> flags);</pre>

548

<p>

549

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

550

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

551

these flags.

552

</p>

553

554

555

<tbody>

556

<tr>

557

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

558

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

559

</td>

560

</tr>

561

<tr>

562

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

563

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

564

</td>

565

</tr>

566

</tbody>

567

</table></div>

568

</div>

569

<hr>

570

571

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

572

<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_set_size_hints (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

573

const <span class="returnvalue">int</span> *size_hints,

574

<span class="returnvalue">int</span> n_elements,

575

576

<p>

577

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

578

<a class="link" href="PanelApplet.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

579

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

580

</p>

581

<p>

582

The panel will endeavour to allocate the applet a size

583

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

584

</p>

585

586

587

<tbody>

588

<tr>

589

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

590

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

591

</td>

592

</tr>

593

<tr>

594

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

595

<td>Array of size_hints.

596

</td>

597

</tr>

598

<tr>

599

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

600

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

601

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

602

</td>

603

</tr>

604

<tr>

605

606

<td>The base size of the applet.

607

</td>

608

</tr>

609

</tbody>

610

</table></div>

611

</div>

612

<hr>

613

614

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

615

<pre class="programlisting"><span class="returnvalue">gboolean</span> panel_applet_get_locked_down (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>

616

<p>

617

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.

618

</p>

619

620

621

<tbody>

622

<tr>

623

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

624

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

625

</td>

626

</tr>

627

<tr>

628

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

629

<td>

630

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

631

</td>

632

</tr>

633

</tbody>

634

</table></div>

635

</div>

636

<hr>

637

638

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

639

<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_request_focus (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

640

<span class="returnvalue">guint32</span> timestamp);</pre>

641

<p>

642

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

643

</p>

644

645

646

<tbody>

647

<tr>

648

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

649

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

650

</td>

651

</tr>

652

<tr>

653

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

654

<td>timestamp of the event triggering the window focus

655

</td>

656

</tr>

657

</tbody>

658

</table></div>

659

</div>

660

<hr>

661

662

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

663

<pre class="programlisting"><span class="returnvalue">BonoboControl</span> * panel_applet_get_control (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>

664

<p>

665

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

666

</p>

667

668

669

<tbody>

670

<tr>

671

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

672

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

673

</td>

674

</tr>

675

<tr>

676

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

677

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

678

</td>

679

</tr>

680

</tbody>

681

</table></div>

682

</div>

683

<hr>

684

685

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

686

<pre class="programlisting"><span class="returnvalue">BonoboUIComponent</span> * panel_applet_get_popup_component (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>

687

<p>

688

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

689

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

690

</p>

691

692

693

<tbody>

694

<tr>

695

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

696

<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

697

</td>

698

</tr>

699

<tr>

700

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

701

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

702

</td>

703

</tr>

704

</tbody>

705

</table></div>

706

</div>

707

<hr>

708

709

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

710

<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_setup_menu (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

711

const <span class="returnvalue">gchar</span> *xml,

712

const <span class="returnvalue">BonoboUIVerb</span> *verb_list,

713

<span class="returnvalue">gpointer</span> user_data);</pre>

714

<p>

715

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

716

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

717

for a description of the format of the xml.

718

</p>

719

720

721

<tbody>

722

<tr>

723

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

724

<td>A <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

725

</td>

726

</tr>

727

<tr>

728

729

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

730

</td>

731

</tr>

732

<tr>

733

734

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

735

</td>

736

</tr>

737

<tr>

738

739

<td>The user data pointer for the menu.

740

</td>

741

</tr>

742

</tbody>

743

</table></div>

744

</div>

745

<hr>

746

747

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

748

<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_setup_menu_from_file (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,

749

const <span class="returnvalue">gchar</span> *opt_datadir,

750

const <span class="returnvalue">gchar</span> *file,

751

const <span class="returnvalue">gchar</span> *opt_app_name,

752

const <span class="returnvalue">BonoboUIVerb</span> *verb_list,

753

<span class="returnvalue">gpointer</span> user_data);</pre>

754

<p>

755

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

756

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

757

the format of the xml.

758

</p>

759

760

761

<tbody>

762

<tr>

763

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

764

<td>A <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.

765

</td>

766

</tr>

767

<tr>

768

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

769

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

770

</td>

771

</tr>

772

<tr>

773

774

<td>The file's name.

775

</td>

776

</tr>

777

<tr>

778

779

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

780

</td>

781

</tr>

782

<tr>

783

784

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

785

</td>

786

</tr>

787

<tr>

788

789

<td>The user data pointer for the menu.

790

</td>

791

</tr>

792

</tbody>

793

</table></div>

794

</div>

795

<hr>

796

797

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

798

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

799

<span class="returnvalue">GType</span> applet_type,

800

<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="returnvalue">PanelAppletFactoryCallback</span></a> callback,

801

<span class="returnvalue">gpointer</span> data);</pre>

802

<p>

803

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

804

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

805

</p>

806

807

808

<tbody>

809

<tr>

810

811

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

812

</td>

813

</tr>

814

<tr>

815

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

816

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

817

</td>

818

</tr>

819

<tr>

820

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

821

<td>The factory callback.

822

</td>

823

</tr>

824

<tr>

825

826

<td>The factory user data pointer.

827

</td>

828

</tr>

829

<tr>

830

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

831

<td>0 on success, 1 on failure.

832

</td>

833

</tr>

834

</tbody>

835

</table></div>

836

</div>

837

<hr>

838

839

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

840

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

841

<span class="returnvalue">GType</span> applet_type,

842

<span class="returnvalue">GClosure</span> *closure);</pre>

843

<p>

844

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

845

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

846

</p>

847

848

849

<tbody>

850

<tr>

851

852

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

853

</td>

854

</tr>

855

<tr>

856

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

857

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

858

</td>

859

</tr>

860

<tr>

861

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

862

<td>The factory callback closure.

863

</td>

864

</tr>

865

<tr>

866

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

867

<td>0 on success, 1 on failure.

868

</td>

869

</tr>

870

</tbody>

871

</table></div>

872

</div>

873

<hr>

874

875

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

876

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

877

<p>

878

Defines a 'main' routine for the applet factory.

879

</p>

880

881

882

<tbody>

883

<tr>

884

885

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

886

</td>

887

</tr>

888

<tr>

889

890

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

891

</td>

892

</tr>

893

<tr>

894

895

<td>The applet ID string.

896

</td>

897

</tr>

898

<tr>

899

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

900

<td>The applet version string.

901

</td>

902

</tr>

903

<tr>

904

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

905

<td>The factory callback.

906

</td>

907

</tr>

908

<tr>

909

910

<td>The factory user data pointer.

911

</td>

912

</tr>

913

</tbody>

914

</table></div>

915

</div>

916

<hr>

917

918

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

919

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

920

<span class="returnvalue">GType</span> applet_type,

921

<span class="returnvalue">PortableServer_POA</span> poa,

922

<span class="returnvalue">gpointer</span> impl_ptr,

923

<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="returnvalue">PanelAppletFactoryCallback</span></a> callback,

924

<span class="returnvalue">gpointer</span> user_data,

925

<span class="returnvalue">CORBA_Environment</span> *ev);</pre>

926

<p>

927

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

928

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

929

</p>

930

931

932

<tbody>

933

<tr>

934

935

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

936

</td>

937

</tr>

938

<tr>

939

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

940

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

941

</td>

942

</tr>

943

<tr>

944

945

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

946

callback.

947

</td>

948

</tr>

949

<tr>

950

951

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

952

</td>

953

</tr>

954

<tr>

955

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

956

<td>The applet factory callback.

957

</td>

958

</tr>

959

<tr>

960

961

<td>The factory user data pointer.

962

</td>

963

</tr>

964

<tr>

965

966

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

967

</td>

968

</tr>

969

<tr>

970

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

971

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

972

callback.

973

</td>

974

</tr>

975

</tbody>

976

</table></div>

977

</div>

978

<hr>

979

980

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

981

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

982

<span class="returnvalue">GType</span> applet_type,

983

<span class="returnvalue">PortableServer_POA</span> poa,

984

<span class="returnvalue">gpointer</span> impl_ptr,

985

<span class="returnvalue">GClosure</span> *closure,

986

<span class="returnvalue">CORBA_Environment</span> *ev);</pre>

987

<p>

988

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

989

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

990

</p>

991

992

993

<tbody>

994

<tr>

995

996

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

997

</td>

998

</tr>

999

<tr>

1000

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

1001

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

1002

</td>

1003

</tr>

1004

<tr>

1005

1006

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

1007

callback.

1008

</td>

1009

</tr>

1010

<tr>

1011

1012

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

1013

</td>

1014

</tr>

1015

<tr>

1016

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

1017

<td>The applet factory closure.

1018

</td>

1019

</tr>

1020

<tr>

1021

1022

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

1023

</td>

1024

</tr>

1025

<tr>

1026

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

1027

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

1028

callback.

1029

</td>

1030

</tr>

1031

</tbody>

1032

</table></div>

1033

</div>

1034

<hr>

1035

1036

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

1037

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

1038

<p>

1039

Defines a Bonobo Activation shared library plugin and associated

1040

factory callback.

1041

</p>

1042

1043

1044

<tbody>

1045

<tr>

1046

1047

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

1048

</td>

1049

</tr>

1050

<tr>

1051

1052

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

1053

</td>

1054

</tr>

1055

<tr>

1056

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

1057

<td>A description of the applet.

1058

</td>

1059

</tr>

1060

<tr>

1061

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

1062

<td>The factory callback.

1063

</td>

1064

</tr>

1065

<tr>

1066

1067

<td>The factory user data pointer.

1068

</td>

1069

</tr>

1070

</tbody>

1071

</table></div>

1072

</div>

1073

</div>

1074

1075

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

1076

1077

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

1078

<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> *panelapplet,

1079

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

1080

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

1081

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

1082

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

1083

<p>

1084

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

1085

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

1086

</p>

1087

1088

1089

<tbody>

1090

<tr>

1091

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

1092

<td>The object which received the signal.

1093

</td>

1094

</tr>

1095

<tr>

1096

1097

<td>

1098

</td>

1099

</tr>

1100

<tr>

1101

1102

<td>

1103

</td>

1104

</tr>

1105

<tr>

1106

1107

<td>

1108

</td>

1109

</tr>

1110

<tr>

1111

1112

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

1113

</tr>

1114

</tbody>

1115

</table></div>

1116

</div>

1117

<hr>

1118

1119

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

1120

<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> *panelapplet,

1121

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

1122

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

1123

<p>

1124

Emitted when the orientation of the panel changes.

1125

</p>

1126

1127

1128

<tbody>

1129

<tr>

1130

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

1131

<td>The object which received the signal.

1132

</td>

1133

</tr>

1134

<tr>

1135

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

1136

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

1137

</td>

1138

</tr>

1139

<tr>

1140

1141

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

1142

</tr>

1143

</tbody>

1144

</table></div>

1145

</div>

1146

<hr>

1147

1148

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

1149

<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> *panelapplet,

1150

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

1151

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

1152

<p>

1153

Emitted when the size of the panel changes.

1154

</p>

1155

<p>

1156

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

1157

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

1158

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

1159

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

1160

</p>

1161

1162

1163

<tbody>

1164

<tr>

1165

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

1166

<td>The object which received the signal.

1167

</td>

1168

</tr>

1169

<tr>

1170

1171

<td>The size hint of the panel.

1172

</td>

1173

</tr>

1174

<tr>

1175

1176

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

1177

</tr>

1178

</tbody>

1179

</table></div>

1180

</div>

1181

<hr>

1182

1183

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

1184

<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> *panelapplet,

1185

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

1186

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

1187

<p>

1188

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

1189

</p>

1190

1191

1192

<tbody>

1193

<tr>

1194

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

1195

<td>The object which received the signal.

1196

</td>

1197

</tr>

1198

<tr>

1199

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

1200

<td>The direction of focus movement.

1201

</td>

1202

</tr>

1203

<tr>

1204

1205

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

1206

</tr>

1207

</tbody>

1208

</table></div>

1209

</div>

1210

</div>

1211

</div>

1212

1213

<hr>

1214

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

1215

</body>

1216

</html>

b'\\ No newline at end of file'