cvs: php-gtk-doc /manual/en/reference/gtk gtkaboutdialog.xml gtkaction.xml

auroraeosrose Mon Oct 16 16:23:40 2006 UTC Modified files: /php-gtk-doc/manual/en/reference/gtk gtkaboutdialog.xml gtkaction.xml Log: Finished GtkAction and uncommented information about url/email hooks in about dialog docs (both work now) http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/en/reference/gtk/gtkaboutdialog.xml?r1=1.13&r2=1.14&diff_format=u Index: php-gtk-doc/manual/en/reference/gtk/gtkaboutdialog.xml diff -u php-gtk-doc/manual/en/reference/gtk/gtkaboutdialog.xml:1.13 php-gtk-doc/manual/en/reference/gtk/gtkaboutdialog.xml:1.14 --- php-gtk-doc/manual/en/reference/gtk/gtkaboutdialog.xml:1.13 Tue Oct 10 06:44:36 2006 +++ php-gtk-doc/manual/en/reference/gtk/gtkaboutdialog.xml Mon Oct 16 16:23:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.13 $ --> +<!-- $Revision: 1.14 $ --> <classentry id="gtk.gtkaboutdialog"> <classmeta> <classtitle>GtkAboutDialog</classtitle> @@ -18,16 +18,16 @@ selects the <literal>About</literal> option from the Help menu. All parts of the dialog are optional. </para> -<!-- <para> - About dialog often contain links and email addresses. GtkAboutDialog - supports this by offering global hooks, which are called when the - user clicks on a link or email address, see gtk_about_dialog_set_email_hook() - and gtk_about_dialog_set_url_hook(). Email addresses in the authors, - documenters and artists properties are recognized by looking for - <user@host>, URLs are recognized by looking for http://url, - with url extending to the next space, tab or line break. + <para> + About dialog often contain links and email addresses. + <classname>GtkAboutDialog </classname> supports this by offering global + hooks, which are called when the user clicks on a link or email address, see + <function class="GtkAboutDialog">set_email_hook</function> and <function + class="GtkAboutDialog">set_url_hook</function>. Email addresses in the + authors, documenters and artists properties are recognized by looking for + &lt;user@host&gt;, URLs are recognized by looking for http://url, with url + extending to the next space, tab or line break. </para> ---> </desc> </classmeta> @@ -374,9 +374,6 @@ hooks have been set with <function class="GtkAboutDialog">set_email_hook</function> or <function class="GtkAboutDialog">set_url_hook</function> </simpara> - <simpara> - As of writing, the url and email hooks are not currently implemented. - </simpara> <para> &seealso; <function class="GtkAboutDialog">get_authors</function> http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/en/reference/gtk/gtkaction.xml?r1=1.9&r2=1.10&diff_format=u Index: php-gtk-doc/manual/en/reference/gtk/gtkaction.xml diff -u php-gtk-doc/manual/en/reference/gtk/gtkaction.xml:1.9 php-gtk-doc/manual/en/reference/gtk/gtkaction.xml:1.10 --- php-gtk-doc/manual/en/reference/gtk/gtkaction.xml:1.9 Tue Oct 10 06:44:36 2006 +++ php-gtk-doc/manual/en/reference/gtk/gtkaction.xml Mon Oct 16 16:23:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <classentry id="gtk.gtkaction"> <classmeta> <classtitle>GtkAction</classtitle> @@ -143,7 +143,7 @@ </para> <para> Please ensure that you have set the accelerator's path and group before - using this method. Doing so otherwise nullifies the effect of this method + using this method. Not doing so nullifies the effect of this method </para> <para> &seealso; @@ -324,12 +324,10 @@ <para> This method takes an action object as its parameter and returns the name associated to that action. - </para> + </para> </desc> </method> - - <method id="gtk.gtkaction.method.get_sensitive"> <funcsynopsis> <funcprototype> @@ -338,10 +336,16 @@ </funcprototype> </funcsynopsis> <shortdesc> - FIXME + Returns current sensitive state </shortdesc> <desc> <para> + This method returns <literal>true</literal> if the action itself is + sensitive. Note that this doesn't necessarily mean effective sensitivity. + See the <function class="GtkAction">is_sensitive</function> method for more + information. + </para> + <para> &seealso; <function class="GtkAction">is_sensitive</function>, <function class="GtkAction">set_sensitive</function> @@ -358,10 +362,15 @@ </funcprototype> </funcsynopsis> <shortdesc> - FIXME + Returns current state of visibility </shortdesc> <desc> <para> + This method returns the current visibility state of the action. Note that + this doesn't necessarily mean effective visibility. See the <function + class="GtkAction">is_visible</function> method for more information. + </para> + <para> &seealso; <function class="GtkAction">is_visible</function>, <function class="GtkAction">set_visible</function> @@ -378,10 +387,15 @@ </funcprototype> </funcsynopsis> <shortdesc> - FIXME + Identifies if action is currently sensitive </shortdesc> <desc> <para> + This method returns <literal>True</literal> if the action is effectively + sensitive i.e. both the <classname>GtkAction</classname> and its + associated <classname>GtkActionGroup</classname> are sensitive. + </para> + <para> &seealso; <function class="GtkAction">get_sensitive</function>, <function class="GtkAction">set_sensitive</function> @@ -398,10 +412,15 @@ </funcprototype> </funcsynopsis> <shortdesc> - FIXME + Identifies if action is currently visible </shortdesc> <desc> <para> + This method returns <literal>True</literal> if the action is effectively + visible i.e. both the <classname>GtkAction</classname> and its associated + <classname>GtkActionGroup</classname> are visible. + </para> + <para> &seealso; <function class="GtkAction">get_visible</function>, <function class="GtkAction">set_visible</function> @@ -422,7 +441,11 @@ this action will be installed. </shortdesc> <desc> - + <para> + This method sets the <classname>GtkAccelGroup</classname> as the + accelerator group for the <classname>GtkAction</classname>. Any + accelerators will be installed in the specified GtkAccelGroup. + </para> </desc> </method> @@ -457,10 +480,15 @@ </funcprototype> </funcsynopsis> <shortdesc> - FIXME + Sets sensitive state for the action </shortdesc> <desc> <para> + This method sets the sensitive state of the action. Note that this doesn't + necessarily set the effective sensitivity. See the <function + class="GtkAction">is_sensitive</function> method for more information. + </para> + <para> &seealso; <function class="GtkAction">get_sensitive</function>, <function class="GtkAction">is_sensitive</function> @@ -477,10 +505,15 @@ </funcprototype> </funcsynopsis> <shortdesc> - FIXME + Sets visible state for the action </shortdesc> <desc> <para> + This method sets the visible state of the action. Note that this doesn't + necessarily set the effective visibility. See the <function + class="GtkAction">is_visible</function> method for more information. + </para> + <para> &seealso; <function class="GtkAction">get_visible</function>, <function class="GtkAction">is_visible</function> @@ -533,6 +566,12 @@ Emitted when the action is triggered (or activated!) </shortdesc> <desc> + <para> + This is emitted when the <literal>action</literal> is triggered or + activated by a proxied widget or manually using <function + class="GtkAction">activate</function>. The callback is passed one + parameter, the <classname>GtkAction</classname> widget. + </para> </desc> </signal>