git.maemo.org Git - modest/blob - experimental/modest/docs/reference/xml/modest-window-mgr.xml

   1 <refentry id="modest-ModestWindowMgr">
   2 <refmeta>
   3 <refentrytitle id="top_of_page">ModestWindowMgr</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>MODEST Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>ModestWindowMgr</refname>
  10 <refpurpose></refpurpose>
  11 <!--[<xref linkend="desc" endterm="desc.title"/>]-->
  12 </refnamediv>
  13
  14 <refsynopsisdiv id="synopsis">
  15 <title id="synopsis.title">Synopsis</title>
  16
  17 <synopsis>
  18
  19
  20
  21 typedef     <link linkend="ModestWindowType">ModestWindowType</link>;
  22             <link linkend="ModestOpenWindow">ModestOpenWindow</link>;
  23             <link linkend="ModestWindowMgr">ModestWindowMgr</link>;
  24 <link linkend="GObject">GObject</link>*    <link linkend="modest-window-mgr-new">modest_window_mgr_new</link>           (void);
  25 <link linkend="gboolean">gboolean</link>    <link linkend="modest-window-mgr-register">modest_window_mgr_register</link>      (<link linkend="ModestWindowMgr">ModestWindowMgr</link> *self,
  26                                              <link linkend="GObject">GObject</link> *win,
  27                                              <link linkend="ModestWindowType">ModestWindowType</link> type,
  28                                              <link linkend="guint">guint</link> window_id);
  29 <link linkend="gboolean">gboolean</link>    <link linkend="modest-window-mgr-unregister">modest_window_mgr_unregister</link>    (<link linkend="ModestWindowMgr">ModestWindowMgr</link> *self,
  30                                              <link linkend="GObject">GObject</link> *win);
  31 <link linkend="GObject">GObject</link>*    <link linkend="modest-window-mgr-find-by-type">modest_window_mgr_find_by_type</link>  (<link linkend="ModestWindowMgr">ModestWindowMgr</link> *self,
  32                                              <link linkend="ModestWindowType">ModestWindowType</link> type);
  33 <link linkend="GObject">GObject</link>*    <link linkend="modest-window-mgr-find-by-id">modest_window_mgr_find_by_id</link>    (<link linkend="ModestWindowMgr">ModestWindowMgr</link> *self,
  34                                              <link linkend="gint">gint</link> window_id);
  35
  36 </synopsis>
  37 </refsynopsisdiv>
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47 <refsect1 id="desc">
  48 <title id="desc.title">Description</title>
  49 <para>
  50
  51 </para>
  52 </refsect1>
  53
  54 <refsect1 id="details">
  55 <title id="details.title">Details</title>
  56 <refsect2>
  57 <title><anchor id="ModestWindowType" role="typedef"/>ModestWindowType</title>
  58 <indexterm><primary>ModestWindowType</primary></indexterm><programlisting>typedef guint ModestWindowType;
  59 </programlisting>
  60 <para>
  61
  62 </para></refsect2>
  63 <refsect2>
  64 <title><anchor id="ModestOpenWindow" role="struct"/>ModestOpenWindow</title>
  65 <indexterm><primary>ModestOpenWindow</primary></indexterm><programlisting>typedef struct {
  66         GObject          *win;
  67         ModestWindowType type;
  68         guint            id;
  69 } ModestOpenWindow;
  70 </programlisting>
  71 <para>
  72
  73 </para></refsect2>
  74 <refsect2>
  75 <title><anchor id="ModestWindowMgr" role="struct"/>ModestWindowMgr</title>
  76 <indexterm><primary>ModestWindowMgr</primary></indexterm><programlisting>typedef struct {
  77         GObject parent;
  78 } ModestWindowMgr;
  79 </programlisting>
  80 <para>
  81
  82 </para></refsect2>
  83 <refsect2>
  84 <title><anchor id="modest-window-mgr-new" role="function"/>modest_window_mgr_new ()</title>
  85 <indexterm><primary>modest_window_mgr_new</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*    modest_window_mgr_new           (void);</programlisting>
  86 <para>
  87
  88 </para><variablelist role="params">
  89 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
  90
  91
  92 </simpara></listitem></varlistentry>
  93 </variablelist></refsect2>
  94 <refsect2>
  95 <title><anchor id="modest-window-mgr-register" role="function"/>modest_window_mgr_register ()</title>
  96 <indexterm><primary>modest_window_mgr_register</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_window_mgr_register      (<link linkend="ModestWindowMgr">ModestWindowMgr</link> *self,
  97                                              <link linkend="GObject">GObject</link> *win,
  98                                              <link linkend="ModestWindowType">ModestWindowType</link> type,
  99                                              <link linkend="guint">guint</link> window_id);</programlisting>
 100 <para>
 101
 102 </para><variablelist role="params">
 103 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 104 <listitem><simpara>
 105 </simpara></listitem></varlistentry>
 106 <varlistentry><term><parameter>win</parameter>&nbsp;:</term>
 107 <listitem><simpara>
 108 </simpara></listitem></varlistentry>
 109 <varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 110 <listitem><simpara>
 111 </simpara></listitem></varlistentry>
 112 <varlistentry><term><parameter>window_id</parameter>&nbsp;:</term>
 113 <listitem><simpara>
 114 </simpara></listitem></varlistentry>
 115 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 116
 117
 118 </simpara></listitem></varlistentry>
 119 </variablelist></refsect2>
 120 <refsect2>
 121 <title><anchor id="modest-window-mgr-unregister" role="function"/>modest_window_mgr_unregister ()</title>
 122 <indexterm><primary>modest_window_mgr_unregister</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_window_mgr_unregister    (<link linkend="ModestWindowMgr">ModestWindowMgr</link> *self,
 123                                              <link linkend="GObject">GObject</link> *win);</programlisting>
 124 <para>
 125
 126 </para><variablelist role="params">
 127 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 128 <listitem><simpara>
 129 </simpara></listitem></varlistentry>
 130 <varlistentry><term><parameter>win</parameter>&nbsp;:</term>
 131 <listitem><simpara>
 132 </simpara></listitem></varlistentry>
 133 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 134
 135
 136 </simpara></listitem></varlistentry>
 137 </variablelist></refsect2>
 138 <refsect2>
 139 <title><anchor id="modest-window-mgr-find-by-type" role="function"/>modest_window_mgr_find_by_type ()</title>
 140 <indexterm><primary>modest_window_mgr_find_by_type</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*    modest_window_mgr_find_by_type  (<link linkend="ModestWindowMgr">ModestWindowMgr</link> *self,
 141                                              <link linkend="ModestWindowType">ModestWindowType</link> type);</programlisting>
 142 <para>
 143
 144 </para><variablelist role="params">
 145 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 146 <listitem><simpara>
 147 </simpara></listitem></varlistentry>
 148 <varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 149 <listitem><simpara>
 150 </simpara></listitem></varlistentry>
 151 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 152
 153
 154 </simpara></listitem></varlistentry>
 155 </variablelist></refsect2>
 156 <refsect2>
 157 <title><anchor id="modest-window-mgr-find-by-id" role="function"/>modest_window_mgr_find_by_id ()</title>
 158 <indexterm><primary>modest_window_mgr_find_by_id</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*    modest_window_mgr_find_by_id    (<link linkend="ModestWindowMgr">ModestWindowMgr</link> *self,
 159                                              <link linkend="gint">gint</link> window_id);</programlisting>
 160 <para>
 161
 162 </para><variablelist role="params">
 163 <varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 164 <listitem><simpara>
 165 </simpara></listitem></varlistentry>
 166 <varlistentry><term><parameter>window_id</parameter>&nbsp;:</term>
 167 <listitem><simpara>
 168 </simpara></listitem></varlistentry>
 169 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 170
 171
 172 </simpara></listitem></varlistentry>
 173 </variablelist></refsect2>
 174
 175 </refsect1>
 176
 177
 178
 179
 180 </refentry>