diff options
Diffstat (limited to 'docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml')
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml | 111 |
1 files changed, 111 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..7d8b431 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml @@ -0,0 +1,111 @@ +<?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="DbusmenuMenuitemProxy"> +<refmeta> +<refentrytitle role="top_of_page" id="DbusmenuMenuitemProxy.top_of_page">DbusmenuMenuitemProxy</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GLIB Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>DbusmenuMenuitemProxy</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="DbusmenuMenuitemProxy.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis> <link linkend="DbusmenuMenuitemProxy-struct">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="DbusmenuMenuitemProxy.object-hierarchy" role="object_hierarchy"> +<title role="object_hierarchy.title">Object Hierarchy</title> +<synopsis> + <link linkend="GObject">GObject</link> + +----<link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link> + +----DbusmenuMenuitemProxy +</synopsis> +</refsect1> +<refsect1 id="DbusmenuMenuitemProxy.properties" role="properties"> +<title role="properties.title">Properties</title> +<synopsis> + "<link linkend="DbusmenuMenuitemProxy--menu-item">menu-item</link>" <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>* : Read / Write / Construct Only +</synopsis> +</refsect1> + +<refsect1 id="DbusmenuMenuitemProxy.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="DbusmenuMenuitemProxy.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DbusmenuMenuitemProxy-struct" role="struct"> +<title>DbusmenuMenuitemProxy</title> +<indexterm zone="DbusmenuMenuitemProxy-struct"><primary>DbusmenuMenuitemProxy</primary></indexterm> +<programlisting>typedef struct _DbusmenuMenuitemProxy 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> <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> :</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. +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> +<refsect1 id="DbusmenuMenuitemProxy.property-details" role="property_details"> +<title role="property_details.title">Property Details</title> +<refsect2 id="DbusmenuMenuitemProxy--menu-item" role="property"><title>The <literal>"menu-item"</literal> property</title> +<indexterm zone="DbusmenuMenuitemProxy--menu-item"><primary>DbusmenuMenuitemProxy:menu-item</primary></indexterm> +<programlisting> "menu-item" <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>* : Read / Write / Construct Only</programlisting> +<para>An instance of the DbusmenuMenuitem class that this menuitem will mimic.</para></refsect2> +</refsect1> + +</refentry> |