diff options
Diffstat (limited to 'docs')
54 files changed, 96 insertions, 3412 deletions
diff --git a/docs/Makefile.in b/docs/Makefile.in index b153c02..6b38370 100644 --- a/docs/Makefile.in +++ b/docs/Makefile.in @@ -36,7 +36,12 @@ host_triplet = @host@ subdir = docs DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__aclocal_m4_deps = $(top_srcdir)/m4/gnome-doc-utils.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/intltool.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs diff --git a/docs/libdbusmenu-glib/Makefile.in b/docs/libdbusmenu-glib/Makefile.in index f1eaff3..8a2cffb 100644 --- a/docs/libdbusmenu-glib/Makefile.in +++ b/docs/libdbusmenu-glib/Makefile.in @@ -36,7 +36,12 @@ host_triplet = @host@ subdir = docs/libdbusmenu-glib DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__aclocal_m4_deps = $(top_srcdir)/m4/gnome-doc-utils.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/intltool.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs diff --git a/docs/libdbusmenu-glib/reference/Makefile.in b/docs/libdbusmenu-glib/reference/Makefile.in index 96b09f1..a475a64 100644 --- a/docs/libdbusmenu-glib/reference/Makefile.in +++ b/docs/libdbusmenu-glib/reference/Makefile.in @@ -43,7 +43,12 @@ DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ $(srcdir)/version.xml.in $(top_srcdir)/gtk-doc.local.make subdir = docs/libdbusmenu-glib/reference ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__aclocal_m4_deps = $(top_srcdir)/m4/gnome-doc-utils.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/intltool.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs diff --git a/docs/libdbusmenu-glib/reference/html/annotation-glossary.html b/docs/libdbusmenu-glib/reference/html/annotation-glossary.html index 46ca614..aaf0d69 100644 --- a/docs/libdbusmenu-glib/reference/html/annotation-glossary.html +++ b/docs/libdbusmenu-glib/reference/html/annotation-glossary.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="libdbusmenu-glib Reference Manual"> <link rel="up" href="index.html" title="libdbusmenu-glib Reference Manual"> <link rel="prev" href="api-index-deprecated.html" title="Deprecated API Index"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -72,6 +72,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/api-index-deprecated.html b/docs/libdbusmenu-glib/reference/html/api-index-deprecated.html index 1acd5ee..761d96e 100644 --- a/docs/libdbusmenu-glib/reference/html/api-index-deprecated.html +++ b/docs/libdbusmenu-glib/reference/html/api-index-deprecated.html @@ -8,7 +8,7 @@ <link rel="up" href="index.html" title="libdbusmenu-glib Reference Manual"> <link rel="prev" href="api-index-full.html" title="API Index"> <link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -26,6 +26,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/api-index-full.html b/docs/libdbusmenu-glib/reference/html/api-index-full.html index b8691d6..8d3abdb 100644 --- a/docs/libdbusmenu-glib/reference/html/api-index-full.html +++ b/docs/libdbusmenu-glib/reference/html/api-index-full.html @@ -8,7 +8,7 @@ <link rel="up" href="index.html" title="libdbusmenu-glib Reference Manual"> <link rel="prev" href="object-tree.html" title="Object Hierarchy"> <link rel="next" href="api-index-deprecated.html" title="Deprecated API Index"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -552,6 +552,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/ch01.html b/docs/libdbusmenu-glib/reference/html/ch01.html index 34a33b2..498b152 100644 --- a/docs/libdbusmenu-glib/reference/html/ch01.html +++ b/docs/libdbusmenu-glib/reference/html/ch01.html @@ -8,7 +8,7 @@ <link rel="up" href="index.html" title="libdbusmenu-glib Reference Manual"> <link rel="prev" href="index.html" title="libdbusmenu-glib Reference Manual"> <link rel="next" href="libdbusmenu-glib-DbusmenuServer.html" title="DbusmenuServer"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> -<a name="id540461"></a>API</h2></div></div></div> +<a name="id449598"></a>API</h2></div></div></div> <div class="toc"><dl> <dt> <span class="refentrytitle"><a href="libdbusmenu-glib-DbusmenuServer.html">DbusmenuServer</a></span><span class="refpurpose"> — The server signals changed and @@ -45,6 +45,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/index.html b/docs/libdbusmenu-glib/reference/html/index.html index 3e4a9ae..9ef6327 100644 --- a/docs/libdbusmenu-glib/reference/html/index.html +++ b/docs/libdbusmenu-glib/reference/html/index.html @@ -6,7 +6,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> <link rel="home" href="index.html" title="libdbusmenu-glib Reference Manual"> <link rel="next" href="ch01.html" title="API"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -44,6 +44,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html index 169098f..22e0bfd 100644 --- a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html +++ b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="libdbusmenu-glib-DbusmenuMenuitem.html" title="DbusmenuMenuitem"> <link rel="next" href="libdbusmenu-glib-Types.html" title="Types"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -592,6 +592,6 @@ the resources in <em class="parameter"><code>user_data</code></em>.</td> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitem.html b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitem.html index 9a787b2..cf33d69 100644 --- a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitem.html +++ b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitem.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="libdbusmenu-glib-DbusmenuMenuitemProxy.html" title="DbusmenuMenuitemProxy"> <link rel="next" href="libdbusmenu-glib-DbusmenuClient.html" title="DbusmenuClient"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -1726,6 +1726,6 @@ normally be called directly </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitemProxy.html b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitemProxy.html index 78edabc..11fa6b2 100644 --- a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitemProxy.html +++ b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitemProxy.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="libdbusmenu-glib-DbusmenuServer.html" title="DbusmenuServer"> <link rel="next" href="libdbusmenu-glib-DbusmenuMenuitem.html" title="DbusmenuMenuitem"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -161,6 +161,6 @@ don't have one or there is an error. <span class="annotation">[<acronym title="D </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html index f60ba38..3db65b4 100644 --- a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html +++ b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="ch01.html" title="API"> <link rel="next" href="libdbusmenu-glib-DbusmenuMenuitemProxy.html" title="DbusmenuMenuitemProxy"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -407,6 +407,6 @@ Sets the text direction that should be exported over DBus for </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-Types.html b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-Types.html index 93e7e54..d296c02 100644 --- a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-Types.html +++ b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-Types.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="libdbusmenu-glib-DbusmenuClient.html" title="DbusmenuClient"> <link rel="next" href="object-tree.html" title="Object Hierarchy"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -269,6 +269,6 @@ Looks up in the enum table for the value of <em class="parameter"><code>nick</co </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/html/object-tree.html b/docs/libdbusmenu-glib/reference/html/object-tree.html index 6a9e004..4767613 100644 --- a/docs/libdbusmenu-glib/reference/html/object-tree.html +++ b/docs/libdbusmenu-glib/reference/html/object-tree.html @@ -8,7 +8,7 @@ <link rel="up" href="index.html" title="libdbusmenu-glib Reference Manual"> <link rel="prev" href="libdbusmenu-glib-Types.html" title="Types"> <link rel="next" href="api-index-full.html" title="API Index"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -27,6 +27,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-glib/reference/tmpl/client.sgml b/docs/libdbusmenu-glib/reference/tmpl/client.sgml index d685c48..76c0d19 100644 --- a/docs/libdbusmenu-glib/reference/tmpl/client.sgml +++ b/docs/libdbusmenu-glib/reference/tmpl/client.sgml @@ -9,11 +9,13 @@ DbusmenuClient </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml b/docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml index cbea574..503c293 100644 --- a/docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml +++ b/docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml @@ -9,11 +9,13 @@ DbusmenuMenuitemProxy </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml b/docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml index d012503..f2e80eb 100644 --- a/docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml +++ b/docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml @@ -9,11 +9,13 @@ DbusmenuMenuitem </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-glib/reference/tmpl/server.sgml b/docs/libdbusmenu-glib/reference/tmpl/server.sgml index f9134af..ca9c51e 100644 --- a/docs/libdbusmenu-glib/reference/tmpl/server.sgml +++ b/docs/libdbusmenu-glib/reference/tmpl/server.sgml @@ -9,11 +9,13 @@ DbusmenuServer </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-glib/reference/tmpl/types.sgml b/docs/libdbusmenu-glib/reference/tmpl/types.sgml index 0089955..8a5e419 100644 --- a/docs/libdbusmenu-glib/reference/tmpl/types.sgml +++ b/docs/libdbusmenu-glib/reference/tmpl/types.sgml @@ -9,11 +9,13 @@ Types </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-glib/reference/version.xml b/docs/libdbusmenu-glib/reference/version.xml index 17b2ccd..6f2743d 100644 --- a/docs/libdbusmenu-glib/reference/version.xml +++ b/docs/libdbusmenu-glib/reference/version.xml @@ -1 +1 @@ -0.4.3 +0.4.4 diff --git a/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml b/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml deleted file mode 100644 index 1b466fb..0000000 --- a/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml +++ /dev/null @@ -1,72 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> - -<glossary id="annotation-glossary"> - <title>Annotation Glossary</title> -<glossdiv><title>A</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-allow-none"/>allow-none</glossterm> - <glossdef> - <para>NULL is ok, both for passing and for returning.</para> - </glossdef> - </glossentry> -</glossdiv> -<glossdiv><title>C</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-closure"/>closure</glossterm> - <glossdef> - <para>This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.</para> - </glossdef> - </glossentry> -</glossdiv> -<glossdiv><title>T</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-transfer none"/>transfer none</glossterm> - <glossdef> - <para>Don't free data after the code is done.</para> - </glossdef> - </glossentry> -</glossdiv> -<glossdiv><title>E</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-element-type"/>element-type</glossterm> - <glossdef> - <para>Generics and defining elements of containers and arrays.</para> - </glossdef> - </glossentry> -</glossdiv> -<glossdiv><title>I</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-in"/>in</glossterm> - <glossdef> - <para>Parameter for input. Default is <acronym>transfer none</acronym>.</para> - </glossdef> - </glossentry> -</glossdiv> -<glossdiv><title>T</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-transfer container"/>transfer container</glossterm> - <glossdef> - <para>Free data container after the code is done.</para> - </glossdef> - </glossentry> - <glossentry> - <glossterm><anchor id="annotation-glossterm-transfer full"/>transfer full</glossterm> - <glossdef> - <para>Free data after the code is done.</para> - </glossdef> - </glossentry> -</glossdiv> -<glossdiv><title>S</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-scope notified"/>scope notified</glossterm> - <glossdef> - <para>The callback is valid until the GDestroyNotify argument is called.</para> - </glossdef> - </glossentry> -</glossdiv> -</glossary> diff --git a/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml b/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml deleted file mode 100644 index 8ec0fe4..0000000 --- a/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<indexdiv> -</indexdiv> diff --git a/docs/libdbusmenu-glib/reference/xml/api-index-full.xml b/docs/libdbusmenu-glib/reference/xml/api-index-full.xml deleted file mode 100644 index 23e8734..0000000 --- a/docs/libdbusmenu-glib/reference/xml/api-index-full.xml +++ /dev/null @@ -1,144 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<indexdiv> -<indexdiv><title>C</title> -<indexentry><primaryie linkends="DbusmenuClient"><link linkend="DbusmenuClient">DbusmenuClient</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuClientClass"><link linkend="DbusmenuClientClass">DbusmenuClientClass</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuClientTypeHandler"><link linkend="DbusmenuClientTypeHandler">DbusmenuClientTypeHandler</link>, user_function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-client-add-type-handler"><link linkend="dbusmenu-client-add-type-handler">dbusmenu_client_add_type_handler</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-client-add-type-handler-full"><link linkend="dbusmenu-client-add-type-handler-full">dbusmenu_client_add_type_handler_full</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-client-get-icon-paths"><link linkend="dbusmenu-client-get-icon-paths">dbusmenu_client_get_icon_paths</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-client-get-root"><link linkend="dbusmenu-client-get-root">dbusmenu_client_get_root</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-client-get-status"><link linkend="dbusmenu-client-get-status">dbusmenu_client_get_status</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-client-get-text-direction"><link linkend="dbusmenu-client-get-text-direction">dbusmenu_client_get_text_direction</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-client-new"><link linkend="dbusmenu-client-new">dbusmenu_client_new</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS"><link linkend="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS">DBUSMENU_CLIENT_PROP_DBUS_NAME</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS"><link linkend="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS">DBUSMENU_CLIENT_PROP_DBUS_OBJECT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-PROP-STATUS:CAPS"><link linkend="DBUSMENU-CLIENT-PROP-STATUS:CAPS">DBUSMENU_CLIENT_PROP_STATUS</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-PROP-TEXT-DIRECTION:CAPS"><link linkend="DBUSMENU-CLIENT-PROP-TEXT-DIRECTION:CAPS">DBUSMENU_CLIENT_PROP_TEXT_DIRECTION</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-EVENT-RESULT:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-EVENT-RESULT:CAPS">DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-ICON-THEME-DIRS-CHANGED:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-ICON-THEME-DIRS-CHANGED:CAPS">DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-ITEM-ACTIVATE:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-ITEM-ACTIVATE:CAPS">DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS">DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS">DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS"><link linkend="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS">DBUSMENU_CLIENT_TYPES_DEFAULT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS"><link linkend="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS">DBUSMENU_CLIENT_TYPES_IMAGE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS"><link linkend="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS">DBUSMENU_CLIENT_TYPES_SEPARATOR</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>M</title> -<indexentry><primaryie linkends="DbusmenuMenuitem"><link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuMenuitemClass"><link linkend="DbusmenuMenuitemClass">DbusmenuMenuitemClass</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuMenuitemProxy"><link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuMenuitemProxyClass"><link linkend="DbusmenuMenuitemProxyClass">DbusmenuMenuitemProxyClass</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-about-to-show-cb"><link linkend="dbusmenu-menuitem-about-to-show-cb">dbusmenu_menuitem_about_to_show_cb</link>, user_function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-buildvariant-slot-t"><link linkend="dbusmenu-menuitem-buildvariant-slot-t">dbusmenu_menuitem_buildvariant_slot_t</link>, user_function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-child-add-position"><link linkend="dbusmenu-menuitem-child-add-position">dbusmenu_menuitem_child_add_position</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-child-append"><link linkend="dbusmenu-menuitem-child-append">dbusmenu_menuitem_child_append</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-child-delete"><link linkend="dbusmenu-menuitem-child-delete">dbusmenu_menuitem_child_delete</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-CHILD-DISPLAY-SUBMENU:CAPS"><link linkend="DBUSMENU-MENUITEM-CHILD-DISPLAY-SUBMENU:CAPS">DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-child-find"><link linkend="dbusmenu-menuitem-child-find">dbusmenu_menuitem_child_find</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-child-prepend"><link linkend="dbusmenu-menuitem-child-prepend">dbusmenu_menuitem_child_prepend</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-child-reorder"><link linkend="dbusmenu-menuitem-child-reorder">dbusmenu_menuitem_child_reorder</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-EVENT-ACTIVATED:CAPS"><link linkend="DBUSMENU-MENUITEM-EVENT-ACTIVATED:CAPS">DBUSMENU_MENUITEM_EVENT_ACTIVATED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-EVENT-CLOSED:CAPS"><link linkend="DBUSMENU-MENUITEM-EVENT-CLOSED:CAPS">DBUSMENU_MENUITEM_EVENT_CLOSED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-EVENT-OPENED:CAPS"><link linkend="DBUSMENU-MENUITEM-EVENT-OPENED:CAPS">DBUSMENU_MENUITEM_EVENT_OPENED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-find-id"><link linkend="dbusmenu-menuitem-find-id">dbusmenu_menuitem_find_id</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-foreach"><link linkend="dbusmenu-menuitem-foreach">dbusmenu_menuitem_foreach</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-get-children"><link linkend="dbusmenu-menuitem-get-children">dbusmenu_menuitem_get_children</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-get-id"><link linkend="dbusmenu-menuitem-get-id">dbusmenu_menuitem_get_id</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-get-parent"><link linkend="dbusmenu-menuitem-get-parent">dbusmenu_menuitem_get_parent</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-get-position"><link linkend="dbusmenu-menuitem-get-position">dbusmenu_menuitem_get_position</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-get-position-realized"><link linkend="dbusmenu-menuitem-get-position-realized">dbusmenu_menuitem_get_position_realized</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-get-root"><link linkend="dbusmenu-menuitem-get-root">dbusmenu_menuitem_get_root</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-handle-event"><link linkend="dbusmenu-menuitem-handle-event">dbusmenu_menuitem_handle_event</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS"><link linkend="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS">DBUSMENU_MENUITEM_ICON_NAME_BLANK</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-new"><link linkend="dbusmenu-menuitem-new">dbusmenu_menuitem_new</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-new-with-id"><link linkend="dbusmenu-menuitem-new-with-id">dbusmenu_menuitem_new_with_id</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-properties-copy"><link linkend="dbusmenu-menuitem-properties-copy">dbusmenu_menuitem_properties_copy</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-properties-list"><link linkend="dbusmenu-menuitem-properties-list">dbusmenu_menuitem_properties_list</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-exist"><link linkend="dbusmenu-menuitem-property-exist">dbusmenu_menuitem_property_exist</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-get"><link linkend="dbusmenu-menuitem-property-get">dbusmenu_menuitem_property_get</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-get-bool"><link linkend="dbusmenu-menuitem-property-get-bool">dbusmenu_menuitem_property_get_bool</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-get-int"><link linkend="dbusmenu-menuitem-property-get-int">dbusmenu_menuitem_property_get_int</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-get-variant"><link linkend="dbusmenu-menuitem-property-get-variant">dbusmenu_menuitem_property_get_variant</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-remove"><link linkend="dbusmenu-menuitem-property-remove">dbusmenu_menuitem_property_remove</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-set"><link linkend="dbusmenu-menuitem-property-set">dbusmenu_menuitem_property_set</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-bool"><link linkend="dbusmenu-menuitem-property-set-bool">dbusmenu_menuitem_property_set_bool</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-int"><link linkend="dbusmenu-menuitem-property-set-int">dbusmenu_menuitem_property_set_int</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-variant"><link linkend="dbusmenu-menuitem-property-set-variant">dbusmenu_menuitem_property_set_variant</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-CHILD-DISPLAY:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-CHILD-DISPLAY:CAPS">DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS">DBUSMENU_MENUITEM_PROP_ENABLED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS">DBUSMENU_MENUITEM_PROP_ICON_DATA</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS">DBUSMENU_MENUITEM_PROP_ICON_NAME</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-LABEL:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-LABEL:CAPS">DBUSMENU_MENUITEM_PROP_LABEL</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS">DBUSMENU_MENUITEM_PROP_SHORTCUT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS">DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS">DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-TYPE:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-TYPE:CAPS">DBUSMENU_MENUITEM_PROP_TYPE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS">DBUSMENU_MENUITEM_PROP_VISIBLE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-proxy-get-wrapped"><link linkend="dbusmenu-menuitem-proxy-get-wrapped">dbusmenu_menuitem_proxy_get_wrapped</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-proxy-new"><link linkend="dbusmenu-menuitem-proxy-new">dbusmenu_menuitem_proxy_new</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-send-about-to-show"><link linkend="dbusmenu-menuitem-send-about-to-show">dbusmenu_menuitem_send_about_to_show</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-set-parent"><link linkend="dbusmenu-menuitem-set-parent">dbusmenu_menuitem_set_parent</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-set-root"><link linkend="dbusmenu-menuitem-set-root">dbusmenu_menuitem_set_root</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SHORTCUT-ALT:CAPS"><link linkend="DBUSMENU-MENUITEM-SHORTCUT-ALT:CAPS">DBUSMENU_MENUITEM_SHORTCUT_ALT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SHORTCUT-CONTROL:CAPS"><link linkend="DBUSMENU-MENUITEM-SHORTCUT-CONTROL:CAPS">DBUSMENU_MENUITEM_SHORTCUT_CONTROL</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SHORTCUT-SHIFT:CAPS"><link linkend="DBUSMENU-MENUITEM-SHORTCUT-SHIFT:CAPS">DBUSMENU_MENUITEM_SHORTCUT_SHIFT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SHORTCUT-SUPER:CAPS"><link linkend="DBUSMENU-MENUITEM-SHORTCUT-SUPER:CAPS">DBUSMENU_MENUITEM_SHORTCUT_SUPER</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-show-to-user"><link linkend="dbusmenu-menuitem-show-to-user">dbusmenu_menuitem_show_to_user</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-ABOUT-TO-SHOW:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-ABOUT-TO-SHOW:CAPS">DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-EVENT:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-EVENT:CAPS">DBUSMENU_MENUITEM_SIGNAL_EVENT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS">DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS">DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS">DBUSMENU_MENUITEM_SIGNAL_REALIZED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS">DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-SHOW-TO-USER:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-SHOW-TO-USER:CAPS">DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-take-children"><link linkend="dbusmenu-menuitem-take-children">dbusmenu_menuitem_take_children</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS">DBUSMENU_MENUITEM_TOGGLE_CHECK</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS">DBUSMENU_MENUITEM_TOGGLE_RADIO</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-unparent"><link linkend="dbusmenu-menuitem-unparent">dbusmenu_menuitem_unparent</link>, function in <link linkend="libdbusmenu-glib-DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>S</title> -<indexentry><primaryie linkends="DbusmenuServer"><link linkend="DbusmenuServer">DbusmenuServer</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuServerClass"><link linkend="DbusmenuServerClass">DbusmenuServerClass</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-server-get-status"><link linkend="dbusmenu-server-get-status">dbusmenu_server_get_status</link>, function in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-server-get-text-direction"><link linkend="dbusmenu-server-get-text-direction">dbusmenu_server_get_text_direction</link>, function in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-server-new"><link linkend="dbusmenu-server-new">dbusmenu_server_new</link>, function in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS"><link linkend="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS">DBUSMENU_SERVER_PROP_DBUS_OBJECT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS"><link linkend="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS">DBUSMENU_SERVER_PROP_ROOT_NODE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-PROP-STATUS:CAPS"><link linkend="DBUSMENU-SERVER-PROP-STATUS:CAPS">DBUSMENU_SERVER_PROP_STATUS</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-PROP-TEXT-DIRECTION:CAPS"><link linkend="DBUSMENU-SERVER-PROP-TEXT-DIRECTION:CAPS">DBUSMENU_SERVER_PROP_TEXT_DIRECTION</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-PROP-VERSION:CAPS"><link linkend="DBUSMENU-SERVER-PROP-VERSION:CAPS">DBUSMENU_SERVER_PROP_VERSION</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-server-set-root"><link linkend="dbusmenu-server-set-root">dbusmenu_server_set_root</link>, function in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-server-set-status"><link linkend="dbusmenu-server-set-status">dbusmenu_server_set_status</link>, function in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-server-set-text-direction"><link linkend="dbusmenu-server-set-text-direction">dbusmenu_server_set_text_direction</link>, function in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_UPDATE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-ITEM-ACTIVATION:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-ITEM-ACTIVATION:CAPS">DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuStatus"><link linkend="DbusmenuStatus">DbusmenuStatus</link>, enum in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-status-get-nick"><link linkend="dbusmenu-status-get-nick">dbusmenu_status_get_nick</link>, function in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-status-get-type"><link linkend="dbusmenu-status-get-type">dbusmenu_status_get_type</link>, function in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-status-get-value-from-nick"><link linkend="dbusmenu-status-get-value-from-nick">dbusmenu_status_get_value_from_nick</link>, function in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>T</title> -<indexentry><primaryie linkends="DbusmenuTextDirection"><link linkend="DbusmenuTextDirection">DbusmenuTextDirection</link>, enum in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-text-direction-get-nick"><link linkend="dbusmenu-text-direction-get-nick">dbusmenu_text_direction_get_nick</link>, function in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-text-direction-get-type"><link linkend="dbusmenu-text-direction-get-type">dbusmenu_text_direction_get_type</link>, function in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-text-direction-get-value-from-nick"><link linkend="dbusmenu-text-direction-get-value-from-nick">dbusmenu_text_direction_get_value_from_nick</link>, function in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-TYPE-STATUS:CAPS"><link linkend="DBUSMENU-TYPE-STATUS:CAPS">DBUSMENU_TYPE_STATUS</link>, macro in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-TYPE-TEXT-DIRECTION:CAPS"><link linkend="DBUSMENU-TYPE-TEXT-DIRECTION:CAPS">DBUSMENU_TYPE_TEXT_DIRECTION</link>, macro in <link linkend="libdbusmenu-glib-Types">Types</link></primaryie></indexentry> -</indexdiv> -</indexdiv> diff --git a/docs/libdbusmenu-glib/reference/xml/client.xml b/docs/libdbusmenu-glib/reference/xml/client.xml deleted file mode 100644 index c5f55a5..0000000 --- a/docs/libdbusmenu-glib/reference/xml/client.xml +++ /dev/null @@ -1,439 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-glib-DbusmenuClient"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-glib-DbusmenuClient.top_of_page">DbusmenuClient</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GLIB Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>DbusmenuClient</refname> -<refpurpose>The catcher of all the server traffic</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-glib-DbusmenuClient.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-glib-DbusmenuClient.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-glib/client.h> - -#define <link linkend="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</link> -#define <link linkend="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS">DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</link> -#define <link linkend="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS">DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</link> -#define <link linkend="DBUSMENU-CLIENT-SIGNAL-EVENT-RESULT:CAPS">DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT</link> -#define <link linkend="DBUSMENU-CLIENT-SIGNAL-ITEM-ACTIVATE:CAPS">DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE</link> -#define <link linkend="DBUSMENU-CLIENT-SIGNAL-ICON-THEME-DIRS-CHANGED:CAPS">DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED</link> -#define <link linkend="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS">DBUSMENU_CLIENT_PROP_DBUS_NAME</link> -#define <link linkend="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS">DBUSMENU_CLIENT_PROP_DBUS_OBJECT</link> -#define <link linkend="DBUSMENU-CLIENT-PROP-STATUS:CAPS">DBUSMENU_CLIENT_PROP_STATUS</link> -#define <link linkend="DBUSMENU-CLIENT-PROP-TEXT-DIRECTION:CAPS">DBUSMENU_CLIENT_PROP_TEXT_DIRECTION</link> -#define <link linkend="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS">DBUSMENU_CLIENT_TYPES_DEFAULT</link> -#define <link linkend="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS">DBUSMENU_CLIENT_TYPES_SEPARATOR</link> -#define <link linkend="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS">DBUSMENU_CLIENT_TYPES_IMAGE</link> - <link linkend="DbusmenuClient">DbusmenuClient</link>; -struct <link linkend="DbusmenuClientClass">DbusmenuClientClass</link>; -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> (<link linkend="DbusmenuClientTypeHandler">*DbusmenuClientTypeHandler</link>) (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *newitem</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>, - <parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>); -<link linkend="DbusmenuClient"><returnvalue>DbusmenuClient</returnvalue></link> * <link linkend="dbusmenu-client-new">dbusmenu_client_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>); -const <link linkend="GStrv"><returnvalue>GStrv</returnvalue></link> <link linkend="dbusmenu-client-get-icon-paths">dbusmenu_client_get_icon_paths</link> (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>); -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-client-get-root">dbusmenu_client_get_root</link> (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>); -<link linkend="DbusmenuStatus"><returnvalue>DbusmenuStatus</returnvalue></link> <link linkend="dbusmenu-client-get-status">dbusmenu_client_get_status</link> (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>); -<link linkend="DbusmenuTextDirection"><returnvalue>DbusmenuTextDirection</returnvalue></link> <link linkend="dbusmenu-client-get-text-direction">dbusmenu_client_get_text_direction</link> - (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-client-add-type-handler">dbusmenu_client_add_type_handler</link> (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *type</parameter>, - <parameter><link linkend="DbusmenuClientTypeHandler"><type>DbusmenuClientTypeHandler</type></link> newfunc</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-client-add-type-handler-full">dbusmenu_client_add_type_handler_full</link> - (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *type</parameter>, - <parameter><link linkend="DbusmenuClientTypeHandler"><type>DbusmenuClientTypeHandler</type></link> newfunc</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>, - <parameter><link linkend="GDestroyNotify"><type>GDestroyNotify</type></link> destroy_func</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-glib-DbusmenuClient.description" role="desc"> -<title role="desc.title">Description</title> -<para> -The client exists as a mirror to the server. For most folks - all they will do with a client is set it up to connect to - a server and then watch as the menu items on their side - of the bus change. This is all they should need to know about - the client, that it magically makes their menuitems dance. -</para> -<para> - It does this by setting up signal watchers and adjusting - the menuitems appropriately. Most users should watch the - menu items and the signal <link linkend="DbusmenuClient-layout-changed"><type>"layout-changed"</type></link> for - larger events so that they can be optimized. It is possible - with that signal that even the root node would change. If - that doesn't happen the normal signals on the individual - nodes should be enough for most users. -</para> -</refsect1> -<refsect1 id="libdbusmenu-glib-DbusmenuClient.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</title> -<indexterm zone="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED "layout-updated" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuClient-layout-updated"><type>"layout-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</title> -<indexterm zone="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED "root-changed" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuClient-root-changed"><type>"root-changed"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</title> -<indexterm zone="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM "new-menuitem" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuClient-new-menuitem"><type>"new-menuitem"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-SIGNAL-EVENT-RESULT:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT</title> -<indexterm zone="DBUSMENU-CLIENT-SIGNAL-EVENT-RESULT:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT "event-result" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuClient-event-result"><type>"event-result"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-SIGNAL-ITEM-ACTIVATE:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE</title> -<indexterm zone="DBUSMENU-CLIENT-SIGNAL-ITEM-ACTIVATE:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE "item-activate" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuClient-item-activate"><type>"item-activate"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-SIGNAL-ICON-THEME-DIRS-CHANGED:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED</title> -<indexterm zone="DBUSMENU-CLIENT-SIGNAL-ICON-THEME-DIRS-CHANGED:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED "icon-theme-dirs-changed" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuClient-icon-theme-dirs-changed"><type>"icon-theme-dirs-changed"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_PROP_DBUS_NAME</title> -<indexterm zone="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS"><primary>DBUSMENU_CLIENT_PROP_DBUS_NAME</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_PROP_DBUS_NAME "dbus-name" -</programlisting> -<para> -String to access property <link linkend="DbusmenuClient--dbus-name"><type>"dbus-name"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_PROP_DBUS_OBJECT</title> -<indexterm zone="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS"><primary>DBUSMENU_CLIENT_PROP_DBUS_OBJECT</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT "dbus-object" -</programlisting> -<para> -String to access property <link linkend="DbusmenuClient--dbus-object"><type>"dbus-object"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-PROP-STATUS:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_PROP_STATUS</title> -<indexterm zone="DBUSMENU-CLIENT-PROP-STATUS:CAPS"><primary>DBUSMENU_CLIENT_PROP_STATUS</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_PROP_STATUS "status" -</programlisting> -<para> -String to access property <link linkend="DbusmenuClient--status"><type>"status"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-PROP-TEXT-DIRECTION:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_PROP_TEXT_DIRECTION</title> -<indexterm zone="DBUSMENU-CLIENT-PROP-TEXT-DIRECTION:CAPS"><primary>DBUSMENU_CLIENT_PROP_TEXT_DIRECTION</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_PROP_TEXT_DIRECTION "text-direction" -</programlisting> -<para> -String to access property <link linkend="DbusmenuClient--text-direction"><type>"text-direction"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_TYPES_DEFAULT</title> -<indexterm zone="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS"><primary>DBUSMENU_CLIENT_TYPES_DEFAULT</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_TYPES_DEFAULT "standard" -</programlisting> -<para> -Used to set the 'type' property on a menu item to create -a standard menu item. -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_TYPES_SEPARATOR</title> -<indexterm zone="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS"><primary>DBUSMENU_CLIENT_TYPES_SEPARATOR</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_TYPES_SEPARATOR "separator" -</programlisting> -<para> -Used to set the 'type' property on a menu item to create -a separator menu item. -</para></refsect2> -<refsect2 id="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS" role="macro"> -<title>DBUSMENU_CLIENT_TYPES_IMAGE</title> -<indexterm zone="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS"><primary>DBUSMENU_CLIENT_TYPES_IMAGE</primary></indexterm> -<programlisting>#define DBUSMENU_CLIENT_TYPES_IMAGE "standard" -</programlisting> -<para> -Used to set the 'type' property on a menu item to create -an image menu item. Deprecated as standard menu items now -support images as well. -</para></refsect2> -<refsect2 id="DbusmenuClient" role="struct"> -<title>DbusmenuClient</title> -<indexterm zone="DbusmenuClient"><primary>DbusmenuClient</primary></indexterm> -<programlisting>typedef struct _DbusmenuClient DbusmenuClient;</programlisting> -<para> -The client for a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> creating a shared - object set of <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects. -</para></refsect2> -<refsect2 id="DbusmenuClientClass" role="struct"> -<title>struct DbusmenuClientClass</title> -<indexterm zone="DbusmenuClientClass"><primary>DbusmenuClientClass</primary></indexterm> -<programlisting>struct DbusmenuClientClass { - GObjectClass parent_class; - - void (*layout_updated)(void); - void (*root_changed) (DbusmenuMenuitem * newroot); - void (*new_menuitem) (DbusmenuMenuitem * newitem); - void (*item_activate) (DbusmenuMenuitem * item, guint timestamp); - void (*event_result) (DbusmenuMenuitem * item, gchar * event, GVariant * data, guint timestamp, GError * error); - void (*icon_theme_dirs) (DbusmenuMenuitem * item, gpointer theme_dirs, GError * error); - - /*< Private >*/ - void (*reserved1) (void); - void (*reserved2) (void); - void (*reserved3) (void); - void (*reserved4) (void); - void (*reserved5) (void); -}; -</programlisting> -<para> -A simple class that takes all of the information from a - <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> over DBus and makes the same set of - <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects appear on the other side. -</para><variablelist role="struct"> -<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="DbusmenuClientClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara><link linkend="GObjectClass"><type>GObjectClass</type></link></simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.layout-updated">layout_updated</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuClient-layout-updated"><type>"layout-updated"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.root-changed">root_changed</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuClient-root-changed"><type>"root-changed"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.new-menuitem">new_menuitem</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuClient-new-menuitem"><type>"new-menuitem"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.item-activate">item_activate</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuClient-item-activate"><type>"item-activate"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.event-result">event_result</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuClient-event-error"><type>"event-error"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.icon-theme-dirs">icon_theme_dirs</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuClient-icon-theme-dirs-changed"><type>"icon-theme-dirs-changed"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuClientClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="DbusmenuClientTypeHandler" role="function"> -<title>DbusmenuClientTypeHandler ()</title> -<indexterm zone="DbusmenuClientTypeHandler"><primary>DbusmenuClientTypeHandler</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> (*DbusmenuClientTypeHandler) (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *newitem</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>, - <parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting> -<para> -The type handler is called when a dbusmenu item is created - with a matching type as setup in <link linkend="dbusmenu-client-add-type-handler"><type>dbusmenu_client_add_type_handler</type></link> -</para><variablelist role="params"> -<varlistentry><term><parameter>newitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that was created</simpara></listitem></varlistentry> -<varlistentry><term><parameter>parent</parameter> :</term> -<listitem><simpara>The parent of <parameter>newitem</parameter> or <link linkend="NULL:CAPS"><type>NULL</type></link> if none</simpara></listitem></varlistentry> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>A pointer to the <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link></simpara></listitem></varlistentry> -<varlistentry><term><parameter>user_data</parameter> :</term> -<listitem><simpara>The data you gave us</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><link linkend="TRUE:CAPS"><type>TRUE</type></link> if the type has been handled. <link linkend="FALSE:CAPS"><type>FALSE</type></link> if this -function was somehow unable to handle it.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-client-new" role="function"> -<title>dbusmenu_client_new ()</title> -<indexterm zone="dbusmenu-client-new"><primary>dbusmenu_client_new</primary></indexterm> -<programlisting><link linkend="DbusmenuClient"><returnvalue>DbusmenuClient</returnvalue></link> * dbusmenu_client_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>);</programlisting> -<para> -This function creates a new client that connects to a specific -server on DBus. That server is at a specific location sharing -a known object. The interface is assumed by the code to be -the DBus menu interface. The newly created client will start -sending out events as it syncs up with the server. -</para><variablelist role="params"> -<varlistentry><term><parameter>name</parameter> :</term> -<listitem><simpara>The DBus name for the server to connect to</simpara></listitem></varlistentry> -<varlistentry><term><parameter>object</parameter> :</term> -<listitem><simpara>The object on the server to monitor</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A brand new <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-client-get-icon-paths" role="function"> -<title>dbusmenu_client_get_icon_paths ()</title> -<indexterm zone="dbusmenu-client-get-icon-paths"><primary>dbusmenu_client_get_icon_paths</primary></indexterm> -<programlisting>const <link linkend="GStrv"><returnvalue>GStrv</returnvalue></link> dbusmenu_client_get_icon_paths (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>);</programlisting> -<para> -Gets the stored and exported icon paths from the client. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> to get the icon paths from</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A NULL-terminated list of icon paths with -memory managed by the client. Duplicate if you want -to keep them. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-client-get-root" role="function"> -<title>dbusmenu_client_get_root ()</title> -<indexterm zone="dbusmenu-client-get-root"><primary>dbusmenu_client_get_root</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_client_get_root (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>);</programlisting> -<para> -Grabs the root node for the specified client <parameter>client</parameter>. This -function may block. It will block if there is currently a -call to update the layout, it will block on that layout -updated and then return the newly updated layout. Chances -are that this update is in the queue for the mainloop as -it would have been requested some time ago, but in theory -it could block longer. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> to get the root node from</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> representing the root of -menu on the server. If there is no server or there is -an error receiving its layout it'll return <link linkend="NULL:CAPS"><type>NULL</type></link>. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-client-get-status" role="function"> -<title>dbusmenu_client_get_status ()</title> -<indexterm zone="dbusmenu-client-get-status"><primary>dbusmenu_client_get_status</primary></indexterm> -<programlisting><link linkend="DbusmenuStatus"><returnvalue>DbusmenuStatus</returnvalue></link> dbusmenu_client_get_status (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>);</programlisting> -<para> -Gets the recommended current status that the server - is exporting for the menus. In situtations where the - value is <link linkend="DBUSMENU-STATUS-NOTICE:CAPS"><type>DBUSMENU_STATUS_NOTICE</type></link> it is recommended that - the client show the menus to the user an a more noticible - way. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> to check the status on</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Status being exported.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-client-get-text-direction" role="function"> -<title>dbusmenu_client_get_text_direction ()</title> -<indexterm zone="dbusmenu-client-get-text-direction"><primary>dbusmenu_client_get_text_direction</primary></indexterm> -<programlisting><link linkend="DbusmenuTextDirection"><returnvalue>DbusmenuTextDirection</returnvalue></link> dbusmenu_client_get_text_direction - (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>);</programlisting> -<para> -Gets the text direction that the server is exporting. If - the server is not exporting a direction then the value - <link linkend="DBUSMENU-TEXT-DIRECTION-NONE:CAPS"><type>DBUSMENU_TEXT_DIRECTION_NONE</type></link> will be returned. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> to check the text direction on</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Text direction being exported.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-client-add-type-handler" role="function"> -<title>dbusmenu_client_add_type_handler ()</title> -<indexterm zone="dbusmenu-client-add-type-handler"><primary>dbusmenu_client_add_type_handler</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_client_add_type_handler (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *type</parameter>, - <parameter><link linkend="DbusmenuClientTypeHandler"><type>DbusmenuClientTypeHandler</type></link> newfunc</parameter>);</programlisting> -<para> -This function connects into the type handling of the <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link>. -Every new menuitem that comes in immediately gets asked for it's -properties. When we get those properties we check the 'type' -property and look to see if it matches a handler that is known -by the client. If so, the <parameter>newfunc</parameter> function is executed on that -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>. If not, then the DbusmenuClient::new-menuitem -signal is sent. -</para> -<para> -In the future the known types will be sent to the server so that it -can make choices about the menu item types availble. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>Client where we're getting types coming in</simpara></listitem></varlistentry> -<varlistentry><term><parameter>type</parameter> :</term> -<listitem><simpara>A text string that will be matched with the 'type' -property on incoming menu items</simpara></listitem></varlistentry> -<varlistentry><term><parameter>newfunc</parameter> :</term> -<listitem><simpara>The function that will be executed with those new -items when they come in. <emphasis role="annotation">[<acronym>scope notified</acronym>]</emphasis></simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>If registering the new type was successful.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-client-add-type-handler-full" role="function"> -<title>dbusmenu_client_add_type_handler_full ()</title> -<indexterm zone="dbusmenu-client-add-type-handler-full"><primary>dbusmenu_client_add_type_handler_full</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_client_add_type_handler_full - (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *type</parameter>, - <parameter><link linkend="DbusmenuClientTypeHandler"><type>DbusmenuClientTypeHandler</type></link> newfunc</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>, - <parameter><link linkend="GDestroyNotify"><type>GDestroyNotify</type></link> destroy_func</parameter>);</programlisting> -<para> -This function connects into the type handling of the <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link>. -Every new menuitem that comes in immediately gets asked for it's -properties. When we get those properties we check the 'type' -property and look to see if it matches a handler that is known -by the client. If so, the <parameter>newfunc</parameter> function is executed on that -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>. If not, then the DbusmenuClient::new-menuitem -signal is sent. -</para> -<para> -In the future the known types will be sent to the server so that it -can make choices about the menu item types availble. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>Client where we're getting types coming in</simpara></listitem></varlistentry> -<varlistentry><term><parameter>type</parameter> :</term> -<listitem><simpara>A text string that will be matched with the 'type' -property on incoming menu items</simpara></listitem></varlistentry> -<varlistentry><term><parameter>newfunc</parameter> :</term> -<listitem><simpara>The function that will be executed with those new -items when they come in. <emphasis role="annotation">[<acronym>scope notified</acronym>]</emphasis></simpara></listitem></varlistentry> -<varlistentry><term><parameter>user_data</parameter> :</term> -<listitem><simpara>Data passed to <parameter>newfunc</parameter> when it is called</simpara></listitem></varlistentry> -<varlistentry><term><parameter>destroy_func</parameter> :</term> -<listitem><simpara>A function that is called when the type handler is -removed (usually on client destruction) which will free -the resources in <parameter>user_data</parameter>.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>If registering the new type was successful.</simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml deleted file mode 100644 index db860d6..0000000 --- a/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml +++ /dev/null @@ -1,114 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-glib-DbusmenuMenuitemProxy"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-glib-DbusmenuMenuitemProxy.top_of_page">DbusmenuMenuitemProxy</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GLIB Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>DbusmenuMenuitemProxy</refname> -<refpurpose>A menuitem that proxies from another menuitem</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-glib-DbusmenuMenuitemProxy.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-glib-DbusmenuMenuitemProxy.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-glib/menuitem-proxy.h> - - <link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link>; -struct <link linkend="DbusmenuMenuitemProxyClass">DbusmenuMenuitemProxyClass</link>; -<link linkend="DbusmenuMenuitemProxy"><returnvalue>DbusmenuMenuitemProxy</returnvalue></link> * <link linkend="dbusmenu-menuitem-proxy-new">dbusmenu_menuitem_proxy_new</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-proxy-get-wrapped">dbusmenu_menuitem_proxy_get_wrapped</link> (<parameter><link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> *pmi</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-glib-DbusmenuMenuitemProxy.description" role="desc"> -<title role="desc.title">Description</title> -<para> -This small object allows for proxying all the properties from a remote -menuitem to a new object that can be moved around appropriately within -the new menu structure. -</para> -</refsect1> -<refsect1 id="libdbusmenu-glib-DbusmenuMenuitemProxy.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DbusmenuMenuitemProxy" role="struct"> -<title>DbusmenuMenuitemProxy</title> -<indexterm zone="DbusmenuMenuitemProxy"><primary>DbusmenuMenuitemProxy</primary></indexterm> -<programlisting>typedef struct _DbusmenuMenuitemProxy DbusmenuMenuitemProxy;</programlisting> -<para> -Public instance data for a <link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link>. -</para></refsect2> -<refsect2 id="DbusmenuMenuitemProxyClass" role="struct"> -<title>struct DbusmenuMenuitemProxyClass</title> -<indexterm zone="DbusmenuMenuitemProxyClass"><primary>DbusmenuMenuitemProxyClass</primary></indexterm> -<programlisting>struct DbusmenuMenuitemProxyClass { - DbusmenuMenuitemClass parent_class; - - /*< Private >*/ - void (*reserved1) (void); - void (*reserved2) (void); - void (*reserved3) (void); - void (*reserved4) (void); -}; -</programlisting> -<para> -Functions and signal slots for <link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link>. -</para><variablelist role="struct"> -<varlistentry><term><link linkend="DbusmenuMenuitemClass"><type>DbusmenuMenuitemClass</type></link> <structfield id="DbusmenuMenuitemProxyClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara>The Class of <link linkend="DbusmeneMenuitem"><type>DbusmeneMenuitem</type></link></simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemProxyClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemProxyClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemProxyClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemProxyClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-proxy-new" role="function"> -<title>dbusmenu_menuitem_proxy_new ()</title> -<indexterm zone="dbusmenu-menuitem-proxy-new"><primary>dbusmenu_menuitem_proxy_new</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitemProxy"><returnvalue>DbusmenuMenuitemProxy</returnvalue></link> * dbusmenu_menuitem_proxy_new (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -Builds a new <link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> object that proxies -all of the values for <parameter>mi</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to proxy</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A new <link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> object.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-proxy-get-wrapped" role="function"> -<title>dbusmenu_menuitem_proxy_get_wrapped ()</title> -<indexterm zone="dbusmenu-menuitem-proxy-get-wrapped"><primary>dbusmenu_menuitem_proxy_get_wrapped</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_proxy_get_wrapped (<parameter><link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> *pmi</parameter>);</programlisting> -<para> -Accesses the private variable of which <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> -we are doing the proxying for. -</para><variablelist role="params"> -<varlistentry><term><parameter>pmi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> to look into</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> object or a <link linkend="NULL:CAPS"><type>NULL</type></link> if we -don't have one or there is an error. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem.xml b/docs/libdbusmenu-glib/reference/xml/menuitem.xml deleted file mode 100644 index d9a4881..0000000 --- a/docs/libdbusmenu-glib/reference/xml/menuitem.xml +++ /dev/null @@ -1,1206 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-glib-DbusmenuMenuitem"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-glib-DbusmenuMenuitem.top_of_page">DbusmenuMenuitem</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GLIB Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>DbusmenuMenuitem</refname> -<refpurpose>A lowlevel represenation of a menuitem</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-glib-DbusmenuMenuitem.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-glib-DbusmenuMenuitem.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-glib/menuitem.h> - -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS">DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS">DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-EVENT:CAPS">DBUSMENU_MENUITEM_SIGNAL_EVENT</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS">DBUSMENU_MENUITEM_SIGNAL_REALIZED</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS">DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-ABOUT-TO-SHOW:CAPS">DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW</link> -#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-SHOW-TO-USER:CAPS">DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-TYPE:CAPS">DBUSMENU_MENUITEM_PROP_TYPE</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS">DBUSMENU_MENUITEM_PROP_VISIBLE</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS">DBUSMENU_MENUITEM_PROP_ENABLED</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-LABEL:CAPS">DBUSMENU_MENUITEM_PROP_LABEL</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS">DBUSMENU_MENUITEM_PROP_ICON_NAME</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS">DBUSMENU_MENUITEM_PROP_ICON_DATA</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS">DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS">DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-CHILD-DISPLAY:CAPS">DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY</link> -#define <link linkend="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS">DBUSMENU_MENUITEM_PROP_SHORTCUT</link> -#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS">DBUSMENU_MENUITEM_TOGGLE_CHECK</link> -#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS">DBUSMENU_MENUITEM_TOGGLE_RADIO</link> -#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</link> -#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</link> -#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN</link> -#define <link linkend="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS">DBUSMENU_MENUITEM_ICON_NAME_BLANK</link> -#define <link linkend="DBUSMENU-MENUITEM-CHILD-DISPLAY-SUBMENU:CAPS">DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU</link> -#define <link linkend="DBUSMENU-MENUITEM-SHORTCUT-ALT:CAPS">DBUSMENU_MENUITEM_SHORTCUT_ALT</link> -#define <link linkend="DBUSMENU-MENUITEM-SHORTCUT-CONTROL:CAPS">DBUSMENU_MENUITEM_SHORTCUT_CONTROL</link> -#define <link linkend="DBUSMENU-MENUITEM-SHORTCUT-SHIFT:CAPS">DBUSMENU_MENUITEM_SHORTCUT_SHIFT</link> -#define <link linkend="DBUSMENU-MENUITEM-SHORTCUT-SUPER:CAPS">DBUSMENU_MENUITEM_SHORTCUT_SUPER</link> -#define <link linkend="DBUSMENU-MENUITEM-EVENT-ACTIVATED:CAPS">DBUSMENU_MENUITEM_EVENT_ACTIVATED</link> -#define <link linkend="DBUSMENU-MENUITEM-EVENT-CLOSED:CAPS">DBUSMENU_MENUITEM_EVENT_CLOSED</link> -#define <link linkend="DBUSMENU-MENUITEM-EVENT-OPENED:CAPS">DBUSMENU_MENUITEM_EVENT_OPENED</link> -struct <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link>; -<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="dbusmenu-menuitem-about-to-show-cb">*dbusmenu_menuitem_about_to_show_cb</link>) - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>); -<link linkend="GVariant"><returnvalue>GVariant</returnvalue></link> * (<link linkend="dbusmenu-menuitem-buildvariant-slot-t">*dbusmenu_menuitem_buildvariant_slot_t</link>) - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gchar"><type>gchar</type></link> **properties</parameter>); -struct <link linkend="DbusmenuMenuitemClass">DbusmenuMenuitemClass</link>; -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-new">dbusmenu_menuitem_new</link> (<parameter><type>void</type></parameter>); -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-new-with-id">dbusmenu_menuitem_new_with_id</link> (<parameter><link linkend="gint"><type>gint</type></link> id</parameter>); -<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="dbusmenu-menuitem-get-id">dbusmenu_menuitem_get_id</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="dbusmenu-menuitem-get-children">dbusmenu_menuitem_get_children</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="dbusmenu-menuitem-take-children">dbusmenu_menuitem_take_children</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -<link linkend="guint"><returnvalue>guint</returnvalue></link> <link linkend="dbusmenu-menuitem-get-position">dbusmenu_menuitem_get_position</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>); -<link linkend="guint"><returnvalue>guint</returnvalue></link> <link linkend="dbusmenu-menuitem-get-position-realized">dbusmenu_menuitem_get_position_realized</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-append">dbusmenu_menuitem_child_append</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-prepend">dbusmenu_menuitem_child_prepend</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-delete">dbusmenu_menuitem_child_delete</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-add-position">dbusmenu_menuitem_child_add_position</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> position</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-reorder">dbusmenu_menuitem_child_reorder</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> position</parameter>); -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-child-find">dbusmenu_menuitem_child_find</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gint"><type>gint</type></link> id</parameter>); -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-find-id">dbusmenu_menuitem_find_id</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gint"><type>gint</type></link> id</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set">dbusmenu_menuitem_property_set</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-bool">dbusmenu_menuitem_property_set_bool</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter>const <link linkend="gboolean"><type>gboolean</type></link> value</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-int">dbusmenu_menuitem_property_set_int</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter>const <link linkend="gint"><type>gint</type></link> value</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-variant">dbusmenu_menuitem_property_set_variant</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter><link linkend="GVariant"><type>GVariant</type></link> *value</parameter>); -const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="dbusmenu-menuitem-property-get">dbusmenu_menuitem_property_get</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-get-bool">dbusmenu_menuitem_property_get_bool</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); -<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="dbusmenu-menuitem-property-get-int">dbusmenu_menuitem_property_get_int</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); -<link linkend="GVariant"><returnvalue>GVariant</returnvalue></link> * <link linkend="dbusmenu-menuitem-property-get-variant">dbusmenu_menuitem_property_get_variant</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-exist">dbusmenu_menuitem_property_exist</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); -<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="dbusmenu-menuitem-properties-list">dbusmenu_menuitem_properties_list</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -<link linkend="GHashTable"><returnvalue>GHashTable</returnvalue></link> * <link linkend="dbusmenu-menuitem-properties-copy">dbusmenu_menuitem_properties_copy</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-property-remove">dbusmenu_menuitem_property_remove</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-set-root">dbusmenu_menuitem_set_root</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gboolean"><type>gboolean</type></link> root</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-get-root">dbusmenu_menuitem_get_root</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-foreach">dbusmenu_menuitem_foreach</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="void"><type>void</type></link> (*func) (DbusmenuMenuitem * mi, gpointer data)</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-handle-event">dbusmenu_menuitem_handle_event</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, - <parameter><link linkend="GVariant"><type>GVariant</type></link> *variant</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-send-about-to-show">dbusmenu_menuitem_send_about_to_show</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="void"><type>void</type></link> (*cb) (DbusmenuMenuitem * mi, gpointer user_data)</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-show-to-user">dbusmenu_menuitem_show_to_user</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>); -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-get-parent">dbusmenu_menuitem_get_parent</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-set-parent">dbusmenu_menuitem_set_parent</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-unparent">dbusmenu_menuitem_unparent</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-glib-DbusmenuMenuitem.description" role="desc"> -<title role="desc.title">Description</title> -<para> -A <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> is the lowest level of represenation of a -single item in a menu. It gets created on the server side -and copied over to the client side where it gets rendered. As -the server starts to change it, and grow it, and do all kinds -of fun stuff that information is transfered over DBus and the -client updates it's understanding of the object model. -</para> -<para> -Most people using either the client or the server should be -able to deal mostly with <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects. These -are simple, but then they can be attached to more complex -objects and handled appropriately. -</para> -</refsect1> -<refsect1 id="libdbusmenu-glib-DbusmenuMenuitem.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED "property-changed" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-property-changed"><type>"property-changed"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED "item-activated" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-item-activated"><type>"item-activated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED "child-added" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-child-added"><type>"child-added"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED "child-removed" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-child-removed"><type>"child-removed"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED "child-moved" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-child-moved"><type>"child-moved"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-EVENT:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_EVENT</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-EVENT:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_EVENT</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_EVENT "event" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-event"><type>"event"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_REALIZED</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_REALIZED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_REALIZED "realized" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-realized"><type>"realized"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID (g_signal_lookup(DBUSMENU_MENUITEM_SIGNAL_REALIZED, DBUSMENU_TYPE_MENUITEM)) -</programlisting> -<para> -ID to attach to signal <link linkend="DbusmenuServer-realized"><type>"realized"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-ABOUT-TO-SHOW:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-ABOUT-TO-SHOW:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW "about-to-show" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-about-to-show"><type>"about-to-show"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-SHOW-TO-USER:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER</title> -<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-SHOW-TO-USER:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER "show-to-user" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-show-to-user"><type>"show-to-user"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-TYPE:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_TYPE</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-TYPE:CAPS"><primary>DBUSMENU_MENUITEM_PROP_TYPE</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_TYPE "type" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property used to represent what type of menuitem -this object represents. Type: <link linkend="G-VARIANT-TYPE-STRING:CAPS"><type>G_VARIANT_TYPE_STRING</type></link>. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_VISIBLE</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS"><primary>DBUSMENU_MENUITEM_PROP_VISIBLE</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_VISIBLE "visible" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property used to represent whether the menuitem -should be shown or not. Type: <link linkend="G-VARIANT-TYPE-BOOLEAN:CAPS"><type>G_VARIANT_TYPE_BOOLEAN</type></link>. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_ENABLED</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS"><primary>DBUSMENU_MENUITEM_PROP_ENABLED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_ENABLED "enabled" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property used to represent whether the menuitem -is clickable or not. Type: <link linkend="G-VARIANT-TYPE-BOOLEAN:CAPS"><type>G_VARIANT_TYPE_BOOLEAN</type></link>. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-LABEL:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_LABEL</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-LABEL:CAPS"><primary>DBUSMENU_MENUITEM_PROP_LABEL</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_LABEL "label" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property used for the text on the menu item. -Type: <link linkend="G-VARIANT-TYPE-STRING:CAPS"><type>G_VARIANT_TYPE_STRING</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_ICON_NAME</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS"><primary>DBUSMENU_MENUITEM_PROP_ICON_NAME</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_ICON_NAME "icon-name" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property that is the name of the icon under the -Freedesktop.org icon naming spec. Type: <link linkend="G-VARIANT-TYPE-STRING:CAPS"><type>G_VARIANT_TYPE_STRING</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_ICON_DATA</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS"><primary>DBUSMENU_MENUITEM_PROP_ICON_DATA</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_ICON_DATA "icon-data" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property that is the raw data of a custom icon -used in the application. Type: <link linkend="G-VARIANT-TYPE-VARIANT:CAPS"><type>G_VARIANT_TYPE_VARIANT</type></link> -</para> -<para> -It is recommended that this is not set directly but instead the -libdbusmenu-gtk library is used with the function <link linkend="dbusmenu-menuitem-property-set-image"><function>dbusmenu_menuitem_property_set_image()</function></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS"><primary>DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE "toggle-type" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property that says what type of toggle entry should -be shown in the menu. Should be either <link linkend="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS"><type>DBUSMENU_MENUITEM_TOGGLE_CHECK</type></link> -or <link linkend="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS"><type>DBUSMENU_MENUITEM_TOGGLE_RADIO</type></link>. Type: <link linkend="G-VARIANT-TYPE-STRING:CAPS"><type>G_VARIANT_TYPE_STRING</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS"><primary>DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_TOGGLE_STATE "toggle-state" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property that says what state a toggle entry should -be shown as the menu. Should be either <link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS"><type>DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</type></link> -<link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS"><type>DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</type></link> or <link linkend="DBUSMENU-MENUITEM-TOGGLE-STATUE-UNKNOWN:CAPS"><type>DBUSMENU_MENUITEM_TOGGLE_STATUE_UNKNOWN</type></link>. -Type: <link linkend="G-VARIANT-TYPE-INT32:CAPS"><type>G_VARIANT_TYPE_INT32</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-CHILD-DISPLAY:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-CHILD-DISPLAY:CAPS"><primary>DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY "children-display" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property that tells how the children of this menuitem -should be displayed. Most likely this will be unset or of the value -<link linkend="DBUSMENU-MENUITEM-CHILD-DISPLAY-SUBMENU:CAPS"><type>DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU</type></link>. Type: <link linkend="G-VARIANT-TYPE-STRING:CAPS"><type>G_VARIANT_TYPE_STRING</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_PROP_SHORTCUT</title> -<indexterm zone="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS"><primary>DBUSMENU_MENUITEM_PROP_SHORTCUT</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_PROP_SHORTCUT "shortcut" -</programlisting> -<para> -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property that is the entries that represent a shortcut -to activate the menuitem. It is an array of arrays of strings. -Type: <link linkend="G-VARIANT-TYPE-ARRAY:CAPS"><type>G_VARIANT_TYPE_ARRAY</type></link> -</para> -<para> -It is recommended that this is not set directly but instead the -libdbusmenu-gtk library is used with the function <link linkend="dbusmenu-menuitem-property-set-shortcut"><function>dbusmenu_menuitem_property_set_shortcut()</function></link> -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_TOGGLE_CHECK</title> -<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_CHECK</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_CHECK "checkmark" -</programlisting> -<para> -Used to set <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS"><type>DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</type></link> to be a standard -check mark item. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_TOGGLE_RADIO</title> -<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_RADIO</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_RADIO "radio" -</programlisting> -<para> -Used to set <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS"><type>DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</type></link> to be a standard -radio item. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</title> -<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED 0 -</programlisting> -<para> -Used to set <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS"><type>DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</type></link> so that the menu's -toggle item is empty. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</title> -<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED 1 -</programlisting> -<para> -Used to set <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS"><type>DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</type></link> so that the menu's -toggle item is filled. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN</title> -<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN -1 -</programlisting> -<para> -Used to set <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS"><type>DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</type></link> so that the menu's -toggle item is undecided. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_ICON_NAME_BLANK</title> -<indexterm zone="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS"><primary>DBUSMENU_MENUITEM_ICON_NAME_BLANK</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_ICON_NAME_BLANK "blank-icon" -</programlisting> -<para> -Used to set <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS"><type>DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</type></link> so that the menu's -toggle item is undecided. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-CHILD-DISPLAY-SUBMENU:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU</title> -<indexterm zone="DBUSMENU-MENUITEM-CHILD-DISPLAY-SUBMENU:CAPS"><primary>DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU "submenu" -</programlisting> -<para> -Used in <link linkend="DBUSMENU-MENUITEM-PROP-CHILD-DISPLAY:CAPS"><type>DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY</type></link> to have the -subitems displayed as a submenu. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SHORTCUT-ALT:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SHORTCUT_ALT</title> -<indexterm zone="DBUSMENU-MENUITEM-SHORTCUT-ALT:CAPS"><primary>DBUSMENU_MENUITEM_SHORTCUT_ALT</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SHORTCUT_ALT "Alt" -</programlisting> -<para> -Used in <link linkend="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS"><type>DBUSMENU_MENUITEM_PROP_SHORTCUT</type></link> to represent the -alternate key. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SHORTCUT-CONTROL:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SHORTCUT_CONTROL</title> -<indexterm zone="DBUSMENU-MENUITEM-SHORTCUT-CONTROL:CAPS"><primary>DBUSMENU_MENUITEM_SHORTCUT_CONTROL</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SHORTCUT_CONTROL "Control" -</programlisting> -<para> -Used in <link linkend="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS"><type>DBUSMENU_MENUITEM_PROP_SHORTCUT</type></link> to represent the -control key. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SHORTCUT-SHIFT:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SHORTCUT_SHIFT</title> -<indexterm zone="DBUSMENU-MENUITEM-SHORTCUT-SHIFT:CAPS"><primary>DBUSMENU_MENUITEM_SHORTCUT_SHIFT</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SHORTCUT_SHIFT "Shift" -</programlisting> -<para> -Used in <link linkend="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS"><type>DBUSMENU_MENUITEM_PROP_SHORTCUT</type></link> to represent the -shift key. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-SHORTCUT-SUPER:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_SHORTCUT_SUPER</title> -<indexterm zone="DBUSMENU-MENUITEM-SHORTCUT-SUPER:CAPS"><primary>DBUSMENU_MENUITEM_SHORTCUT_SUPER</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_SHORTCUT_SUPER "Super" -</programlisting> -<para> -Used in <link linkend="DBUSMENU-MENUITEM-PROP-SHORTCUT:CAPS"><type>DBUSMENU_MENUITEM_PROP_SHORTCUT</type></link> to represent the -super key. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-EVENT-ACTIVATED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_EVENT_ACTIVATED</title> -<indexterm zone="DBUSMENU-MENUITEM-EVENT-ACTIVATED:CAPS"><primary>DBUSMENU_MENUITEM_EVENT_ACTIVATED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_EVENT_ACTIVATED "clicked" -</programlisting> -<para> -String for the event identifier when a menu item is clicked -on by the user. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-EVENT-CLOSED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_EVENT_CLOSED</title> -<indexterm zone="DBUSMENU-MENUITEM-EVENT-CLOSED:CAPS"><primary>DBUSMENU_MENUITEM_EVENT_CLOSED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_EVENT_CLOSED "closed" -</programlisting> -<para> -String for the event identifier when a menu is closed and -displayed to the user. Only valid for items that contain -submenus. -</para></refsect2> -<refsect2 id="DBUSMENU-MENUITEM-EVENT-OPENED:CAPS" role="macro"> -<title>DBUSMENU_MENUITEM_EVENT_OPENED</title> -<indexterm zone="DBUSMENU-MENUITEM-EVENT-OPENED:CAPS"><primary>DBUSMENU_MENUITEM_EVENT_OPENED</primary></indexterm> -<programlisting>#define DBUSMENU_MENUITEM_EVENT_OPENED "opened" -</programlisting> -<para> -String for the event identifier when a menu is opened and -displayed to the user. Only valid for items that contain -submenus. -</para></refsect2> -<refsect2 id="DbusmenuMenuitem" role="struct"> -<title>struct DbusmenuMenuitem</title> -<indexterm zone="DbusmenuMenuitem"><primary>DbusmenuMenuitem</primary></indexterm> -<programlisting>struct DbusmenuMenuitem { - GObject parent; - - /*< Private >*/ - DbusmenuMenuitemPrivate * priv; -}; -</programlisting> -<para> -This is the <link linkend="GObject"><type>GObject</type></link> based object that represents a menu -item. It gets created the same on both the client and -the server side and libdbusmenu-glib does the work of making -this object model appear on both sides of DBus. Simple -really, though through updates and people coming on and off -the bus it can lead to lots of fun complex scenarios. -</para><variablelist role="struct"> -<varlistentry><term><link linkend="GObject"><type>GObject</type></link> <structfield id="DbusmenuMenuitem.parent">parent</structfield>;</term> -<listitem><simpara>Parent object</simpara></listitem> -</varlistentry> -<varlistentry><term><link linkend="DbusmenuMenuitemPrivate"><type>DbusmenuMenuitemPrivate</type></link> *<structfield id="DbusmenuMenuitem.priv">priv</structfield>;</term> -<listitem><simpara>Private data</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-about-to-show-cb" role="function"> -<title>dbusmenu_menuitem_about_to_show_cb ()</title> -<indexterm zone="dbusmenu-menuitem-about-to-show-cb"><primary>dbusmenu_menuitem_about_to_show_cb</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*dbusmenu_menuitem_about_to_show_cb) - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting> -<para> -Callback prototype for a callback that is called when the -menu should be shown. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>Menu item that should be shown</simpara></listitem></varlistentry> -<varlistentry><term><parameter>user_data</parameter> :</term> -<listitem><simpara>Extra user data sent with the function. <emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-buildvariant-slot-t" role="function"> -<title>dbusmenu_menuitem_buildvariant_slot_t ()</title> -<indexterm zone="dbusmenu-menuitem-buildvariant-slot-t"><primary>dbusmenu_menuitem_buildvariant_slot_t</primary></indexterm> -<programlisting><link linkend="GVariant"><returnvalue>GVariant</returnvalue></link> * (*dbusmenu_menuitem_buildvariant_slot_t) - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gchar"><type>gchar</type></link> **properties</parameter>);</programlisting> -<para> -This is the function that is called to represent this menu item -as a variant. Should call it's own children. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>Menu item that should be built from. <emphasis role="annotation">[<acronym>in</acronym>]</emphasis></simpara></listitem></varlistentry> -<varlistentry><term><parameter>properties</parameter> :</term> -<listitem><simpara>A list of properties that should be the only ones in the resulting variant structure. <emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A variant representing this item and it's children. <emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="DbusmenuMenuitemClass" role="struct"> -<title>struct DbusmenuMenuitemClass</title> -<indexterm zone="DbusmenuMenuitemClass"><primary>DbusmenuMenuitemClass</primary></indexterm> -<programlisting>struct DbusmenuMenuitemClass { - GObjectClass parent_class; - - /* Signals */ - void (*property_changed) (gchar * property, GVariant * value); - void (*item_activated) (guint timestamp); - void (*child_added) (DbusmenuMenuitem * child, guint position); - void (*child_removed) (DbusmenuMenuitem * child); - void (*child_moved) (DbusmenuMenuitem * child, guint newpos, guint oldpos); - void (*realized) (void); - - /* Virtual functions */ - dbusmenu_menuitem_buildvariant_slot_t buildvariant; - void (*handle_event) (DbusmenuMenuitem * mi, const gchar * name, GVariant * variant, guint timestamp); - void (*send_about_to_show) (DbusmenuMenuitem * mi, void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), gpointer cb_data); - - void (*show_to_user) (DbusmenuMenuitem * mi, guint timestamp, gpointer cb_data); - gboolean (*about_to_show) (void); - - void (*event) (const gchar * name, GVariant * value, guint timestamp); - - /*< Private >*/ - void (*reserved1) (void); - void (*reserved2) (void); - void (*reserved3) (void); - void (*reserved4) (void); - void (*reserved5) (void); -}; -</programlisting> -<para> -Functions and signals that every menuitem should know something -about. -</para><variablelist role="struct"> -<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="DbusmenuMenuitemClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara>Functions and signals from our parent</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.property-changed">property_changed</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-property-changed"><type>"property-changed"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.item-activated">item_activated</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-item-activated"><type>"item-activated"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.child-added">child_added</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-child-added"><type>"child-added"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.child-removed">child_removed</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-child-removed"><type>"child-removed"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.child-moved">child_moved</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-child-moved"><type>"child-moved"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.realized">realized</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-realized"><type>"realized"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><link linkend="dbusmenu-menuitem-buildvariant-slot-t"><type>dbusmenu_menuitem_buildvariant_slot_t</type></link> <structfield id="DbusmenuMenuitemClass.buildvariant">buildvariant</structfield>;</term> -<listitem><simpara>Virtual function that appends the strings required to represent this menu item in the menu variant.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.handle-event">handle_event</structfield> ()</term> -<listitem><simpara>This function is to override how events are handled by subclasses. Look at <link linkend="dbusmenu-menuitem-handle-event"><type>dbusmenu_menuitem_handle_event</type></link> for lots of good information.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.show-to-user">show_to_user</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-show-to-user"><type>"show-to-user"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.about-to-show">about_to_show</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-about-to-show"><type>"about-to-show"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.event">event</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbsumenuMenuitem-event"><type>"event"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-new" role="function"> -<title>dbusmenu_menuitem_new ()</title> -<indexterm zone="dbusmenu-menuitem-new"><primary>dbusmenu_menuitem_new</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_new (<parameter><type>void</type></parameter>);</programlisting> -<para> -Create a new <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> with all default values. -</para><variablelist role="params"> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A newly allocated <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-new-with-id" role="function"> -<title>dbusmenu_menuitem_new_with_id ()</title> -<indexterm zone="dbusmenu-menuitem-new-with-id"><primary>dbusmenu_menuitem_new_with_id</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_new_with_id (<parameter><link linkend="gint"><type>gint</type></link> id</parameter>);</programlisting> -<para> -This creates a blank <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> with a specific ID. -</para><variablelist role="params"> -<varlistentry><term><parameter>id</parameter> :</term> -<listitem><simpara>ID to use for this menuitem</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A newly allocated <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-get-id" role="function"> -<title>dbusmenu_menuitem_get_id ()</title> -<indexterm zone="dbusmenu-menuitem-get-id"><primary>dbusmenu_menuitem_get_id</primary></indexterm> -<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> dbusmenu_menuitem_get_id (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -Gets the unique ID for <parameter>mi</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to query.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The ID of the <parameter>mi</parameter>.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-get-children" role="function"> -<title>dbusmenu_menuitem_get_children ()</title> -<indexterm zone="dbusmenu-menuitem-get-children"><primary>dbusmenu_menuitem_get_children</primary></indexterm> -<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> * dbusmenu_menuitem_get_children (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -Returns simply the list of children that this menu item -has. The list is valid until another child related function -is called, where it might be changed. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to query.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A <link linkend="GList"><type>GList</type></link> of pointers to <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-take-children" role="function"> -<title>dbusmenu_menuitem_take_children ()</title> -<indexterm zone="dbusmenu-menuitem-take-children"><primary>dbusmenu_menuitem_take_children</primary></indexterm> -<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> * dbusmenu_menuitem_take_children (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -While the name sounds devious that's exactly what this function -does. It takes the list of children from the <parameter>mi</parameter> and clears the -internal list. The calling function is now in charge of the ref's -on the children it has taken. A lot of responsibility involved -in taking children. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenMenuitem"><type>DbusmenMenuitem</type></link> to take the children from.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A <link linkend="GList"><type>GList</type></link> of pointers to <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects. <emphasis role="annotation">[<acronym>transfer full</acronym>][<acronym>element-type</acronym> Dbusmenu.Menuitem]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-get-position" role="function"> -<title>dbusmenu_menuitem_get_position ()</title> -<indexterm zone="dbusmenu-menuitem-get-position"><primary>dbusmenu_menuitem_get_position</primary></indexterm> -<programlisting><link linkend="guint"><returnvalue>guint</returnvalue></link> dbusmenu_menuitem_get_position (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>);</programlisting> -<para> -This function returns the position of the menu item <parameter>mi</parameter> -in the children of <parameter>parent</parameter>. It will return zero if the -menu item can't be found. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to find the position of</simpara></listitem></varlistentry> -<varlistentry><term><parameter>parent</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> who's children contain <parameter>mi</parameter></simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The position of <parameter>mi</parameter> in the children of <parameter>parent</parameter>.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-get-position-realized" role="function"> -<title>dbusmenu_menuitem_get_position_realized ()</title> -<indexterm zone="dbusmenu-menuitem-get-position-realized"><primary>dbusmenu_menuitem_get_position_realized</primary></indexterm> -<programlisting><link linkend="guint"><returnvalue>guint</returnvalue></link> dbusmenu_menuitem_get_position_realized - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>);</programlisting> -<para> -This function is very similar to <link linkend="dbusmenu-menuitem-get-position"><type>dbusmenu_menuitem_get_position</type></link> -except that it only counts in the children that have been realized. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to find the position of</simpara></listitem></varlistentry> -<varlistentry><term><parameter>parent</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> who's children contain <parameter>mi</parameter></simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The position of <parameter>mi</parameter> in the realized children of <parameter>parent</parameter>.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-child-append" role="function"> -<title>dbusmenu_menuitem_child_append ()</title> -<indexterm zone="dbusmenu-menuitem-child-append"><primary>dbusmenu_menuitem_child_append</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_append (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>);</programlisting> -<para> -This function adds <parameter>child</parameter> to the list of children on <parameter>mi</parameter> at -the end of that list. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which will become a new parent</simpara></listitem></varlistentry> -<varlistentry><term><parameter>child</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenMenuitem"><type>DbusmenMenuitem</type></link> that will be a child</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether the child has been added successfully.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-child-prepend" role="function"> -<title>dbusmenu_menuitem_child_prepend ()</title> -<indexterm zone="dbusmenu-menuitem-child-prepend"><primary>dbusmenu_menuitem_child_prepend</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_prepend (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>);</programlisting> -<para> -This function adds <parameter>child</parameter> to the list of children on <parameter>mi</parameter> at -the beginning of that list. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which will become a new parent</simpara></listitem></varlistentry> -<varlistentry><term><parameter>child</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenMenuitem"><type>DbusmenMenuitem</type></link> that will be a child</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether the child has been added successfully.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-child-delete" role="function"> -<title>dbusmenu_menuitem_child_delete ()</title> -<indexterm zone="dbusmenu-menuitem-child-delete"><primary>dbusmenu_menuitem_child_delete</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_delete (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>);</programlisting> -<para> -This function removes <parameter>child</parameter> from the children list of <parameter>mi</parameter>. It does -not call <link linkend="g-object-unref"><type>g_object_unref</type></link> on <parameter>child</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which has <parameter>child</parameter> as a child</simpara></listitem></varlistentry> -<varlistentry><term><parameter>child</parameter> :</term> -<listitem><simpara>The child <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that you want to no longer -be a child of <parameter>mi</parameter>.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>If we were able to delete <parameter>child</parameter>.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-child-add-position" role="function"> -<title>dbusmenu_menuitem_child_add_position ()</title> -<indexterm zone="dbusmenu-menuitem-child-add-position"><primary>dbusmenu_menuitem_child_add_position</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_add_position - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> position</parameter>);</programlisting> -<para> -Puts <parameter>child</parameter> in the list of children for <parameter>mi</parameter> at the location -specified in <parameter>position</parameter>. If there is not enough entires available -then <parameter>child</parameter> will be placed at the end of the list. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that we're adding the child <parameter>child</parameter> to.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>child</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to make a child of <parameter>mi</parameter>.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>position</parameter> :</term> -<listitem><simpara>Where in <parameter>mi</parameter> object's list of chidren <parameter>child</parameter> should be placed.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether <parameter>child</parameter> was added successfully.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-child-reorder" role="function"> -<title>dbusmenu_menuitem_child_reorder ()</title> -<indexterm zone="dbusmenu-menuitem-child-reorder"><primary>dbusmenu_menuitem_child_reorder</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_reorder (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> position</parameter>);</programlisting> -<para> -This function moves a child on the list of children. It is -for a child that is already in the list, but simply needs a -new location. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that has children needing realignment</simpara></listitem></varlistentry> -<varlistentry><term><parameter>child</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that is a child needing to be moved</simpara></listitem></varlistentry> -<varlistentry><term><parameter>position</parameter> :</term> -<listitem><simpara>The position in the list to place it in</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether the move was successful.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-child-find" role="function"> -<title>dbusmenu_menuitem_child_find ()</title> -<indexterm zone="dbusmenu-menuitem-child-find"><primary>dbusmenu_menuitem_child_find</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_child_find (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gint"><type>gint</type></link> id</parameter>);</programlisting> -<para> -Search the children of <parameter>mi</parameter> to find one with the ID of <parameter>id</parameter>. -If it doesn't exist then we return <link linkend="NULL:CAPS"><type>NULL</type></link>. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> who's children to look on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>id</parameter> :</term> -<listitem><simpara>The ID of the child that we're looking for.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The menu item with the ID <parameter>id</parameter> or <link linkend="NULL:CAPS"><type>NULL</type></link> if it -can't be found. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-find-id" role="function"> -<title>dbusmenu_menuitem_find_id ()</title> -<indexterm zone="dbusmenu-menuitem-find-id"><primary>dbusmenu_menuitem_find_id</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_find_id (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gint"><type>gint</type></link> id</parameter>);</programlisting> -<para> -This function searchs the whole tree of children that -are attached to <parameter>mi</parameter>. This could be quite a few nodes, all -the way down the tree. It is a depth first search. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> at the top of the tree to search</simpara></listitem></varlistentry> -<varlistentry><term><parameter>id</parameter> :</term> -<listitem><simpara>ID of the <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to search for</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> with the ID of <parameter>id</parameter> -or <link linkend="NULL:CAPS"><type>NULL</type></link> if there isn't such a menu item in the tree -represented by <parameter>mi</parameter>. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set" role="function"> -<title>dbusmenu_menuitem_property_set ()</title> -<indexterm zone="dbusmenu-menuitem-property-set"><primary>dbusmenu_menuitem_property_set</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting> -<para> -Takes the pair of <parameter>property</parameter> and <parameter>value</parameter> and places them as a -property on <parameter>mi</parameter>. If a property already exists by that name, -then the value is set to the new value. If not, the property -is added. If the value is changed or the property was previously -unset then the signal <link linkend="DbusmenuMenuitem-prop-changed"><type>"prop-changed"</type></link> will be -emitted by this function. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>Name of the property to set.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>value</parameter> :</term> -<listitem><simpara>The value of the property.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A boolean representing if the property value was set.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set-bool" role="function"> -<title>dbusmenu_menuitem_property_set_bool ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-bool"><primary>dbusmenu_menuitem_property_set_bool</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_bool (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter>const <link linkend="gboolean"><type>gboolean</type></link> value</parameter>);</programlisting> -<para> -Takes a boolean <parameter>value</parameter> and sets it on <parameter>property</parameter> as a -property on <parameter>mi</parameter>. If a property already exists by that name, -then the value is set to the new value. If not, the property -is added. If the value is changed or the property was previously -unset then the signal <link linkend="DbusmenuMenuitem-prop-changed"><type>"prop-changed"</type></link> will be -emitted by this function. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>Name of the property to set.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>value</parameter> :</term> -<listitem><simpara>The value of the property.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A boolean representing if the property value was set.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set-int" role="function"> -<title>dbusmenu_menuitem_property_set_int ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-int"><primary>dbusmenu_menuitem_property_set_int</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_int (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter>const <link linkend="gint"><type>gint</type></link> value</parameter>);</programlisting> -<para> -Takes a boolean <parameter>value</parameter> and sets it on <parameter>property</parameter> as a -property on <parameter>mi</parameter>. If a property already exists by that name, -then the value is set to the new value. If not, the property -is added. If the value is changed or the property was previously -unset then the signal <link linkend="DbusmenuMenuitem-prop-changed"><type>"prop-changed"</type></link> will be -emitted by this function. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>Name of the property to set.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>value</parameter> :</term> -<listitem><simpara>The value of the property.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A boolean representing if the property value was set.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set-variant" role="function"> -<title>dbusmenu_menuitem_property_set_variant ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-variant"><primary>dbusmenu_menuitem_property_set_variant</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_variant - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter><link linkend="GVariant"><type>GVariant</type></link> *value</parameter>);</programlisting> -<para> -Takes the pair of <parameter>property</parameter> and <parameter>value</parameter> and places them as a -property on <parameter>mi</parameter>. If a property already exists by that name, -then the value is set to the new value. If not, the property -is added. If the value is changed or the property was previously -unset then the signal <link linkend="DbusmenuMenuitem-prop-changed"><type>"prop-changed"</type></link> will be -emitted by this function. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>Name of the property to set.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>value</parameter> :</term> -<listitem><simpara>The value of the property.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A boolean representing if the property value was set.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-get" role="function"> -<title>dbusmenu_menuitem_property_get ()</title> -<indexterm zone="dbusmenu-menuitem-property-get"><primary>dbusmenu_menuitem_property_get</primary></indexterm> -<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * dbusmenu_menuitem_property_get (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> -<para> -Look up a property on <parameter>mi</parameter> and return the value of it if -it exits. <link linkend="NULL:CAPS"><type>NULL</type></link> will be returned if the property doesn't -exist. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>The property to grab.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A string with the value of the property -that shouldn't be free'd. Or <link linkend="NULL:CAPS"><type>NULL</type></link> if the property -is not set or is not a string. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-get-bool" role="function"> -<title>dbusmenu_menuitem_property_get_bool ()</title> -<indexterm zone="dbusmenu-menuitem-property-get-bool"><primary>dbusmenu_menuitem_property_get_bool</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_get_bool (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> -<para> -Look up a property on <parameter>mi</parameter> and return the value of it if -it exits. Returns <link linkend="FALSE:CAPS"><type>FALSE</type></link> if the property doesn't exist. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>The property to grab.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The value of the property or <link linkend="FALSE:CAPS"><type>FALSE</type></link>.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-get-int" role="function"> -<title>dbusmenu_menuitem_property_get_int ()</title> -<indexterm zone="dbusmenu-menuitem-property-get-int"><primary>dbusmenu_menuitem_property_get_int</primary></indexterm> -<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> dbusmenu_menuitem_property_get_int (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> -<para> -Look up a property on <parameter>mi</parameter> and return the value of it if -it exits. Returns zero if the property doesn't exist. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>The property to grab.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The value of the property or zero.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-get-variant" role="function"> -<title>dbusmenu_menuitem_property_get_variant ()</title> -<indexterm zone="dbusmenu-menuitem-property-get-variant"><primary>dbusmenu_menuitem_property_get_variant</primary></indexterm> -<programlisting><link linkend="GVariant"><returnvalue>GVariant</returnvalue></link> * dbusmenu_menuitem_property_get_variant - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> -<para> -Look up a property on <parameter>mi</parameter> and return the value of it if -it exits. <link linkend="NULL:CAPS"><type>NULL</type></link> will be returned if the property doesn't -exist. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>The property to grab.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A GVariant for the property. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-exist" role="function"> -<title>dbusmenu_menuitem_property_exist ()</title> -<indexterm zone="dbusmenu-menuitem-property-exist"><primary>dbusmenu_menuitem_property_exist</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_exist (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> -<para> -Checkes to see if a particular property exists on <parameter>mi</parameter> and -returns <link linkend="TRUE:CAPS"><type>TRUE</type></link> if so. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>The property to look for.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A boolean checking to see if the property is available</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-properties-list" role="function"> -<title>dbusmenu_menuitem_properties_list ()</title> -<indexterm zone="dbusmenu-menuitem-properties-list"><primary>dbusmenu_menuitem_properties_list</primary></indexterm> -<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> * dbusmenu_menuitem_properties_list (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -This functiong gets a list of the names of all the properties -that are set on this menu item. This data on the list is owned -by the menuitem but the list is not and should be freed using -<link linkend="g-list-free"><function>g_list_free()</function></link> when the calling function is done with it. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to list the properties on</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A list of strings or NULL if there are -none. <emphasis role="annotation">[<acronym>transfer container</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-properties-copy" role="function"> -<title>dbusmenu_menuitem_properties_copy ()</title> -<indexterm zone="dbusmenu-menuitem-properties-copy"><primary>dbusmenu_menuitem_properties_copy</primary></indexterm> -<programlisting><link linkend="GHashTable"><returnvalue>GHashTable</returnvalue></link> * dbusmenu_menuitem_properties_copy (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -This function takes the properties of a <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> -and puts them into a <link linkend="GHashTable"><type>GHashTable</type></link> that is referenced by the -key of a string and has the value of a string. The hash -table may not have any entries if there aren't any or there -is an error in processing. It is the caller's responsibility -to destroy the created <link linkend="GHashTable"><type>GHashTable</type></link>. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that we're interested in the properties of</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A brand new <link linkend="GHashTable"><type>GHashTable</type></link> that contains all of -theroperties that are on this <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> <parameter>mi</parameter>. <emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-remove" role="function"> -<title>dbusmenu_menuitem_property_remove ()</title> -<indexterm zone="dbusmenu-menuitem-property-remove"><primary>dbusmenu_menuitem_property_remove</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_property_remove (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> -<para> -Removes a property from the menuitem. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to remove the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>The property to look for.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-set-root" role="function"> -<title>dbusmenu_menuitem_set_root ()</title> -<indexterm zone="dbusmenu-menuitem-set-root"><primary>dbusmenu_menuitem_set_root</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_set_root (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="gboolean"><type>gboolean</type></link> root</parameter>);</programlisting> -<para> -This function sets the internal value of whether this is a -root node or not. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set whether it's root</simpara></listitem></varlistentry> -<varlistentry><term><parameter>root</parameter> :</term> -<listitem><simpara>Whether <parameter>mi</parameter> is a root node or not</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-get-root" role="function"> -<title>dbusmenu_menuitem_get_root ()</title> -<indexterm zone="dbusmenu-menuitem-get-root"><primary>dbusmenu_menuitem_get_root</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_get_root (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -This function returns the internal value of whether this is a -root node or not. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to see whether it's root</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><link linkend="TRUE:CAPS"><type>TRUE</type></link> if this is a root node</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-foreach" role="function"> -<title>dbusmenu_menuitem_foreach ()</title> -<indexterm zone="dbusmenu-menuitem-foreach"><primary>dbusmenu_menuitem_foreach</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_foreach (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="void"><type>void</type></link> (*func) (DbusmenuMenuitem * mi, gpointer data)</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting> -<para> -This calls the function <parameter>func</parameter> on this menu item and all -of the children of this item. And their children. And -their children. And... you get the point. It will get -called on the whole tree. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenItem"><type>DbusmenItem</type></link> to start from</simpara></listitem></varlistentry> -<varlistentry><term><parameter>func</parameter> :</term> -<listitem><simpara>Function to call on every node in the tree</simpara></listitem></varlistentry> -<varlistentry><term><parameter>data</parameter> :</term> -<listitem><simpara>User data to pass to the function. <emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-handle-event" role="function"> -<title>dbusmenu_menuitem_handle_event ()</title> -<indexterm zone="dbusmenu-menuitem-handle-event"><primary>dbusmenu_menuitem_handle_event</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_handle_event (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, - <parameter><link linkend="GVariant"><type>GVariant</type></link> *variant</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>);</programlisting> -<para> -This function is called to create an event. It is likely -to be overrided by subclasses. The default menu item -will respond to the activate signal and do: -</para> -<para> -Emits the <link linkend="DbusmenuMenuitem-item-activate"><type>"item-activate"</type></link> signal on this -menu item. Called by server objects when they get the -appropriate DBus signals from the client. -</para> -<para> -If you subclass this function you should really think -about calling the parent function unless you have a good -reason not to. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to send the signal on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>name</parameter> :</term> -<listitem><simpara>The name of the signal</simpara></listitem></varlistentry> -<varlistentry><term><parameter>variant</parameter> :</term> -<listitem><simpara>A value that could be set for the event</simpara></listitem></varlistentry> -<varlistentry><term><parameter>timestamp</parameter> :</term> -<listitem><simpara>The timestamp of when the event happened</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-send-about-to-show" role="function"> -<title>dbusmenu_menuitem_send_about_to_show ()</title> -<indexterm zone="dbusmenu-menuitem-send-about-to-show"><primary>dbusmenu_menuitem_send_about_to_show</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_send_about_to_show - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="void"><type>void</type></link> (*cb) (DbusmenuMenuitem * mi, gpointer user_data)</parameter>, - <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>);</programlisting> -<para> -This function is used to send the even that the submenu -of this item is about to be shown. Callers to this event -should delay showing the menu until their callback is -called if possible. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to send the signal on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>cb</parameter> :</term> -<listitem><simpara>Callback to call when the call has returned.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>cb_data</parameter> :</term> -<listitem><simpara>Data to pass to the callback. <emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-show-to-user" role="function"> -<title>dbusmenu_menuitem_show_to_user ()</title> -<indexterm zone="dbusmenu-menuitem-show-to-user"><primary>dbusmenu_menuitem_show_to_user</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_show_to_user (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>);</programlisting> -<para> -Signals that this menu item should be shown to the user. If this is -server side the server will then take it and send it over the -bus. -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to show</simpara></listitem></varlistentry> -<varlistentry><term><parameter>timestamp</parameter> :</term> -<listitem><simpara>The time that the user requested it to be shown</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-get-parent" role="function"> -<title>dbusmenu_menuitem_get_parent ()</title> -<indexterm zone="dbusmenu-menuitem-get-parent"><primary>dbusmenu_menuitem_get_parent</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_get_parent (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -This function looks up the parent of <parameter>mi</parameter> -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> for which to inspect the parent</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The parent of this menu item. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-set-parent" role="function"> -<title>dbusmenu_menuitem_set_parent ()</title> -<indexterm zone="dbusmenu-menuitem-set-parent"><primary>dbusmenu_menuitem_set_parent</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_set_parent (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>);</programlisting> -<para> -Sets the parent of <parameter>mi</parameter> to <parameter>parent</parameter>. If <parameter>mi</parameter> already -has a parent, then this call will fail. The parent will -be set automatically when using the usual methods to add a -child menuitem, so this function should not normally be -called directly -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> for which to set the parent</simpara></listitem></varlistentry> -<varlistentry><term><parameter>parent</parameter> :</term> -<listitem><simpara>The new parent <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link></simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether the parent was set successfully</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-unparent" role="function"> -<title>dbusmenu_menuitem_unparent ()</title> -<indexterm zone="dbusmenu-menuitem-unparent"><primary>dbusmenu_menuitem_unparent</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_unparent (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -Unparents the menu item <parameter>mi</parameter>. If <parameter>mi</parameter> doesn't have a -parent, then this call will fail. The menuitem will -be unparented automatically when using the usual methods -to delete a child menuitem, so this function should not -normally be called directly -</para><variablelist role="params"> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to unparent</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether the menu item was unparented successfully</simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/server.xml b/docs/libdbusmenu-glib/reference/xml/server.xml deleted file mode 100644 index de93198..0000000 --- a/docs/libdbusmenu-glib/reference/xml/server.xml +++ /dev/null @@ -1,309 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-glib-DbusmenuServer"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-glib-DbusmenuServer.top_of_page">DbusmenuServer</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GLIB Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>DbusmenuServer</refname> -<refpurpose>The server signals changed and - updates on a tree of <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objecs.</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-glib-DbusmenuServer.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-glib-DbusmenuServer.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-glib/server.h> - -#define <link linkend="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</link> -#define <link linkend="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_UPDATE</link> -#define <link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</link> -#define <link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</link> -#define <link linkend="DBUSMENU-SERVER-SIGNAL-ITEM-ACTIVATION:CAPS">DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION</link> -#define <link linkend="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS">DBUSMENU_SERVER_PROP_DBUS_OBJECT</link> -#define <link linkend="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS">DBUSMENU_SERVER_PROP_ROOT_NODE</link> -#define <link linkend="DBUSMENU-SERVER-PROP-STATUS:CAPS">DBUSMENU_SERVER_PROP_STATUS</link> -#define <link linkend="DBUSMENU-SERVER-PROP-TEXT-DIRECTION:CAPS">DBUSMENU_SERVER_PROP_TEXT_DIRECTION</link> -#define <link linkend="DBUSMENU-SERVER-PROP-VERSION:CAPS">DBUSMENU_SERVER_PROP_VERSION</link> - <link linkend="DbusmenuServer">DbusmenuServer</link>; -struct <link linkend="DbusmenuServerClass">DbusmenuServerClass</link>; -<link linkend="DbusmenuServer"><returnvalue>DbusmenuServer</returnvalue></link> * <link linkend="dbusmenu-server-new">dbusmenu_server_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>); -<link linkend="DbusmenuStatus"><returnvalue>DbusmenuStatus</returnvalue></link> <link linkend="dbusmenu-server-get-status">dbusmenu_server_get_status</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>); -<link linkend="DbusmenuTextDirection"><returnvalue>DbusmenuTextDirection</returnvalue></link> <link linkend="dbusmenu-server-get-text-direction">dbusmenu_server_get_text_direction</link> - (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-server-set-root">dbusmenu_server_set_root</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *self</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *root</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-server-set-status">dbusmenu_server_set_status</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, - <parameter><link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> status</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-server-set-text-direction">dbusmenu_server_set_text_direction</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, - <parameter><link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> dir</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-glib-DbusmenuServer.description" role="desc"> -<title role="desc.title">Description</title> -<para> -A <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> is the object that represents the local - tree of <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects on DBus. It watches the - various signals that those objects emit and correctly - represents them across DBus to a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> so that - the same tree can be maintained in another process. -</para> -<para> - The server needs to have the root set of <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> - objects set via <link linkend="dbusmenu-server-set-root"><type>dbusmenu_server_set_root</type></link> but it will query - all of the objects in that tree automatically. After setting - the root there should be no other maintence required by - users of the server class. -</para> -</refsect1> -<refsect1 id="libdbusmenu-glib-DbusmenuServer.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE "item-property-updated" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-item-property-updated"><type>"item-property-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE "item-updated" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-item-updated"><type>"item-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED "layout-updated" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-layout-updated"><type>"layout-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-layout-updated"><type>"layout-updated"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-SIGNAL-ITEM-ACTIVATION:CAPS" role="macro"> -<title>DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION</title> -<indexterm zone="DBUSMENU-SERVER-SIGNAL-ITEM-ACTIVATION:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION "item-activation-requested" -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuServer-item-activation-requested"><type>"item-activation-requested"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_DBUS_OBJECT</title> -<indexterm zone="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS"><primary>DBUSMENU_SERVER_PROP_DBUS_OBJECT</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_DBUS_OBJECT "dbus-object" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--dbus-object"><type>"dbus-object"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_ROOT_NODE</title> -<indexterm zone="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS"><primary>DBUSMENU_SERVER_PROP_ROOT_NODE</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--root-node"><type>"root-node"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-STATUS:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_STATUS</title> -<indexterm zone="DBUSMENU-SERVER-PROP-STATUS:CAPS"><primary>DBUSMENU_SERVER_PROP_STATUS</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_STATUS "status" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--status"><type>"status"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-TEXT-DIRECTION:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_TEXT_DIRECTION</title> -<indexterm zone="DBUSMENU-SERVER-PROP-TEXT-DIRECTION:CAPS"><primary>DBUSMENU_SERVER_PROP_TEXT_DIRECTION</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_TEXT_DIRECTION "text-direction" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--text-direction"><type>"text-direction"</type></link> -</para></refsect2> -<refsect2 id="DBUSMENU-SERVER-PROP-VERSION:CAPS" role="macro"> -<title>DBUSMENU_SERVER_PROP_VERSION</title> -<indexterm zone="DBUSMENU-SERVER-PROP-VERSION:CAPS"><primary>DBUSMENU_SERVER_PROP_VERSION</primary></indexterm> -<programlisting>#define DBUSMENU_SERVER_PROP_VERSION "version" -</programlisting> -<para> -String to access property <link linkend="DbusmenuServer--version"><type>"version"</type></link> -</para></refsect2> -<refsect2 id="DbusmenuServer" role="struct"> -<title>DbusmenuServer</title> -<indexterm zone="DbusmenuServer"><primary>DbusmenuServer</primary></indexterm> -<programlisting>typedef struct _DbusmenuServer DbusmenuServer;</programlisting> -<para> -A server which represents a sharing of a set of - <link linkend="DbusmenuMenuitems"><type>DbusmenuMenuitems</type></link> across DBus to a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link>. -</para></refsect2> -<refsect2 id="DbusmenuServerClass" role="struct"> -<title>struct DbusmenuServerClass</title> -<indexterm zone="DbusmenuServerClass"><primary>DbusmenuServerClass</primary></indexterm> -<programlisting>struct DbusmenuServerClass { - GObjectClass parent_class; - - /* Signals */ - void (*id_prop_update)(gint id, gchar * property, gchar * value); - void (*id_update)(gint id); - void (*layout_updated)(gint revision); - void (*item_activation)(gint id, guint timestamp); - - /*< Private >*/ - void (*reserved1) (void); - void (*reserved2) (void); - void (*reserved3) (void); - void (*reserved4) (void); - void (*reserved5) (void); - void (*reserved6) (void); -}; -</programlisting> -<para> -The class implementing the virtual functions for <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>. -</para><variablelist role="struct"> -<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="DbusmenuServerClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara><link linkend="GObjectClass"><type>GObjectClass</type></link></simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.id-prop-update">id_prop_update</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuServer-id-prop-update"><type>"id-prop-update"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.id-update">id_update</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuServer-id-update"><type>"id-update"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.layout-updated">layout_updated</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuServer-layout-update"><type>"layout-update"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.item-activation">item_activation</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuServer-item-activation-requested"><type>"item-activation-requested"</type></link>.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuServerClass.reserved6">reserved6</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-new" role="function"> -<title>dbusmenu_server_new ()</title> -<indexterm zone="dbusmenu-server-new"><primary>dbusmenu_server_new</primary></indexterm> -<programlisting><link linkend="DbusmenuServer"><returnvalue>DbusmenuServer</returnvalue></link> * dbusmenu_server_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>);</programlisting> -<para> -Creates a new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object with a specific object - path on DBus. If <parameter>object</parameter> is set to NULL the default object - name of "/com/canonical/dbusmenu" will be used. -</para><variablelist role="params"> -<varlistentry><term><parameter>object</parameter> :</term> -<listitem><simpara>The object name to show for this menu structure -on DBus. May be NULL.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A brand new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-get-status" role="function"> -<title>dbusmenu_server_get_status ()</title> -<indexterm zone="dbusmenu-server-get-status"><primary>dbusmenu_server_get_status</primary></indexterm> -<programlisting><link linkend="DbusmenuStatus"><returnvalue>DbusmenuStatus</returnvalue></link> dbusmenu_server_get_status (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>);</programlisting> -<para> -Gets the current statust hat the server is sending out over - DBus. -</para><variablelist role="params"> -<varlistentry><term><parameter>server</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> to get the status from</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The current status the server is sending</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-get-text-direction" role="function"> -<title>dbusmenu_server_get_text_direction ()</title> -<indexterm zone="dbusmenu-server-get-text-direction"><primary>dbusmenu_server_get_text_direction</primary></indexterm> -<programlisting><link linkend="DbusmenuTextDirection"><returnvalue>DbusmenuTextDirection</returnvalue></link> dbusmenu_server_get_text_direction - (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>);</programlisting> -<para> -Returns the value of the text direction that is being exported - over DBus for this server. It should relate to the direction - of the labels and other text fields that are being exported by - this server. -</para><variablelist role="params"> -<varlistentry><term><parameter>server</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object to get the text direction from</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Text direction exported for this server.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-set-root" role="function"> -<title>dbusmenu_server_set_root ()</title> -<indexterm zone="dbusmenu-server-set-root"><primary>dbusmenu_server_set_root</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_server_set_root (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *self</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *root</parameter>);</programlisting> -<para> -This function contains all of the <link linkend="GValue"><type>GValue</type></link> wrapping - required to set the property <link linkend="DbusmenuServer--root-node"><type>"root-node"</type></link> - on the server <parameter>self</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>self</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object to set the root on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>root</parameter> :</term> -<listitem><simpara>The new root <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> tree</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-set-status" role="function"> -<title>dbusmenu_server_set_status ()</title> -<indexterm zone="dbusmenu-server-set-status"><primary>dbusmenu_server_set_status</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_server_set_status (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, - <parameter><link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> status</parameter>);</programlisting> -<para> -Changes the status of the server. -</para><variablelist role="params"> -<varlistentry><term><parameter>server</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> to set the status on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>status</parameter> :</term> -<listitem><simpara>Status value to set on the server</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-server-set-text-direction" role="function"> -<title>dbusmenu_server_set_text_direction ()</title> -<indexterm zone="dbusmenu-server-set-text-direction"><primary>dbusmenu_server_set_text_direction</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_server_set_text_direction (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, - <parameter><link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> dir</parameter>);</programlisting> -<para> -Sets the text direction that should be exported over DBus for - this server. If the value is set to <link linkend="DBUSMENU-TEXT-DIRECTION-NONE:CAPS"><type>DBUSMENU_TEXT_DIRECTION_NONE</type></link> - the default detection will be used for setting the value and - exported over DBus. -</para><variablelist role="params"> -<varlistentry><term><parameter>server</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object to set the text direction on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>dir</parameter> :</term> -<listitem><simpara>Direction of the text</simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/types.xml b/docs/libdbusmenu-glib/reference/xml/types.xml deleted file mode 100644 index c9a04ba..0000000 --- a/docs/libdbusmenu-glib/reference/xml/types.xml +++ /dev/null @@ -1,190 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-glib-Types"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-glib-Types.top_of_page">Types</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GLIB Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>Types</refname> -<refpurpose>Types that are used by both client and - server.</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-glib-Types.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-glib-Types.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-glib/types.h> - -#define <link linkend="DBUSMENU-TYPE-STATUS:CAPS">DBUSMENU_TYPE_STATUS</link> -#define <link linkend="DBUSMENU-TYPE-TEXT-DIRECTION:CAPS">DBUSMENU_TYPE_TEXT_DIRECTION</link> -enum <link linkend="DbusmenuStatus">DbusmenuStatus</link>; -enum <link linkend="DbusmenuTextDirection">DbusmenuTextDirection</link>; -const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="dbusmenu-status-get-nick">dbusmenu_status_get_nick</link> (<parameter><link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> value</parameter>); -<link linkend="GType"><returnvalue>GType</returnvalue></link> <link linkend="dbusmenu-status-get-type">dbusmenu_status_get_type</link> (<parameter><type>void</type></parameter>); -<link linkend="DbusmenuStatus"><returnvalue>DbusmenuStatus</returnvalue></link> <link linkend="dbusmenu-status-get-value-from-nick">dbusmenu_status_get_value_from_nick</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *nick</parameter>); -const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="dbusmenu-text-direction-get-nick">dbusmenu_text_direction_get_nick</link> (<parameter><link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> value</parameter>); -<link linkend="GType"><returnvalue>GType</returnvalue></link> <link linkend="dbusmenu-text-direction-get-type">dbusmenu_text_direction_get_type</link> (<parameter><type>void</type></parameter>); -<link linkend="DbusmenuTextDirection"><returnvalue>DbusmenuTextDirection</returnvalue></link> <link linkend="dbusmenu-text-direction-get-value-from-nick">dbusmenu_text_direction_get_value_from_nick</link> - (<parameter>const <link linkend="gchar"><type>gchar</type></link> *nick</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-glib-Types.description" role="desc"> -<title role="desc.title">Description</title> -<para> -Enums that are used to describe states of the server across the - bus. They are sent over dbus using their nicks but then turned - back into enums by the client. -</para> -</refsect1> -<refsect1 id="libdbusmenu-glib-Types.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DBUSMENU-TYPE-STATUS:CAPS" role="macro"> -<title>DBUSMENU_TYPE_STATUS</title> -<indexterm zone="DBUSMENU-TYPE-STATUS:CAPS"><primary>DBUSMENU_TYPE_STATUS</primary></indexterm> -<programlisting>#define DBUSMENU_TYPE_STATUS (dbusmenu_status_get_type()) -</programlisting> -<para> -Gets the <link linkend="GType"><type>GType</type></link> value for the type associated with the - <link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> enumerated type. -</para></refsect2> -<refsect2 id="DBUSMENU-TYPE-TEXT-DIRECTION:CAPS" role="macro"> -<title>DBUSMENU_TYPE_TEXT_DIRECTION</title> -<indexterm zone="DBUSMENU-TYPE-TEXT-DIRECTION:CAPS"><primary>DBUSMENU_TYPE_TEXT_DIRECTION</primary></indexterm> -<programlisting>#define DBUSMENU_TYPE_TEXT_DIRECTION (dbusmenu_text_direction_get_type()) -</programlisting> -<para> -Gets the <link linkend="GType"><type>GType</type></link> value for the type associated with the - <link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> enumerated type. -</para></refsect2> -<refsect2 id="DbusmenuStatus" role="enum"> -<title>enum DbusmenuStatus</title> -<indexterm zone="DbusmenuStatus"><primary>DbusmenuStatus</primary></indexterm> -<programlisting>typedef enum { /*< prefix=DBUSMENU_STATUS >*/ - DBUSMENU_STATUS_NORMAL, /*< nick=normal >*/ - DBUSMENU_STATUS_NOTICE /*< nick=notice >*/ -} DbusmenuStatus; -</programlisting> -<para> -Tracks how the menus should be presented to the user. -</para><variablelist role="enum"> -<varlistentry id="DBUSMENU-STATUS-NORMAL:CAPS" role="constant"> -<term><literal>DBUSMENU_STATUS_NORMAL</literal></term> -<listitem><simpara>Everything is normal -</simpara></listitem> -</varlistentry> -<varlistentry id="DBUSMENU-STATUS-NOTICE:CAPS" role="constant"> -<term><literal>DBUSMENU_STATUS_NOTICE</literal></term> -<listitem><simpara>The menus should be shown at a higher priority -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="DbusmenuTextDirection" role="enum"> -<title>enum DbusmenuTextDirection</title> -<indexterm zone="DbusmenuTextDirection"><primary>DbusmenuTextDirection</primary></indexterm> -<programlisting>typedef enum { /*< prefix=DBUSMENU_TEXT_DIRECTION >*/ - DBUSMENU_TEXT_DIRECTION_NONE, /*< nick=none >*/ - DBUSMENU_TEXT_DIRECTION_LTR, /*< nick=ltr >*/ - DBUSMENU_TEXT_DIRECTION_RTL /*< nick=rtl >*/ -} DbusmenuTextDirection; -</programlisting> -<para> -The direction of text that the strings that this server - will be sending strings as. -</para><variablelist role="enum"> -<varlistentry id="DBUSMENU-TEXT-DIRECTION-NONE:CAPS" role="constant"> -<term><literal>DBUSMENU_TEXT_DIRECTION_NONE</literal></term> -<listitem><simpara>Unspecified text direction -</simpara></listitem> -</varlistentry> -<varlistentry id="DBUSMENU-TEXT-DIRECTION-LTR:CAPS" role="constant"> -<term><literal>DBUSMENU_TEXT_DIRECTION_LTR</literal></term> -<listitem><simpara>Left-to-right text direction -</simpara></listitem> -</varlistentry> -<varlistentry id="DBUSMENU-TEXT-DIRECTION-RTL:CAPS" role="constant"> -<term><literal>DBUSMENU_TEXT_DIRECTION_RTL</literal></term> -<listitem><simpara>Right-to-left text direction -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-status-get-nick" role="function"> -<title>dbusmenu_status_get_nick ()</title> -<indexterm zone="dbusmenu-status-get-nick"><primary>dbusmenu_status_get_nick</primary></indexterm> -<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * dbusmenu_status_get_nick (<parameter><link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> value</parameter>);</programlisting> -<para> -Looks up in the enum table for the nick of <parameter>value</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>value</parameter> :</term> -<listitem><simpara>The value of DbusmenuStatus to get the nick of</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The nick for the given value or <link linkend="NULL:CAPS"><type>NULL</type></link> on error</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-status-get-type" role="function"> -<title>dbusmenu_status_get_type ()</title> -<indexterm zone="dbusmenu-status-get-type"><primary>dbusmenu_status_get_type</primary></indexterm> -<programlisting><link linkend="GType"><returnvalue>GType</returnvalue></link> dbusmenu_status_get_type (<parameter><type>void</type></parameter>);</programlisting> -<para> -Builds a GLib type for the <link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> enumeration. -</para><variablelist role="params"> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A unique <link linkend="GType"><type>GType</type></link> for the <link linkend="DbusmenuStatus"><type>DbusmenuStatus</type></link> enum.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-status-get-value-from-nick" role="function"> -<title>dbusmenu_status_get_value_from_nick ()</title> -<indexterm zone="dbusmenu-status-get-value-from-nick"><primary>dbusmenu_status_get_value_from_nick</primary></indexterm> -<programlisting><link linkend="DbusmenuStatus"><returnvalue>DbusmenuStatus</returnvalue></link> dbusmenu_status_get_value_from_nick (<parameter>const <link linkend="gchar"><type>gchar</type></link> *nick</parameter>);</programlisting> -<para> -Looks up in the enum table for the value of <parameter>nick</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>nick</parameter> :</term> -<listitem><simpara>The enum nick to lookup</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The value for the given <parameter>nick</parameter></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-text-direction-get-nick" role="function"> -<title>dbusmenu_text_direction_get_nick ()</title> -<indexterm zone="dbusmenu-text-direction-get-nick"><primary>dbusmenu_text_direction_get_nick</primary></indexterm> -<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * dbusmenu_text_direction_get_nick (<parameter><link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> value</parameter>);</programlisting> -<para> -Looks up in the enum table for the nick of <parameter>value</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>value</parameter> :</term> -<listitem><simpara>The value of DbusmenuTextDirection to get the nick of</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The nick for the given value or <link linkend="NULL:CAPS"><type>NULL</type></link> on error</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-text-direction-get-type" role="function"> -<title>dbusmenu_text_direction_get_type ()</title> -<indexterm zone="dbusmenu-text-direction-get-type"><primary>dbusmenu_text_direction_get_type</primary></indexterm> -<programlisting><link linkend="GType"><returnvalue>GType</returnvalue></link> dbusmenu_text_direction_get_type (<parameter><type>void</type></parameter>);</programlisting> -<para> -Builds a GLib type for the <link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> enumeration. -</para><variablelist role="params"> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A unique <link linkend="GType"><type>GType</type></link> for the <link linkend="DbusmenuTextDirection"><type>DbusmenuTextDirection</type></link> enum.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-text-direction-get-value-from-nick" role="function"> -<title>dbusmenu_text_direction_get_value_from_nick ()</title> -<indexterm zone="dbusmenu-text-direction-get-value-from-nick"><primary>dbusmenu_text_direction_get_value_from_nick</primary></indexterm> -<programlisting><link linkend="DbusmenuTextDirection"><returnvalue>DbusmenuTextDirection</returnvalue></link> dbusmenu_text_direction_get_value_from_nick - (<parameter>const <link linkend="gchar"><type>gchar</type></link> *nick</parameter>);</programlisting> -<para> -Looks up in the enum table for the value of <parameter>nick</parameter>. -</para><variablelist role="params"> -<varlistentry><term><parameter>nick</parameter> :</term> -<listitem><simpara>The enum nick to lookup</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The value for the given <parameter>nick</parameter></simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-gtk/Makefile.in b/docs/libdbusmenu-gtk/Makefile.in index c725646..3bff39b 100644 --- a/docs/libdbusmenu-gtk/Makefile.in +++ b/docs/libdbusmenu-gtk/Makefile.in @@ -36,7 +36,12 @@ host_triplet = @host@ subdir = docs/libdbusmenu-gtk DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__aclocal_m4_deps = $(top_srcdir)/m4/gnome-doc-utils.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/intltool.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs diff --git a/docs/libdbusmenu-gtk/reference/Makefile.in b/docs/libdbusmenu-gtk/reference/Makefile.in index cd13836..23c4920 100644 --- a/docs/libdbusmenu-gtk/reference/Makefile.in +++ b/docs/libdbusmenu-gtk/reference/Makefile.in @@ -43,7 +43,12 @@ DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ $(srcdir)/version.xml.in $(top_srcdir)/gtk-doc.local.make subdir = docs/libdbusmenu-gtk/reference ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__aclocal_m4_deps = $(top_srcdir)/m4/gnome-doc-utils.m4 \ + $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/intltool.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs diff --git a/docs/libdbusmenu-gtk/reference/html/annotation-glossary.html b/docs/libdbusmenu-gtk/reference/html/annotation-glossary.html index cb5c7bc..d5fe418 100644 --- a/docs/libdbusmenu-gtk/reference/html/annotation-glossary.html +++ b/docs/libdbusmenu-gtk/reference/html/annotation-glossary.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> <link rel="up" href="index.html" title="libdbusmenu-gtk Reference Manual"> <link rel="prev" href="api-index-deprecated.html" title="Deprecated API Index"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -42,6 +42,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/api-index-deprecated.html b/docs/libdbusmenu-gtk/reference/html/api-index-deprecated.html index ad42b0e..09eeaea 100644 --- a/docs/libdbusmenu-gtk/reference/html/api-index-deprecated.html +++ b/docs/libdbusmenu-gtk/reference/html/api-index-deprecated.html @@ -8,7 +8,7 @@ <link rel="up" href="index.html" title="libdbusmenu-gtk Reference Manual"> <link rel="prev" href="api-index-full.html" title="API Index"> <link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -26,6 +26,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/api-index-full.html b/docs/libdbusmenu-gtk/reference/html/api-index-full.html index b99edba..6f7a86c 100644 --- a/docs/libdbusmenu-gtk/reference/html/api-index-full.html +++ b/docs/libdbusmenu-gtk/reference/html/api-index-full.html @@ -8,7 +8,7 @@ <link rel="up" href="index.html" title="libdbusmenu-gtk Reference Manual"> <link rel="prev" href="object-tree.html" title="Object Hierarchy"> <link rel="next" href="api-index-deprecated.html" title="Deprecated API Index"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -134,6 +134,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/ch01.html b/docs/libdbusmenu-gtk/reference/html/ch01.html index af2a8e4..a1ccb7a 100644 --- a/docs/libdbusmenu-gtk/reference/html/ch01.html +++ b/docs/libdbusmenu-gtk/reference/html/ch01.html @@ -8,7 +8,7 @@ <link rel="up" href="index.html" title="libdbusmenu-gtk Reference Manual"> <link rel="prev" href="index.html" title="libdbusmenu-gtk Reference Manual"> <link rel="next" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> -<a name="id403245"></a>API</h2></div></div></div> +<a name="id527763"></a>API</h2></div></div></div> <div class="toc"><dl> <dt> <span class="refentrytitle"><a href="libdbusmenu-gtk-DbusmenuGtkMenu.html">DbusmenuGtkMenu</a></span><span class="refpurpose"> — A GTK Menu Object that syncronizes over DBus</span> @@ -42,6 +42,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/index.html b/docs/libdbusmenu-gtk/reference/html/index.html index 8c92ba7..5a481df 100644 --- a/docs/libdbusmenu-gtk/reference/html/index.html +++ b/docs/libdbusmenu-gtk/reference/html/index.html @@ -6,7 +6,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> <link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> <link rel="next" href="ch01.html" title="API"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -42,6 +42,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html index 54c5bdb..5cd32c0 100644 --- a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="libdbusmenu-gtk-menuitem.html" title="menuitem"> <link rel="next" href="libdbusmenu-gtk-parser.html" title="parser"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -342,6 +342,6 @@ This also handles passing the "activate" signal back to the </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html index 44fb6e4..f92f870 100644 --- a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="ch01.html" title="API"> <link rel="next" href="libdbusmenu-gtk-menuitem.html" title="menuitem"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -182,6 +182,6 @@ communicate with the server. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html index 031cf48..60db2bc 100644 --- a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu"> <link rel="next" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -269,6 +269,6 @@ for use to set the accelerators. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html index fa6d544..4bcd459 100644 --- a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient"> <link rel="next" href="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem.html" title="DbusmenuGtkSerializableMenuItem"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -113,6 +113,6 @@ or NULL if it isn't there. <span class="annotation">[<acronym title="Don't free </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/object-tree.html b/docs/libdbusmenu-gtk/reference/html/object-tree.html index dc617a1..c1ba18e 100644 --- a/docs/libdbusmenu-gtk/reference/html/object-tree.html +++ b/docs/libdbusmenu-gtk/reference/html/object-tree.html @@ -8,7 +8,7 @@ <link rel="up" href="index.html" title="libdbusmenu-gtk Reference Manual"> <link rel="prev" href="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem.html" title="DbusmenuGtkSerializableMenuItem"> <link rel="next" href="api-index-full.html" title="API Index"> -<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -27,6 +27,6 @@ </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.16</div> + Generated by GTK-Doc V1.17</div> </body> </html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/tmpl/client.sgml b/docs/libdbusmenu-gtk/reference/tmpl/client.sgml index df48e31..e4b3efb 100644 --- a/docs/libdbusmenu-gtk/reference/tmpl/client.sgml +++ b/docs/libdbusmenu-gtk/reference/tmpl/client.sgml @@ -9,11 +9,13 @@ DbusmenuGtkClient </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-gtk/reference/tmpl/menu.sgml b/docs/libdbusmenu-gtk/reference/tmpl/menu.sgml index f79c35e..4e2d89d 100644 --- a/docs/libdbusmenu-gtk/reference/tmpl/menu.sgml +++ b/docs/libdbusmenu-gtk/reference/tmpl/menu.sgml @@ -9,11 +9,13 @@ DbusmenuGtkMenu </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml b/docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml index 536e38c..eb30964 100644 --- a/docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml +++ b/docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml @@ -9,11 +9,13 @@ menuitem </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-gtk/reference/tmpl/parser.sgml b/docs/libdbusmenu-gtk/reference/tmpl/parser.sgml index e3a4579..f4ef7bb 100644 --- a/docs/libdbusmenu-gtk/reference/tmpl/parser.sgml +++ b/docs/libdbusmenu-gtk/reference/tmpl/parser.sgml @@ -9,11 +9,13 @@ parser </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-gtk/reference/tmpl/serializablemenuitem.sgml b/docs/libdbusmenu-gtk/reference/tmpl/serializablemenuitem.sgml index 54e3588..c19603f 100644 --- a/docs/libdbusmenu-gtk/reference/tmpl/serializablemenuitem.sgml +++ b/docs/libdbusmenu-gtk/reference/tmpl/serializablemenuitem.sgml @@ -9,11 +9,13 @@ DbusmenuGtkSerializableMenuItem </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/docs/libdbusmenu-gtk/reference/version.xml b/docs/libdbusmenu-gtk/reference/version.xml index 17b2ccd..6f2743d 100644 --- a/docs/libdbusmenu-gtk/reference/version.xml +++ b/docs/libdbusmenu-gtk/reference/version.xml @@ -1 +1 @@ -0.4.3 +0.4.4 diff --git a/docs/libdbusmenu-gtk/reference/xml/annotation-glossary.xml b/docs/libdbusmenu-gtk/reference/xml/annotation-glossary.xml deleted file mode 100644 index 7dde69a..0000000 --- a/docs/libdbusmenu-gtk/reference/xml/annotation-glossary.xml +++ /dev/null @@ -1,32 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> - -<glossary id="annotation-glossary"> - <title>Annotation Glossary</title> -<glossdiv><title>O</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-out"/>out</glossterm> - <glossdef> - <para>Parameter for returning results. Default is <acronym>transfer full</acronym>.</para> - </glossdef> - </glossentry> -</glossdiv> -<glossdiv><title>T</title> - <glossentry> - <glossterm><anchor id="annotation-glossterm-transfer full"/>transfer full</glossterm> - <glossdef> - <para>Free data after the code is done.</para> - </glossdef> - </glossentry> - <glossentry> - <glossterm><anchor id="annotation-glossterm-transfer none"/>transfer none</glossterm> - <glossdef> - <para>Don't free data after the code is done.</para> - </glossdef> - </glossentry> -</glossdiv> -</glossary> diff --git a/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml b/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml deleted file mode 100644 index 8ec0fe4..0000000 --- a/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<indexdiv> -</indexdiv> diff --git a/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml b/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml deleted file mode 100644 index 2f74a98..0000000 --- a/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml +++ /dev/null @@ -1,37 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<indexdiv> -<indexdiv><title>G</title> -<indexentry><primaryie linkends="DbusmenuGtkClient"><link linkend="DbusmenuGtkClient">DbusmenuGtkClient</link>, struct in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuGtkClientClass"><link linkend="DbusmenuGtkClientClass">DbusmenuGtkClientClass</link>, struct in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtkclient-get-accel-group"><link linkend="dbusmenu-gtkclient-get-accel-group">dbusmenu_gtkclient_get_accel_group</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtkclient-menuitem-get"><link linkend="dbusmenu-gtkclient-menuitem-get">dbusmenu_gtkclient_menuitem_get</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtkclient-menuitem-get-submenu"><link linkend="dbusmenu-gtkclient-menuitem-get-submenu">dbusmenu_gtkclient_menuitem_get_submenu</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtkclient-new"><link linkend="dbusmenu-gtkclient-new">dbusmenu_gtkclient_new</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtkclient-newitem-base"><link linkend="dbusmenu-gtkclient-newitem-base">dbusmenu_gtkclient_newitem_base</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtkclient-set-accel-group"><link linkend="dbusmenu-gtkclient-set-accel-group">dbusmenu_gtkclient_set_accel_group</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS"><link linkend="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS">DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</link>, macro in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuGtkMenuClass"><link linkend="DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</link>, struct in <link linkend="libdbusmenu-gtk-DbusmenuGtkMenu">DbusmenuGtkMenu</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtkmenu-get-client"><link linkend="dbusmenu-gtkmenu-get-client">dbusmenu_gtkmenu_get_client</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkMenu">DbusmenuGtkMenu</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtkmenu-new"><link linkend="dbusmenu-gtkmenu-new">dbusmenu_gtkmenu_new</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkMenu">DbusmenuGtkMenu</link></primaryie></indexentry> -<indexentry><primaryie linkends="DbusmenuGtkSerializableMenuItemClass"><link linkend="DbusmenuGtkSerializableMenuItemClass">DbusmenuGtkSerializableMenuItemClass</link>, struct in <link linkend="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem">DbusmenuGtkSerializableMenuItem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtk-parse-get-cached-item"><link linkend="dbusmenu-gtk-parse-get-cached-item">dbusmenu_gtk_parse_get_cached_item</link>, function in <link linkend="libdbusmenu-gtk-parser">parser</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtk-parse-menu-structure"><link linkend="dbusmenu-gtk-parse-menu-structure">dbusmenu_gtk_parse_menu_structure</link>, function in <link linkend="libdbusmenu-gtk-parser">parser</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtk-serializable-menu-item-build-menuitem"><link linkend="dbusmenu-gtk-serializable-menu-item-build-menuitem">dbusmenu_gtk_serializable_menu_item_build_menuitem</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem">DbusmenuGtkSerializableMenuItem</link></primaryie></indexentry> -<indexentry><primaryie linkends="DBUSMENU-GTK-SERIALIZABLE-MENU-ITEM-PROP-MENUITEM:CAPS"><link linkend="DBUSMENU-GTK-SERIALIZABLE-MENU-ITEM-PROP-MENUITEM:CAPS">DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM_PROP_MENUITEM</link>, macro in <link linkend="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem">DbusmenuGtkSerializableMenuItem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtk-serializable-menu-item-register-to-client"><link linkend="dbusmenu-gtk-serializable-menu-item-register-to-client">dbusmenu_gtk_serializable_menu_item_register_to_client</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem">DbusmenuGtkSerializableMenuItem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-gtk-serializable-menu-item-set-menuitem"><link linkend="dbusmenu-gtk-serializable-menu-item-set-menuitem">dbusmenu_gtk_serializable_menu_item_set_menuitem</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem">DbusmenuGtkSerializableMenuItem</link></primaryie></indexentry> -</indexdiv> -<indexdiv><title>M</title> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-get-image"><link linkend="dbusmenu-menuitem-property-get-image">dbusmenu_menuitem_property_get_image</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-get-shortcut"><link linkend="dbusmenu-menuitem-property-get-shortcut">dbusmenu_menuitem_property_get_shortcut</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-image"><link linkend="dbusmenu-menuitem-property-set-image">dbusmenu_menuitem_property_set_image</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-shortcut"><link linkend="dbusmenu-menuitem-property-set-shortcut">dbusmenu_menuitem_property_set_shortcut</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-shortcut-menuitem"><link linkend="dbusmenu-menuitem-property-set-shortcut-menuitem">dbusmenu_menuitem_property_set_shortcut_menuitem</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-shortcut-string"><link linkend="dbusmenu-menuitem-property-set-shortcut-string">dbusmenu_menuitem_property_set_shortcut_string</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> -</indexdiv> -</indexdiv> diff --git a/docs/libdbusmenu-gtk/reference/xml/client.xml b/docs/libdbusmenu-gtk/reference/xml/client.xml deleted file mode 100644 index d5ead35..0000000 --- a/docs/libdbusmenu-gtk/reference/xml/client.xml +++ /dev/null @@ -1,238 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-gtk-DbusmenuGtkClient"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-gtk-DbusmenuGtkClient.top_of_page">DbusmenuGtkClient</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GTK Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>DbusmenuGtkClient</refname> -<refpurpose>A subclass of <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> adding GTK level features</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkClient.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-gtk-DbusmenuGtkClient.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-gtk/client.h> - -#define <link linkend="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS">DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</link> - <link linkend="DbusmenuGtkClient">DbusmenuGtkClient</link>; -struct <link linkend="DbusmenuGtkClientClass">DbusmenuGtkClientClass</link>; -<link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * <link linkend="dbusmenu-gtkclient-new">dbusmenu_gtkclient_new</link> (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, - <parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>); -<link linkend="GtkMenuItem"><returnvalue>GtkMenuItem</returnvalue></link> * <link linkend="dbusmenu-gtkclient-menuitem-get">dbusmenu_gtkclient_menuitem_get</link> (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>); -<link linkend="GtkMenu"><returnvalue>GtkMenu</returnvalue></link> * <link linkend="dbusmenu-gtkclient-menuitem-get-submenu">dbusmenu_gtkclient_menuitem_get_submenu</link> - (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-gtkclient-set-accel-group">dbusmenu_gtkclient_set_accel_group</link> (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, - <parameter><link linkend="GtkAccelGroup"><type>GtkAccelGroup</type></link> *agroup</parameter>); -<link linkend="GtkAccelGroup"><returnvalue>GtkAccelGroup</returnvalue></link> * <link linkend="dbusmenu-gtkclient-get-accel-group">dbusmenu_gtkclient_get_accel_group</link> (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-gtkclient-newitem-base">dbusmenu_gtkclient_newitem_base</link> (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>, - <parameter><link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> *gmi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkClient.description" role="desc"> -<title role="desc.title">Description</title> -<para> -In general, this is just a <link linkend="GtkMenu"><type>GtkMenu</type></link>, why else would you care? Oh, - because this menu is created by someone else on a server that exists - on the other side of DBus. You need a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> to be able - push the data into this menu. -</para> -<para> - The first thing you need to know is how to find that <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> - on DBus. This involves both the DBus name and the DBus object that - the menu interface can be found on. Those two value should be set - when creating the object using <link linkend="dbusmenu-gtkmenu-new"><function>dbusmenu_gtkmenu_new()</function></link>. They are then - stored on two properties <link linkend="DbusmenuGtkClient--dbus-name"><type>"dbus-name"</type></link> and <link linkend="DbusmenuGtkClient--dbus-object"><type>"dbus-object"</type></link>. -</para> -<para> - After creation the <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> it will continue to keep in - synchronization with the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object across Dbus. If the - number of entries change, the menus change, if they change thier - properties change, they update in the items. All of this should - be handled transparently to the user of this object. -</para> -</refsect1> -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkClient.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS" role="macro"> -<title>DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</title> -<indexterm zone="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS"><primary>DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</primary></indexterm> -<programlisting>#define DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED -</programlisting> -<para> -String to attach to signal <link linkend="DbusmenuClient-root-changed"><type>"root-changed"</type></link> -</para></refsect2> -<refsect2 id="DbusmenuGtkClient" role="struct"> -<title>DbusmenuGtkClient</title> -<indexterm zone="DbusmenuGtkClient"><primary>DbusmenuGtkClient</primary></indexterm> -<programlisting>typedef struct _DbusmenuGtkClient DbusmenuGtkClient;</programlisting> -<para> -A subclass of <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> to add functionality with regarding -building GTK items out of the abstract tree. -</para></refsect2> -<refsect2 id="DbusmenuGtkClientClass" role="struct"> -<title>struct DbusmenuGtkClientClass</title> -<indexterm zone="DbusmenuGtkClientClass"><primary>DbusmenuGtkClientClass</primary></indexterm> -<programlisting>struct DbusmenuGtkClientClass { - DbusmenuClientClass parent_class; - - /* Signals */ - void (*root_changed) (DbusmenuMenuitem * newroot); - - /*< Private >*/ - void (*reserved1) (void); - void (*reserved2) (void); - void (*reserved3) (void); - void (*reserved4) (void); - void (*reserved5) (void); - void (*reserved6) (void); -}; -</programlisting> -<para> -Functions and signal slots for using a <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> -</para><variablelist role="struct"> -<varlistentry><term><link linkend="DbusmenuClientClass"><type>DbusmenuClientClass</type></link> <structfield id="DbusmenuGtkClientClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link></simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkClientClass.root-changed">root_changed</structfield> ()</term> -<listitem><simpara>Slot for signal <link linkend="DbusmenuGtkClient-root-changed"><type>"root-changed"</type></link></simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved6">reserved6</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtkclient-new" role="function"> -<title>dbusmenu_gtkclient_new ()</title> -<indexterm zone="dbusmenu-gtkclient-new"><primary>dbusmenu_gtkclient_new</primary></indexterm> -<programlisting><link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * dbusmenu_gtkclient_new (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, - <parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>);</programlisting> -<para> -Creates a new <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> object and creates a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> -that connects across DBus to a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>. -</para><variablelist role="params"> -<varlistentry><term><parameter>dbus_name</parameter> :</term> -<listitem><simpara>Name of the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> on DBus</simpara></listitem></varlistentry> -<varlistentry><term><parameter>dbus_object</parameter> :</term> -<listitem><simpara>Name of the object on the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link></simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A new <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> sync'd with a server</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtkclient-menuitem-get" role="function"> -<title>dbusmenu_gtkclient_menuitem_get ()</title> -<indexterm zone="dbusmenu-gtkclient-menuitem-get"><primary>dbusmenu_gtkclient_menuitem_get</primary></indexterm> -<programlisting><link linkend="GtkMenuItem"><returnvalue>GtkMenuItem</returnvalue></link> * dbusmenu_gtkclient_menuitem_get (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>);</programlisting> -<para> -This grabs the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that is associated with the -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>A <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> with the item in it.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get associated <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> on.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that can be played with. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtkclient-menuitem-get-submenu" role="function"> -<title>dbusmenu_gtkclient_menuitem_get_submenu ()</title> -<indexterm zone="dbusmenu-gtkclient-menuitem-get-submenu"><primary>dbusmenu_gtkclient_menuitem_get_submenu</primary></indexterm> -<programlisting><link linkend="GtkMenu"><returnvalue>GtkMenu</returnvalue></link> * dbusmenu_gtkclient_menuitem_get_submenu - (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>);</programlisting> -<para> -This grabs the submenu associated with the menuitem. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>A <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> with the item in it.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get associated <link linkend="GtkMenu"><type>GtkMenu</type></link> on.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The <link linkend="GtkMenu"><type>GtkMenu</type></link> if there is one. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtkclient-set-accel-group" role="function"> -<title>dbusmenu_gtkclient_set_accel_group ()</title> -<indexterm zone="dbusmenu-gtkclient-set-accel-group"><primary>dbusmenu_gtkclient_set_accel_group</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_gtkclient_set_accel_group (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, - <parameter><link linkend="GtkAccelGroup"><type>GtkAccelGroup</type></link> *agroup</parameter>);</programlisting> -<para> -Sets the acceleration group for the menu items with accelerators -on this client. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>To set the group on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>agroup</parameter> :</term> -<listitem><simpara>The new acceleration group</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtkclient-get-accel-group" role="function"> -<title>dbusmenu_gtkclient_get_accel_group ()</title> -<indexterm zone="dbusmenu-gtkclient-get-accel-group"><primary>dbusmenu_gtkclient_get_accel_group</primary></indexterm> -<programlisting><link linkend="GtkAccelGroup"><returnvalue>GtkAccelGroup</returnvalue></link> * dbusmenu_gtkclient_get_accel_group (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>);</programlisting> -<para> -Gets the accel group for this client. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>Client to query for an accelerator group</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Either a valid group or <link linkend="NULL:CAPS"><type>NULL</type></link> on error or -none set. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtkclient-newitem-base" role="function"> -<title>dbusmenu_gtkclient_newitem_base ()</title> -<indexterm zone="dbusmenu-gtkclient-newitem-base"><primary>dbusmenu_gtkclient_newitem_base</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_gtkclient_newitem_base (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>, - <parameter><link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> *gmi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>);</programlisting> -<para> -This function provides some of the basic connectivity for being in -the GTK world. Things like visibility and sensitivity of the item are -handled here so that the subclasses don't have to. If you're building -your on GTK menu item you can use this function to apply those basic -attributes so that you don't have to deal with them either. -</para> -<para> -This also handles passing the "activate" signal back to the -<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> side of thing. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>The client handling everything on this connection</simpara></listitem></varlistentry> -<varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to attach the GTK-isms to</simpara></listitem></varlistentry> -<varlistentry><term><parameter>gmi</parameter> :</term> -<listitem><simpara>A <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> representing the GTK world's view of this menuitem</simpara></listitem></varlistentry> -<varlistentry><term><parameter>parent</parameter> :</term> -<listitem><simpara>The parent <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link></simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-gtk/reference/xml/menu.xml b/docs/libdbusmenu-gtk/reference/xml/menu.xml deleted file mode 100644 index ad68499..0000000 --- a/docs/libdbusmenu-gtk/reference/xml/menu.xml +++ /dev/null @@ -1,133 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-gtk-DbusmenuGtkMenu"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-gtk-DbusmenuGtkMenu.top_of_page">DbusmenuGtkMenu</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GTK Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>DbusmenuGtkMenu</refname> -<refpurpose>A GTK Menu Object that syncronizes over DBus</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkMenu.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-gtk-DbusmenuGtkMenu.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-gtk/menu.h> - -struct <link linkend="DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</link>; -<link linkend="DbusmenuGtkMenu"><returnvalue>DbusmenuGtkMenu</returnvalue></link> * <link linkend="dbusmenu-gtkmenu-new">dbusmenu_gtkmenu_new</link> (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, - <parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>); -<link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * <link linkend="dbusmenu-gtkmenu-get-client">dbusmenu_gtkmenu_get_client</link> (<parameter><link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> *menu</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkMenu.description" role="desc"> -<title role="desc.title">Description</title> -<para> -In general, this is just a <link linkend="GtkMenu"><type>GtkMenu</type></link>, why else would you care? Oh, - because this menu is created by someone else on a server that exists - on the other side of DBus. You need a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> to be able - push the data into this menu. -</para> -<para> - The first thing you need to know is how to find that <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> - on DBus. This involves both the DBus name and the DBus object that - the menu interface can be found on. Those two value should be set - when creating the object using <link linkend="dbusmenu-gtkmenu-new"><function>dbusmenu_gtkmenu_new()</function></link>. They are then - stored on two properties <link linkend="DbusmenuGtkMenu--dbus-name"><type>"dbus-name"</type></link> and <link linkend="DbusmenuGtkMenu--dbus-object"><type>"dbus-object"</type></link>. -</para> -<para> - After creation the <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> it will continue to keep in - synchronization with the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object across Dbus. If the - number of entries change, the menus change, if they change thier - properties change, they update in the items. All of this should - be handled transparently to the user of this object. -</para> -</refsect1> -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkMenu.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DbusmenuGtkMenuClass" role="struct"> -<title>struct DbusmenuGtkMenuClass</title> -<indexterm zone="DbusmenuGtkMenuClass"><primary>DbusmenuGtkMenuClass</primary></indexterm> -<programlisting>struct DbusmenuGtkMenuClass { - GtkMenuClass parent_class; - - /*< Private >*/ - void (*reserved1) (void); - void (*reserved2) (void); - void (*reserved3) (void); - void (*reserved4) (void); - void (*reserved5) (void); - void (*reserved6) (void); -}; -</programlisting> -<para> -All of the subclassable functions and signal slots for a -<link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link>. -</para><variablelist role="struct"> -<varlistentry><term><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link> <structfield id="DbusmenuGtkMenuClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link></simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved6">reserved6</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtkmenu-new" role="function"> -<title>dbusmenu_gtkmenu_new ()</title> -<indexterm zone="dbusmenu-gtkmenu-new"><primary>dbusmenu_gtkmenu_new</primary></indexterm> -<programlisting><link linkend="DbusmenuGtkMenu"><returnvalue>DbusmenuGtkMenu</returnvalue></link> * dbusmenu_gtkmenu_new (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, - <parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>);</programlisting> -<para> -Creates a new <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> object and creates a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> -that connects across DBus to a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>. -</para><variablelist role="params"> -<varlistentry><term><parameter>dbus_name</parameter> :</term> -<listitem><simpara>Name of the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> on DBus</simpara></listitem></varlistentry> -<varlistentry><term><parameter>dbus_object</parameter> :</term> -<listitem><simpara>Name of the object on the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link></simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A new <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> sync'd with a server</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtkmenu-get-client" role="function"> -<title>dbusmenu_gtkmenu_get_client ()</title> -<indexterm zone="dbusmenu-gtkmenu-get-client"><primary>dbusmenu_gtkmenu_get_client</primary></indexterm> -<programlisting><link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * dbusmenu_gtkmenu_get_client (<parameter><link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> *menu</parameter>);</programlisting> -<para> -An accessor for the client that this menu is using to -communicate with the server. -</para><variablelist role="params"> -<varlistentry><term><parameter>menu</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> to get the client from</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A valid <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> or NULL on error. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-gtk/reference/xml/menuitem.xml b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml deleted file mode 100644 index 12f1325..0000000 --- a/docs/libdbusmenu-gtk/reference/xml/menuitem.xml +++ /dev/null @@ -1,178 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-gtk-menuitem"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-gtk-menuitem.top_of_page">menuitem</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GTK Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>menuitem</refname> -<refpurpose>Helpers for <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> properties that require a GTK dependency</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-gtk-menuitem.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-gtk-menuitem.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-gtk/menuitem.h> - -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-image">dbusmenu_menuitem_property_set_image</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter>const <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> *data</parameter>); -<link linkend="GdkPixbuf"><returnvalue>GdkPixbuf</returnvalue></link> * <link linkend="dbusmenu-menuitem-property-get-image">dbusmenu_menuitem_property_get_image</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-shortcut">dbusmenu_menuitem_property_set_shortcut</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> key</parameter>, - <parameter><link linkend="GdkModifierType"><type>GdkModifierType</type></link> modifier</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-shortcut-string">dbusmenu_menuitem_property_set_shortcut_string</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *shortcut</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-shortcut-menuitem">dbusmenu_menuitem_property_set_shortcut_menuitem</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> *gmi</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-property-get-shortcut">dbusmenu_menuitem_property_get_shortcut</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> *key</parameter>, - <parameter><link linkend="GdkModifierType"><type>GdkModifierType</type></link> *modifier</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-gtk-menuitem.description" role="desc"> -<title role="desc.title">Description</title> -<para> -Some property helpers can't be done without picking up a GTK+ - dependency. So those sit in libdbusmenu-gtk but have very similar - prototypes to the code in libdbusmenu-glib so your code will - look consistent, just with the extra depedency. -</para> -</refsect1> -<refsect1 id="libdbusmenu-gtk-menuitem.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="dbusmenu-menuitem-property-set-image" role="function"> -<title>dbusmenu_menuitem_property_set_image ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-image"><primary>dbusmenu_menuitem_property_set_image</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_image - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, - <parameter>const <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> *data</parameter>);</programlisting> -<para> -This function takes the pixbuf that is stored in <parameter>data</parameter> and -turns it into a base64 encoded PNG so that it can be placed -onto a standard <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property. -</para><variablelist role="params"> -<varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the property on.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>Name of the property to set.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>data</parameter> :</term> -<listitem><simpara>The image to place on the property.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether the function was able to set the property -or not.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-get-image" role="function"> -<title>dbusmenu_menuitem_property_get_image ()</title> -<indexterm zone="dbusmenu-menuitem-property-get-image"><primary>dbusmenu_menuitem_property_get_image</primary></indexterm> -<programlisting><link linkend="GdkPixbuf"><returnvalue>GdkPixbuf</returnvalue></link> * dbusmenu_menuitem_property_get_image - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> -<para> -This function looks on the menu item for a property by the -name of <parameter>property</parameter>. If one exists it tries to turn it into -a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>. It assumes that the property is a base64 encoded -PNG file like the one created by <link linkend="dbusmenu-menuite-property-set-image"><type>dbusmenu_menuite_property_set_image</type></link>. -</para><variablelist role="params"> -<varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>The name of the property to look for.</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A pixbuf or <link linkend="NULL:CAPS"><type>NULL</type></link> to signal error. <emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set-shortcut" role="function"> -<title>dbusmenu_menuitem_property_set_shortcut ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-shortcut"><primary>dbusmenu_menuitem_property_set_shortcut</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_shortcut - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> key</parameter>, - <parameter><link linkend="GdkModifierType"><type>GdkModifierType</type></link> modifier</parameter>);</programlisting> -<para> -Takes the modifer described by <parameter>key</parameter> and <parameter>modifier</parameter> and places that into -the format sending across Dbus for shortcuts. -</para><variablelist role="params"> -<varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>key</parameter> :</term> -<listitem><simpara>The keycode of the key to send</simpara></listitem></varlistentry> -<varlistentry><term><parameter>modifier</parameter> :</term> -<listitem><simpara>A bitmask of modifiers used to activate the item</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether it was successful at setting the property.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set-shortcut-string" role="function"> -<title>dbusmenu_menuitem_property_set_shortcut_string ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-shortcut-string"><primary>dbusmenu_menuitem_property_set_shortcut_string</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_shortcut_string - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *shortcut</parameter>);</programlisting> -<para> -This function takes a GTK shortcut string as defined in -<link linkend="gtk-accelerator-parse"><type>gtk_accelerator_parse</type></link> and turns that into the information -required to send it over DBusmenu. -</para><variablelist role="params"> -<varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>shortcut</parameter> :</term> -<listitem><simpara>String describing the shortcut</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether it was successful at setting the property.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set-shortcut-menuitem" role="function"> -<title>dbusmenu_menuitem_property_set_shortcut_menuitem ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-shortcut-menuitem"><primary>dbusmenu_menuitem_property_set_shortcut_menuitem</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_shortcut_menuitem - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> *gmi</parameter>);</programlisting> -<para> -Takes the shortcut that is installed on a menu item and calls -<link linkend="dbusmenu-menuitem-property-set-shortcut"><type>dbusmenu_menuitem_property_set_shortcut</type></link> with it. It also sets -up listeners to watch it change. -</para><variablelist role="params"> -<varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on</simpara></listitem></varlistentry> -<varlistentry><term><parameter>gmi</parameter> :</term> -<listitem><simpara>A menu item to steal the shortcut off of</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether it was successful at setting the property.</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-get-shortcut" role="function"> -<title>dbusmenu_menuitem_property_get_shortcut ()</title> -<indexterm zone="dbusmenu-menuitem-property-get-shortcut"><primary>dbusmenu_menuitem_property_get_shortcut</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_property_get_shortcut - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> *key</parameter>, - <parameter><link linkend="GdkModifierType"><type>GdkModifierType</type></link> *modifier</parameter>);</programlisting> -<para> -This function gets a GTK shortcut as a key and a mask -for use to set the accelerators. -</para><variablelist role="params"> -<varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get the shortcut off</simpara></listitem></varlistentry> -<varlistentry><term><parameter>key</parameter> :</term> -<listitem><simpara>Location to put the key value. <emphasis role="annotation">[<acronym>out</acronym>]</emphasis></simpara></listitem></varlistentry> -<varlistentry><term><parameter>modifier</parameter> :</term> -<listitem><simpara>Location to put the modifier mask. <emphasis role="annotation">[<acronym>out</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-gtk/reference/xml/parser.xml b/docs/libdbusmenu-gtk/reference/xml/parser.xml deleted file mode 100644 index 329bf0a..0000000 --- a/docs/libdbusmenu-gtk/reference/xml/parser.xml +++ /dev/null @@ -1,77 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-gtk-parser"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-gtk-parser.top_of_page">parser</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GTK Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>parser</refname> -<refpurpose>A parser of in-memory GTK menu trees</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-gtk-parser.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-gtk-parser.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-gtk/parser.h> - -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-gtk-parse-menu-structure">dbusmenu_gtk_parse_menu_structure</link> (<parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>); -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-gtk-parse-get-cached-item">dbusmenu_gtk_parse_get_cached_item</link> (<parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-gtk-parser.description" role="desc"> -<title role="desc.title">Description</title> -<para> -The parser will take a GTK menu tree and attach it to a Dbusmenu menu - tree. Along with setting up all the signals for updates and destruction. - The returned item would be the root item of the given tree. -</para> -</refsect1> -<refsect1 id="libdbusmenu-gtk-parser.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="dbusmenu-gtk-parse-menu-structure" role="function"> -<title>dbusmenu_gtk_parse_menu_structure ()</title> -<indexterm zone="dbusmenu-gtk-parse-menu-structure"><primary>dbusmenu_gtk_parse_menu_structure</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_gtk_parse_menu_structure (<parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>);</programlisting> -<para> -Goes through the GTK structures and turns them into the appropraite -Dbusmenu structures along with setting up all the relationships -between the objects. It also stores the dbusmenu items as a cache -on the GTK items so that they'll be reused if necissary. -</para><variablelist role="params"> -<varlistentry><term><parameter>widget</parameter> :</term> -<listitem><simpara>A <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> or <link linkend="GtkMenuShell"><type>GtkMenuShell</type></link> to turn into a <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link></simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A dbusmenu item representing the menu structure. <emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtk-parse-get-cached-item" role="function"> -<title>dbusmenu_gtk_parse_get_cached_item ()</title> -<indexterm zone="dbusmenu-gtk-parse-get-cached-item"><primary>dbusmenu_gtk_parse_get_cached_item</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_gtk_parse_get_cached_item (<parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>);</programlisting> -<para> -The Dbusmenu GTK parser adds cached items on the various -menu items throughout the tree. Sometimes it can be useful -to get that cached item to use directly. This function -will retrieve it for you. -</para><variablelist role="params"> -<varlistentry><term><parameter>widget</parameter> :</term> -<listitem><simpara>A <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that may have a cached <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> from the parser</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A pointer to the cached item -or NULL if it isn't there. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> diff --git a/docs/libdbusmenu-gtk/reference/xml/serializablemenuitem.xml b/docs/libdbusmenu-gtk/reference/xml/serializablemenuitem.xml deleted file mode 100644 index 05fad23..0000000 --- a/docs/libdbusmenu-gtk/reference/xml/serializablemenuitem.xml +++ /dev/null @@ -1,176 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<refentry id="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem"> -<refmeta> -<refentrytitle role="top_of_page" id="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem.top_of_page">DbusmenuGtkSerializableMenuItem</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo> - LIBDBUSMENU-GTK Library -</refmiscinfo> -</refmeta> -<refnamediv> -<refname>DbusmenuGtkSerializableMenuItem</refname> -<refpurpose>A way to build <link linkend="GtkMenuItems"><type>GtkMenuItems</type></link> that can be sent over Dbusmenu</refpurpose> -</refnamediv> -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem.stability-level"> -<title>Stability Level</title> -Unstable, unless otherwise indicated -</refsect1> - -<refsynopsisdiv id="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem.synopsis" role="synopsis"> -<title role="synopsis.title">Synopsis</title> - -<synopsis> -#include <libdbusmenu-gtk/serializablemenuitem.h> - -#define <link linkend="DBUSMENU-GTK-SERIALIZABLE-MENU-ITEM-PROP-MENUITEM:CAPS">DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM_PROP_MENUITEM</link> -struct <link linkend="DbusmenuGtkSerializableMenuItemClass">DbusmenuGtkSerializableMenuItemClass</link>; -<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-gtk-serializable-menu-item-build-menuitem">dbusmenu_gtk_serializable_menu_item_build_menuitem</link> - (<parameter><link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link> *smi</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-gtk-serializable-menu-item-register-to-client">dbusmenu_gtk_serializable_menu_item_register_to_client</link> - (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, - <parameter><link linkend="GType"><type>GType</type></link> item_type</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-gtk-serializable-menu-item-set-menuitem">dbusmenu_gtk_serializable_menu_item_set_menuitem</link> - (<parameter><link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link> *smi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); -</synopsis> -</refsynopsisdiv> - -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem.description" role="desc"> -<title role="desc.title">Description</title> -<para> -Menuitems can subclass from this instead of <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> and - by providing the appropriate functions Dbusmenu will be able - to parse them and send them over the bus. -</para> -</refsect1> -<refsect1 id="libdbusmenu-gtk-DbusmenuGtkSerializableMenuItem.details" role="details"> -<title role="details.title">Details</title> -<refsect2 id="DBUSMENU-GTK-SERIALIZABLE-MENU-ITEM-PROP-MENUITEM:CAPS" role="macro"> -<title>DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM_PROP_MENUITEM</title> -<indexterm zone="DBUSMENU-GTK-SERIALIZABLE-MENU-ITEM-PROP-MENUITEM:CAPS"><primary>DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM_PROP_MENUITEM</primary></indexterm> -<programlisting>#define DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM_PROP_MENUITEM "dbusmenu-menuitem" -</programlisting> -<para> -String to access property <link linkend="DbusmenuGtkSerializableMenuItem--dbusmenu-menuitem"><type>"dbusmenu-menuitem"</type></link> -</para></refsect2> -<refsect2 id="DbusmenuGtkSerializableMenuItemClass" role="struct"> -<title>struct DbusmenuGtkSerializableMenuItemClass</title> -<indexterm zone="DbusmenuGtkSerializableMenuItemClass"><primary>DbusmenuGtkSerializableMenuItemClass</primary></indexterm> -<programlisting>struct DbusmenuGtkSerializableMenuItemClass { - GtkMenuItemClass parent_class; - - /* Subclassable functions */ - const gchar * (*get_type_string) (void); - GHashTable * (*get_default_properties) (void); - - DbusmenuMenuitem * (*build_dbusmenu_menuitem) (DbusmenuGtkSerializableMenuItem * smi); - - /* Signals */ - - - - /* Empty Space */ - /*< Private >*/ - void (*_dbusmenu_gtk_serializable_menu_item_reserved1) (void); - void (*_dbusmenu_gtk_serializable_menu_item_reserved2) (void); - void (*_dbusmenu_gtk_serializable_menu_item_reserved3) (void); - void (*_dbusmenu_gtk_serializable_menu_item_reserved4) (void); - void (*_dbusmenu_gtk_serializable_menu_item_reserved5) (void); - void (*_dbusmenu_gtk_serializable_menu_item_reserved6) (void); -}; -</programlisting> -<para> -Signals and functions for <link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link>. -</para><variablelist role="struct"> -<varlistentry><term><link linkend="GtkMenuItemClass"><type>GtkMenuItemClass</type></link> <structfield id="DbusmenuGtkSerializableMenuItemClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara>Inherit from GtkMenuItem</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.get-type-string">get_type_string</structfield> ()</term> -<listitem><simpara>Static function to get a string describing this type</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.get-default-properties">get_default_properties</structfield> ()</term> -<listitem><simpara>Return a hashtable of defaults for the menu item type</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.build-dbusmenu-menuitem">build_dbusmenu_menuitem</structfield> ()</term> -<listitem><simpara>Build a menuitem that can be sent over dbus</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.-dbusmenu-gtk-serializable-menu-item-reserved1">_dbusmenu_gtk_serializable_menu_item_reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.-dbusmenu-gtk-serializable-menu-item-reserved2">_dbusmenu_gtk_serializable_menu_item_reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.-dbusmenu-gtk-serializable-menu-item-reserved3">_dbusmenu_gtk_serializable_menu_item_reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.-dbusmenu-gtk-serializable-menu-item-reserved4">_dbusmenu_gtk_serializable_menu_item_reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.-dbusmenu-gtk-serializable-menu-item-reserved5">_dbusmenu_gtk_serializable_menu_item_reserved5</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -<varlistentry><term><structfield id="DbusmenuGtkSerializableMenuItemClass.-dbusmenu-gtk-serializable-menu-item-reserved6">_dbusmenu_gtk_serializable_menu_item_reserved6</structfield> ()</term> -<listitem><simpara>Reserved for future use.</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtk-serializable-menu-item-build-menuitem" role="function"> -<title>dbusmenu_gtk_serializable_menu_item_build_menuitem ()</title> -<indexterm zone="dbusmenu-gtk-serializable-menu-item-build-menuitem"><primary>dbusmenu_gtk_serializable_menu_item_build_menuitem</primary></indexterm> -<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_gtk_serializable_menu_item_build_menuitem - (<parameter><link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link> *smi</parameter>);</programlisting> -<para> -This function is for menu items that are instanciated from -GTK and have their properites set using GTK functions. This -builds a <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that then has the properties that -should be sent over the bus to create a new item of this -type on the other side. -</para><variablelist role="params"> -<varlistentry><term><parameter>smi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link> to build a <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> mirroring</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> who's values will be -set by this object. <emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtk-serializable-menu-item-register-to-client" role="function"> -<title>dbusmenu_gtk_serializable_menu_item_register_to_client ()</title> -<indexterm zone="dbusmenu-gtk-serializable-menu-item-register-to-client"><primary>dbusmenu_gtk_serializable_menu_item_register_to_client</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_gtk_serializable_menu_item_register_to_client - (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, - <parameter><link linkend="GType"><type>GType</type></link> item_type</parameter>);</programlisting> -<para> -Registers a generic handler for dealing with all subclasses of -<link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link>. This handler responds to the callback, -creates a new object and attaches it to the appropriate <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> -object. -</para><variablelist role="params"> -<varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> that we should register a type at.</simpara></listitem></varlistentry> -<varlistentry><term><parameter>item_type</parameter> :</term> -<listitem><simpara>The <link linkend="GType"><type>GType</type></link> of a class that is a subclass of <link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link></simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="dbusmenu-gtk-serializable-menu-item-set-menuitem" role="function"> -<title>dbusmenu_gtk_serializable_menu_item_set_menuitem ()</title> -<indexterm zone="dbusmenu-gtk-serializable-menu-item-set-menuitem"><primary>dbusmenu_gtk_serializable_menu_item_set_menuitem</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_gtk_serializable_menu_item_set_menuitem - (<parameter><link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link> *smi</parameter>, - <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> -<para> -This function is used on the server side to signal to the object -that it should get its' property change events from <parameter>mi</parameter> instead -of expecting calls to its' API. A call to this function sets the -property and subclasses should listen to the notify signal to -pick up this property being set. -</para><variablelist role="params"> -<varlistentry><term><parameter>smi</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuGtkSerializableMenuItem"><type>DbusmenuGtkSerializableMenuItem</type></link> to set the <parameter>DbusmenuGtkSerializableMenuItem</parameter>::dbusmenu-menuitem of</simpara></listitem></varlistentry> -<varlistentry><term><parameter>mi</parameter> :</term> -<listitem><simpara>Menuitem to get the properties from</simpara></listitem></varlistentry> -</variablelist></refsect2> - -</refsect1> - -</refentry> |