/usr/share/gtk-doc/html/meta/MetaPlugin.html is in libmutter-dev 3.10.4-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Mutter Reference Manual: MetaPlugin</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Mutter Reference Manual">
<link rel="up" href="core-reference.html" title="Part III. Mutter Core Reference">
<link rel="prev" href="meta-Errors.html" title="Errors">
<link rel="next" href="MetaBarrier.html" title="MetaBarrier">
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#MetaPlugin.description" class="shortcut">Description</a>
|
<a href="#MetaPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#MetaPlugin.properties" class="shortcut">Properties</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="meta-Errors.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="MetaBarrier.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="MetaPlugin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MetaPlugin.top_of_page"></a>MetaPlugin</span></h2>
<p>MetaPlugin — Entry point for plugins</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MetaPlugin.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="MetaPlugin.html#MetaPlugin-struct" title="struct MetaPlugin">MetaPlugin</a>;
struct <a class="link" href="MetaPlugin.html#MetaPluginClass" title="struct MetaPluginClass">MetaPluginClass</a>;
struct <a class="link" href="MetaPlugin.html#MetaPluginInfo" title="struct MetaPluginInfo">MetaPluginInfo</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="MetaPlugin.html#meta-plugin-running" title="meta_plugin_running ()">meta_plugin_running</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="MetaPlugin.html#meta-plugin-debug-mode" title="meta_plugin_debug_mode ()">meta_plugin_debug_mode</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);
const <a class="link" href="MetaPlugin.html#MetaPluginInfo" title="struct MetaPluginInfo"><span class="returnvalue">MetaPluginInfo</span></a> * <a class="link" href="MetaPlugin.html#meta-plugin-get-info" title="meta_plugin_get_info ()">meta_plugin_get_info</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);
struct <a class="link" href="MetaPlugin.html#MetaPluginVersion" title="struct MetaPluginVersion">MetaPluginVersion</a>;
#define <a class="link" href="MetaPlugin.html#META-PLUGIN-DECLARE:CAPS" title="META_PLUGIN_DECLARE()">META_PLUGIN_DECLARE</a> (ObjectName,
object_name)
<span class="returnvalue">void</span> <a class="link" href="MetaPlugin.html#meta-plugin-switch-workspace-completed" title="meta_plugin_switch_workspace_completed ()">meta_plugin_switch_workspace_completed</a>
(<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaPlugin.html#meta-plugin-minimize-completed" title="meta_plugin_minimize_completed ()">meta_plugin_minimize_completed</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaPlugin.html#meta-plugin-maximize-completed" title="meta_plugin_maximize_completed ()">meta_plugin_maximize_completed</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaPlugin.html#meta-plugin-unmaximize-completed" title="meta_plugin_unmaximize_completed ()">meta_plugin_unmaximize_completed</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaPlugin.html#meta-plugin-map-completed" title="meta_plugin_map_completed ()">meta_plugin_map_completed</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaPlugin.html#meta-plugin-destroy-completed" title="meta_plugin_destroy_completed ()">meta_plugin_destroy_completed</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);
enum <a class="link" href="MetaPlugin.html#MetaModalOptions" title="enum MetaModalOptions">MetaModalOptions</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="MetaPlugin.html#meta-plugin-begin-modal" title="meta_plugin_begin_modal ()">meta_plugin_begin_modal</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaPlugin.html#MetaModalOptions" title="enum MetaModalOptions"><span class="type">MetaModalOptions</span></a> options</code></em>,
<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaPlugin.html#meta-plugin-end-modal" title="meta_plugin_end_modal ()">meta_plugin_end_modal</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
<a class="link" href="MetaScreen.html" title="MetaScreen"><span class="returnvalue">MetaScreen</span></a> * <a class="link" href="MetaPlugin.html#meta-plugin-get-screen" title="meta_plugin_get_screen ()">meta_plugin_get_screen</a> (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaPlugin.html#meta-plugin-manager-set-plugin-type" title="meta_plugin_manager_set_plugin_type ()">meta_plugin_manager_set_plugin_type</a> (<em class="parameter"><code><span class="type">GType</span> gtype</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="MetaPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----MetaPlugin
</pre>
</div>
<div class="refsect1">
<a name="MetaPlugin.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="MetaPlugin.html#MetaPlugin--debug-mode" title='The "debug-mode" property'>debug-mode</a>" <span class="type">gboolean</span> : Read
"<a class="link" href="MetaPlugin.html#MetaPlugin--screen" title='The "screen" property'>screen</a>" <a class="link" href="MetaScreen.html" title="MetaScreen"><span class="type">MetaScreen</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="MetaPlugin.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="MetaPlugin.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MetaPlugin-struct"></a><h3>struct MetaPlugin</h3>
<pre class="programlisting">struct MetaPlugin;</pre>
</div>
<hr>
<div class="refsect2">
<a name="MetaPluginClass"></a><h3>struct MetaPluginClass</h3>
<pre class="programlisting">struct MetaPluginClass {
/**
* MetaPluginClass::start:
*
* Virtual function called when the compositor starts managing a screen
*/
void (*start) (MetaPlugin *plugin);
/**
* MetaPluginClass::minimize:
* @actor: a #MetaWindowActor
*
* Virtual function called when the window represented by @actor is minimized.
*/
void (*minimize) (MetaPlugin *plugin,
MetaWindowActor *actor);
/**
* MetaPluginClass::maximize:
* @actor: a #MetaWindowActor
* @x: target X coordinate
* @y: target Y coordinate
* @width: target width
* @height: target height
*
* Virtual function called when the window represented by @actor is maximized.
*/
void (*maximize) (MetaPlugin *plugin,
MetaWindowActor *actor,
gint x,
gint y,
gint width,
gint height);
/**
* MetaPluginClass::unmaximize:
* @actor: a #MetaWindowActor
* @x: target X coordinate
* @y: target Y coordinate
* @width: target width
* @height: target height
*
* Virtual function called when the window represented by @actor is unmaximized.
*/
void (*unmaximize) (MetaPlugin *plugin,
MetaWindowActor *actor,
gint x,
gint y,
gint width,
gint height);
/**
* MetaPluginClass::map:
* @actor: a #MetaWindowActor
*
* Virtual function called when the window represented by @actor is mapped.
*/
void (*map) (MetaPlugin *plugin,
MetaWindowActor *actor);
/**
* MetaPluginClass::destroy:
* @actor: a #MetaWindowActor
*
* Virtual function called when the window represented by @actor is destroyed.
*/
void (*destroy) (MetaPlugin *plugin,
MetaWindowActor *actor);
/**
* MetaPluginClass::switch_workspace:
* @from: origin workspace
* @to: destination workspace
* @direction: a #MetaMotionDirection
*
* Virtual function called when the window represented by @actor is destroyed.
*/
void (*switch_workspace) (MetaPlugin *plugin,
gint from,
gint to,
MetaMotionDirection direction);
/**
* MetaPluginClass::kill_window_effects:
* @actor: a #MetaWindowActor
*
* Virtual function called when the effects on @actor need to be killed
* prematurely; the plugin must call the completed() callback as if the effect
* terminated naturally.
*/
void (*kill_window_effects) (MetaPlugin *plugin,
MetaWindowActor *actor);
/**
* MetaPluginClass::kill_switch_workspace:
*
* Virtual function called when the workspace-switching effect needs to be
* killed prematurely.
*/
void (*kill_switch_workspace) (MetaPlugin *plugin);
/**
* MetaPluginClass::xevent_filter:
* @event: (type xlib.XEvent):
*
* Virtual function called when handling each event.
*
* Returns: %TRUE if the plugin handled the event type (i.e., if the return
* value is %FALSE, there will be no subsequent call to the manager
* completed() callback, and the compositor must ensure that any appropriate
* post-effect cleanup is carried out.
*/
gboolean (*xevent_filter) (MetaPlugin *plugin,
XEvent *event);
/**
* MetaPluginClass::keybinding_filter:
* @binding: a #MetaKeyBinding
*
* Virtual function called when handling each keybinding.
*
* Returns: %TRUE if the plugin handled the keybinding.
*/
gboolean (*keybinding_filter) (MetaPlugin *plugin,
MetaKeyBinding *binding);
/**
* MetaPluginClass::confirm_display_config:
* @plugin: a #MetaPlugin
*
* Virtual function called when the display configuration changes.
* The common way to implement this function is to show some form
* of modal dialog that should ask the user if everything was ok.
*
* When confirmed by the user, the plugin must call meta_plugin_complete_display_change()
* to make the configuration permanent. If that function is not
* called within the timeout, the previous configuration will be
* reapplied.
*/
void (*confirm_display_change) (MetaPlugin *plugin);
/**
* MetaPluginClass::plugin_info:
* @plugin: a #MetaPlugin
*
* Virtual function that returns information about the #MetaPlugin.
*
* Returns: a #MetaPluginInfo.
*/
const MetaPluginInfo * (*plugin_info) (MetaPlugin *plugin);
};
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.start"></a>start</code></em> ()</span></p></td>
<td>virtual function called when the compositor starts managing a screen</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.minimize"></a>minimize</code></em> ()</span></p></td>
<td>virtual function called when a window is minimized</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.maximize"></a>maximize</code></em> ()</span></p></td>
<td>virtual function called when a window is maximized</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.unmaximize"></a>unmaximize</code></em> ()</span></p></td>
<td>virtual function called when a window is unmaximized</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.map"></a>map</code></em> ()</span></p></td>
<td>virtual function called when a window is mapped</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.destroy"></a>destroy</code></em> ()</span></p></td>
<td>virtual function called when a window is destroyed</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.switch-workspace"></a>switch_workspace</code></em> ()</span></p></td>
<td>virtual function called when the user switches to another
workspace</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.kill-window-effects"></a>kill_window_effects</code></em> ()</span></p></td>
<td>virtual function called when the effects on a window
need to be killed prematurely; the plugin must call the <code class="function">completed()</code> callback
as if the effect terminated naturally</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.kill-switch-workspace"></a>kill_switch_workspace</code></em> ()</span></p></td>
<td>virtual function called when the workspace-switching
effect needs to be killed prematurely</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.xevent-filter"></a>xevent_filter</code></em> ()</span></p></td>
<td>virtual function called when handling each event</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.keybinding-filter"></a>keybinding_filter</code></em> ()</span></p></td>
<td>virtual function called when handling each keybinding</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.confirm-display-change"></a>confirm_display_change</code></em> ()</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="MetaPluginClass.plugin-info"></a>plugin_info</code></em> ()</span></p></td>
<td>virtual function that returns information about the
<a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="MetaPluginInfo"></a><h3>struct MetaPluginInfo</h3>
<pre class="programlisting">struct MetaPluginInfo {
const gchar *name;
const gchar *version;
const gchar *author;
const gchar *license;
const gchar *description;
};
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="MetaPluginInfo.name"></a>name</code></em>;</span></p></td>
<td>name of the plugin</td>
</tr>
<tr>
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="MetaPluginInfo.version"></a>version</code></em>;</span></p></td>
<td>version of the plugin</td>
</tr>
<tr>
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="MetaPluginInfo.author"></a>author</code></em>;</span></p></td>
<td>author of the plugin</td>
</tr>
<tr>
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="MetaPluginInfo.license"></a>license</code></em>;</span></p></td>
<td>license of the plugin</td>
</tr>
<tr>
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="MetaPluginInfo.description"></a>description</code></em>;</span></p></td>
<td>description of the plugin</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-running"></a><h3>meta_plugin_running ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> meta_plugin_running (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-debug-mode"></a><h3>meta_plugin_debug_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> meta_plugin_debug_mode (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-get-info"></a><h3>meta_plugin_get_info ()</h3>
<pre class="programlisting">const <a class="link" href="MetaPlugin.html#MetaPluginInfo" title="struct MetaPluginInfo"><span class="returnvalue">MetaPluginInfo</span></a> * meta_plugin_get_info (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="MetaPluginVersion"></a><h3>struct MetaPluginVersion</h3>
<pre class="programlisting">struct MetaPluginVersion {
/*
* Version information; the first three numbers match the Meta version
* with which the plugin was compiled (see clutter-plugins/simple.c for sample
* code).
*/
guint version_major;
guint version_minor;
guint version_micro;
/*
* Version of the plugin API; this is unrelated to the matacity version
* per se. The API version is checked by the plugin manager and must match
* the one used by it (see clutter-plugins/default.c for sample code).
*/
guint version_api;
};
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="MetaPluginVersion.version-major"></a>version_major</code></em>;</span></p></td>
<td>major component of the version number of Meta with which the plugin was compiled</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="MetaPluginVersion.version-minor"></a>version_minor</code></em>;</span></p></td>
<td>minor component of the version number of Meta with which the plugin was compiled</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="MetaPluginVersion.version-micro"></a>version_micro</code></em>;</span></p></td>
<td>micro component of the version number of Meta with which the plugin was compiled</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="MetaPluginVersion.version-api"></a>version_api</code></em>;</span></p></td>
<td>version of the plugin API</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="META-PLUGIN-DECLARE:CAPS"></a><h3>META_PLUGIN_DECLARE()</h3>
<pre class="programlisting">#define META_PLUGIN_DECLARE(ObjectName, object_name)</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-switch-workspace-completed"></a><h3>meta_plugin_switch_workspace_completed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_plugin_switch_workspace_completed
(<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-minimize-completed"></a><h3>meta_plugin_minimize_completed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_plugin_minimize_completed (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-maximize-completed"></a><h3>meta_plugin_maximize_completed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_plugin_maximize_completed (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-unmaximize-completed"></a><h3>meta_plugin_unmaximize_completed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_plugin_unmaximize_completed (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-map-completed"></a><h3>meta_plugin_map_completed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_plugin_map_completed (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-destroy-completed"></a><h3>meta_plugin_destroy_completed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_plugin_destroy_completed (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaWindowActor.html" title="MetaWindowActor"><span class="type">MetaWindowActor</span></a> *actor</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="MetaModalOptions"></a><h3>enum MetaModalOptions</h3>
<pre class="programlisting">typedef enum {
META_MODAL_POINTER_ALREADY_GRABBED = 1 << 0,
META_MODAL_KEYBOARD_ALREADY_GRABBED = 1 << 1
} MetaModalOptions;
</pre>
<p>
Options that can be provided when calling <a class="link" href="MetaPlugin.html#meta-plugin-begin-modal" title="meta_plugin_begin_modal ()"><code class="function">meta_plugin_begin_modal()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="META-MODAL-POINTER-ALREADY-GRABBED:CAPS"></a><span class="term"><code class="literal">META_MODAL_POINTER_ALREADY_GRABBED</code></span></p></td>
<td>if set the pointer is already
grabbed by the plugin and should not be grabbed again.
</td>
</tr>
<tr>
<td><p><a name="META-MODAL-KEYBOARD-ALREADY-GRABBED:CAPS"></a><span class="term"><code class="literal">META_MODAL_KEYBOARD_ALREADY_GRABBED</code></span></p></td>
<td>if set the keyboard is already
grabbed by the plugin and should not be grabbed again.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-begin-modal"></a><h3>meta_plugin_begin_modal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> meta_plugin_begin_modal (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="MetaPlugin.html#MetaModalOptions" title="enum MetaModalOptions"><span class="type">MetaModalOptions</span></a> options</code></em>,
<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
<p>
This function is used to grab the keyboard and mouse for the exclusive
use of the plugin. Correct operation requires that both the keyboard
and mouse are grabbed, or thing will break. (In particular, other
passive X grabs in Meta can trigger but not be handled by the normal
keybinding handling code.) However, the plugin can establish the keyboard
and/or mouse grabs ahead of time and pass in the
<a class="link" href="MetaPlugin.html#META-MODAL-POINTER-ALREADY-GRABBED:CAPS"><code class="literal">META_MODAL_POINTER_ALREADY_GRABBED</code></a> and/or <a class="link" href="MetaPlugin.html#META-MODAL-KEYBOARD-ALREADY-GRABBED:CAPS"><code class="literal">META_MODAL_KEYBOARD_ALREADY_GRABBED</code></a>
options. This facility is provided for two reasons: first to allow using
this function to establish modality after a passive grab, and second to
allow using obscure features of <code class="function">XGrabPointer()</code> and <code class="function">XGrabKeyboard()</code> without
having to add them to this API.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a <a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td>flags that modify the behavior of the modal grab</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>the timestamp used for establishing grabs</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether we successfully grabbed the keyboard and
mouse and made the plugin modal.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-end-modal"></a><h3>meta_plugin_end_modal ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_plugin_end_modal (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
<p>
Ends the modal operation begun with <a class="link" href="MetaPlugin.html#meta-plugin-begin-modal" title="meta_plugin_begin_modal ()"><code class="function">meta_plugin_begin_modal()</code></a>. This
ungrabs both the mouse and keyboard even when
<a class="link" href="MetaPlugin.html#META-MODAL-POINTER-ALREADY-GRABBED:CAPS"><code class="literal">META_MODAL_POINTER_ALREADY_GRABBED</code></a> or
<a class="link" href="MetaPlugin.html#META-MODAL-KEYBOARD-ALREADY-GRABBED:CAPS"><code class="literal">META_MODAL_KEYBOARD_ALREADY_GRABBED</code></a> were provided as options
when beginnning the modal operation.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a <a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>the time used for releasing grabs</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-get-screen"></a><h3>meta_plugin_get_screen ()</h3>
<pre class="programlisting"><a class="link" href="MetaScreen.html" title="MetaScreen"><span class="returnvalue">MetaScreen</span></a> * meta_plugin_get_screen (<em class="parameter"><code><a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a> *plugin</code></em>);</pre>
<p>
Gets the <a class="link" href="MetaScreen.html" title="MetaScreen"><span class="type">MetaScreen</span></a> corresponding to a plugin. Each plugin instance
is associated with exactly one screen; if Metacity is managing
multiple screens, multiple plugin instances will be created.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a <a class="link" href="MetaPlugin.html" title="MetaPlugin"><span class="type">MetaPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="MetaScreen.html" title="MetaScreen"><span class="type">MetaScreen</span></a> for the plugin. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-plugin-manager-set-plugin-type"></a><h3>meta_plugin_manager_set_plugin_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_plugin_manager_set_plugin_type (<em class="parameter"><code><span class="type">GType</span> gtype</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="MetaPlugin.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MetaPlugin--debug-mode"></a><h3>The <code class="literal">"debug-mode"</code> property</h3>
<pre class="programlisting"> "debug-mode" <span class="type">gboolean</span> : Read</pre>
<p>Debug Mode.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="MetaPlugin--screen"></a><h3>The <code class="literal">"screen"</code> property</h3>
<pre class="programlisting"> "screen" <a class="link" href="MetaScreen.html" title="MetaScreen"><span class="type">MetaScreen</span></a>* : Read / Write</pre>
<p>MetaScreen.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19.1</div>
</body>
</html>
|