GNOME.org
 

[gnome-panel/wip/segeiger/reference-documentation] Some more changes

commit 4efef479ea2988d7b68ab39e5d30cc36064f6225
Author: Sebastian Geiger <sbastig gmx net>
Date:   Mon Aug 31 12:39:46 2015 +0200

    Some more changes

 doc/reference/panel-applet/panel-applet-docs.sgml |   52 +++++++++++++++++----
 1 files changed, 43 insertions(+), 9 deletions(-)
---
diff --git a/doc/reference/panel-applet/panel-applet-docs.sgml 
b/doc/reference/panel-applet/panel-applet-docs.sgml
index 4310d61..face04c 100644
--- a/doc/reference/panel-applet/panel-applet-docs.sgml
+++ b/doc/reference/panel-applet/panel-applet-docs.sgml
@@ -821,7 +821,13 @@ AC_SUBST(LIBPANEL_APPLET_DIR)
      </para>
 
      <para>
-      In some rare cases, though, <link 
linkend="panel-applet-set-background-widget"><function>panel_applet_set_background_widget()</function></link> 
will not be enough. The solution is then to connect to the <link 
linkend="PanelApplet-change-background"><function>"change-background"</function></link> signal of the <link 
linkend="PanelApplet"><type>PanelApplet</type></link> object: it will be emitted when the background has 
changed, and it will provide the <type>cairo_pattern_t</type> pattern to use as a basis to draw the 
background.
+      In some rare cases, though,
+      <link linkend="panel-applet-set-background-widget">
+          <function>panel_applet_set_background_widget()</function>
+      </link> will not be enough. The solution is then to connect to the
+      <link linkend="PanelApplet-change-background"><function>"change-background"</function></link> signal 
of the
+      <link linkend="PanelApplet"><type>PanelApplet</type></link> object: it will be emitted when the 
background has
+      changed, and it will provide the <type>cairo_pattern_t</type> pattern to use as a basis to draw the 
background.
      </para>
 
     </sect2>
@@ -830,15 +836,24 @@ AC_SUBST(LIBPANEL_APPLET_DIR)
      <title>Panel Lockdown</title>
 
      <para>
-      The panel has proper support for lockdown, and when it is locked down, it is expected that all applets 
behave consistently in a lockdown mode too. This generally means that the preferences of the applet should 
not be accessible, but it could also imply a restriction on the behavior of the applet.
+      The panel has proper support for lockdown, and when it is locked down, it is expected that all applets 
behave
+      consistently in a lockdown mode too. This generally means that the preferences of the applet should 
not be
+      accessible, but it could also imply a restriction on the behavior of the applet.
      </para>
 
      <para>
-      The <link 
linkend="panel-applet-get-locked-down"><function>panel_applet_get_locked_down()</function></link> function 
can be used to query the state of the panel lockdown. It is also possible to react to changes by monitoring 
the <link linkend="PanelApplet--locked-down"><function>"locked-down"</function></link> property of the <link 
linkend="PanelApplet"><type>PanelApplet</type></link> object. You can achieve this by connecting to the 
<function>"notify::locked-down"</function> event.
+      The <link 
linkend="panel-applet-get-locked-down"><function>panel_applet_get_locked_down()</function></link>
+      function can be used to query the state of the panel lockdown. It is also possible to react to changes 
by
+      monitoring the <link linkend="PanelApplet--locked-down"><function>"locked-down"</function></link>
+      property of the <link linkend="PanelApplet"><type>PanelApplet</type></link> object. You can achieve 
this
+      by connecting to the <function>"notify::locked-down"</function> event.
      </para>
 
      <para>
-       In most cases, the <type>GBinding</type> API is enough to respect the panel lockdown: 
<function>g_object_bind_property()</function> can be used to automatically update the visiblity of a menu 
item in the context menu of the applet. In the following example, the <function>"HelloWorldPrefs"</function> 
action (which is an action from the context menu) will only be displayed if the panel is not locked down.
+       In most cases, the <type>GBinding</type> API is enough to respect the panel lockdown:
+       <function>g_object_bind_property()</function> can be used to automatically update the visiblity of a 
menu
+       item in the context menu of the applet. In the following example, the 
<function>"HelloWorldPrefs"</function>
+       action (which is an action from the context menu) will only be displayed if the panel is not locked 
down.
 
       <informalexample>
        <programlisting language="c">
@@ -850,7 +865,8 @@ g_object_bind_property (applet, "locked-down",
       </informalexample>
 
       <para>
-       It is obviously possible to use <function>g_object_bind_property()</function> to change the 
visibility of widgets that appear outside of the context menu, like a button in a window.
+       Of course it is also possible to use <function>g_object_bind_property()</function> to change the 
visibility of
+       widgets that appear outside of the context menu, like a button in a window.
       </para>
 
      </para>
@@ -863,11 +879,24 @@ g_object_bind_property (applet, "locked-down",
     <title>Out-of-Process vs In-Process</title>
 
     <para>
-     Applets can either live in their own process ("out-of-process") or in the panel process ("in-process"). 
The decision to choose one or the other is done at build time, with the macro that you use to define the 
applet factory: <link 
linkend="PANEL-APPLET-OUT-PROCESS-FACTORY:CAPS"><function>PANEL_APPLET_OUT_PROCESS_FACTORY()</function></link>
 is used for out-of-process applets while <link 
linkend="PANEL-APPLET-IN-PROCESS-FACTORY:CAPS"><function>PANEL_APPLET_IN_PROCESS_FACTORY()</function></link> 
is used for in-process applets. Obviously, only one of those two macros can be used.
+     Applets can either live in their own process ("out-of-process") or in the panel process ("in-process").
+     The decision to choose one or the other is done at build time, with the macro that you use to define 
the applet
+     factory:
+     <link linkend="PANEL-APPLET-OUT-PROCESS-FACTORY:CAPS">
+         <function>PANEL_APPLET_OUT_PROCESS_FACTORY()</function>
+     </link>
+     is used for out-of-process applets while
+     <link linkend="PANEL-APPLET-IN-PROCESS-FACTORY:CAPS">
+         <function>PANEL_APPLET_IN_PROCESS_FACTORY()</function>
+     </link> is used for in-process applets. Obviously, only one of those two macros can be used.
     </para>
 
     <para>
-      For most practical matters, from the applet perspective, the two options are the same. In-process 
applets do offer a slightly better performance when the applet is loaded, but this should not affect much the 
user experience. However, an in-process applet can potentially affect the whole behavior of the panel, 
especially in case of crashes or memory corruptions: a crash in an in-process applet will crash the whole 
panel. It is therefore recommended to use out-of-process applets.
+      For most practical matters, from the applet perspective, the two options are the same.
+      In-process applets do offer a slightly better performance when the applet is loaded, but this should 
not affect
+      much the user experience. However, an in-process applet can potentially affect the whole behavior of 
the panel,
+      especially in case of crashes or memory corruptions: a crash in an in-process applet will crash the 
whole panel.
+      It is therefore recommended to use out-of-process applets.
     </para>
    </chapter>
 
@@ -875,7 +904,10 @@ g_object_bind_property (applet, "locked-down",
     <title>Writing an applet in languages other than C</title>
 
     <para>
-     The Panel Applet library comes with support for <ulink 
url="http://live.gnome.org/GObjectIntrospection";>GObject Introspection</ulink>. This makes it possible to 
write applets in the languages that have <ulink 
url="http://live.gnome.org/GObjectIntrospection/Users";>bindings based on GObject Introspection</ulink>.
+     The Panel Applet library comes with support for
+     <ulink url="http://live.gnome.org/GObjectIntrospection";>GObject Introspection</ulink>.
+     This makes it possible to write applets in the languages that have
+     <ulink url="http://live.gnome.org/GObjectIntrospection/Users";>bindings based on GObject 
Introspection</ulink>.
     </para>
 
     <para>
@@ -908,7 +940,9 @@ PanelApplet.Applet.factory_main("HelloWorldFactory",
     </para>
 
     <para>
-     The only limitation of writing an applet in a language other than C is that the applet will not be able 
to run in the panel process: it will have to stay out-of-process. However, since it is recommended to leave 
applets out-of-process, this limitation is mitigated.
+     The only limitation of writing an applet in a language other than C is that the applet will
+     not be able to run in the panel process: it will have to stay out-of-process. However, since
+     it is recommended to leave applets out-of-process, this limitation is mitigated.
     </para>
    </chapter>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]