aboutsummaryrefslogtreecommitdiff
path: root/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml
diff options
context:
space:
mode:
authorKen VanDine <ken.vandine@canonical.com>2010-06-10 16:45:25 -0400
committerKen VanDine <ken.vandine@canonical.com>2010-06-10 16:45:25 -0400
commitb2fb5abc22fa8e25f43f4af1e5a36a277a2f9058 (patch)
tree7b3492c11c2a1a76acbbda921762618516c24db8 /docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml
parent61ad4d5c68a37c07a9046640cfdf6f92e787c48c (diff)
parent858027328dada43f30eb2db96ecff33abd3b0974 (diff)
downloadlibdbusmenu-b2fb5abc22fa8e25f43f4af1e5a36a277a2f9058.tar.gz
libdbusmenu-b2fb5abc22fa8e25f43f4af1e5a36a277a2f9058.tar.bz2
libdbusmenu-b2fb5abc22fa8e25f43f4af1e5a36a277a2f9058.zip
* debian/control
- added doc packages - added build dep for gtk-doc-tools * debian/libdbusmenu-glib-doc.install added * debian/libdbusmenu-gtk-doc.install added * debian/rules - enabled gtk-doc for configure * New upstream release. * Set the 'child-display' property on menuitems that have child menuitems. * gtk-doc support * Document the 'shortcut' property * New upstream release. * Add function to get submenu of GTK-ified items * Fix signal prototype of ID update * Fixing up VAPI files to build them correctly * Fixing the version string in the GIR file * Fix documentation title page * Reject text nodes early (warnings with Qt integration) * debian/libdbusmenu-glib-dev.install: Updating gir and vapi file names for package list. * debian/gir1.0-dbusmenu-glib-0.2.install: Changing the name of the typelib file.
Diffstat (limited to 'docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml')
-rw-r--r--docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml93
1 files changed, 93 insertions, 0 deletions
diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml
new file mode 100644
index 0000000..4c40423
--- /dev/null
+++ b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml
@@ -0,0 +1,93 @@
+<?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></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv id="libdbusmenu-glib-DbusmenuMenuitemProxy.synopsis" role="synopsis">
+<title role="synopsis.title">Synopsis</title>
+
+<synopsis> <link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link>;
+ <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>
+</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 {
+ DbusmenuMenuitem parent;
+} DbusmenuMenuitemProxy;
+</programlisting>
+<para>
+</para></refsect2>
+<refsect2 id="DbusmenuMenuitemProxyClass" role="struct">
+<title>DbusmenuMenuitemProxyClass</title>
+<indexterm zone="DbusmenuMenuitemProxyClass"><primary>DbusmenuMenuitemProxyClass</primary></indexterm>
+<programlisting>typedef struct {
+ DbusmenuMenuitemClass parent_class;
+} DbusmenuMenuitemProxyClass;
+</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>&#160;<structfield id="DbusmenuMenuitemProxyClass.parent-class">parent_class</structfield>;</term>
+<listitem><simpara>The Class of <link linkend="DbusmeneMenuitem"><type>DbusmeneMenuitem</type></link>
+</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>&#160;:</term>
+<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to proxy
+</simpara></listitem></varlistentry>
+<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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>&#160;:</term>
+<listitem><simpara><link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> to look into
+</simpara></listitem></varlistentry>
+<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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.
+</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+
+</refsect1>
+
+</refentry>