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

   1 <refentry id="modest-ModestUI">
   2 <refmeta>
   3 <refentrytitle id="top_of_page">ModestUI</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>MODEST Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>ModestUI</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             <link linkend="ModestUI">ModestUI</link>;
  22 <link linkend="GObject">GObject</link>*    <link linkend="modest-ui-new">modest_ui_new</link>                   (<link linkend="ModestConf">ModestConf</link> *modest_conf);
  23 <link linkend="gboolean">gboolean</link>    <link linkend="modest-ui-show-main-window">modest_ui_show_main_window</link>      (<link linkend="ModestUI">ModestUI</link> *ui);
  24 <link linkend="gboolean">gboolean</link>    <link linkend="modest-ui-show-edit-window">modest_ui_show_edit_window</link>      (<link linkend="ModestUI">ModestUI</link> *ui,
  25                                              const <link linkend="gchar">gchar</link> *to,
  26                                              const <link linkend="gchar">gchar</link> *cc,
  27                                              const <link linkend="gchar">gchar</link> *bcc,
  28                                              const <link linkend="gchar">gchar</link> *subject,
  29                                              const <link linkend="gchar">gchar</link> *body,
  30                                              const <link linkend="GSList">GSList</link> *att);
  31
  32 </synopsis>
  33 </refsynopsisdiv>
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43 <refsect1 id="desc">
  44 <title id="desc.title">Description</title>
  45 <para>
  46
  47 </para>
  48 </refsect1>
  49
  50 <refsect1 id="details">
  51 <title id="details.title">Details</title>
  52 <refsect2>
  53 <title><anchor id="ModestUI" role="struct"/>ModestUI</title>
  54 <indexterm><primary>ModestUI</primary></indexterm><programlisting>typedef struct {
  55          GObject parent;
  56         /* insert public members, if any */
  57 } ModestUI;
  58 </programlisting>
  59 <para>
  60
  61 </para></refsect2>
  62 <refsect2>
  63 <title><anchor id="modest-ui-new" role="function"/>modest_ui_new ()</title>
  64 <indexterm><primary>modest_ui_new</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*    modest_ui_new                   (<link linkend="ModestConf">ModestConf</link> *modest_conf);</programlisting>
  65 <para>
  66 </para>
  67 <para>
  68
  69 </para><variablelist role="params">
  70 <varlistentry><term><parameter>modest_conf</parameter>&nbsp;:</term>
  71 <listitem><simpara> a ModestConf instance
  72 </simpara></listitem></varlistentry>
  73 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new ModestUI, or NULL in case of error
  74 </simpara></listitem></varlistentry>
  75 </variablelist></refsect2>
  76 <refsect2>
  77 <title><anchor id="modest-ui-show-main-window" role="function"/>modest_ui_show_main_window ()</title>
  78 <indexterm><primary>modest_ui_show_main_window</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_ui_show_main_window      (<link linkend="ModestUI">ModestUI</link> *ui);</programlisting>
  79 <para>
  80 </para>
  81 <para>
  82
  83 </para><variablelist role="params">
  84 <varlistentry><term><parameter>ui</parameter>&nbsp;:</term>
  85 <listitem><simpara> a ModestUI instance
  86 </simpara></listitem></varlistentry>
  87 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if succeeded, FALSE otherwise
  88
  89 </simpara></listitem></varlistentry>
  90 </variablelist></refsect2>
  91 <refsect2>
  92 <title><anchor id="modest-ui-show-edit-window" role="function"/>modest_ui_show_edit_window ()</title>
  93 <indexterm><primary>modest_ui_show_edit_window</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    modest_ui_show_edit_window      (<link linkend="ModestUI">ModestUI</link> *ui,
  94                                              const <link linkend="gchar">gchar</link> *to,
  95                                              const <link linkend="gchar">gchar</link> *cc,
  96                                              const <link linkend="gchar">gchar</link> *bcc,
  97                                              const <link linkend="gchar">gchar</link> *subject,
  98                                              const <link linkend="gchar">gchar</link> *body,
  99                                              const <link linkend="GSList">GSList</link> *att);</programlisting>
 100 <para>
 101
 102 </para><variablelist role="params">
 103 <varlistentry><term><parameter>ui</parameter>&nbsp;:</term>
 104 <listitem><simpara>
 105 </simpara></listitem></varlistentry>
 106 <varlistentry><term><parameter>to</parameter>&nbsp;:</term>
 107 <listitem><simpara>
 108 </simpara></listitem></varlistentry>
 109 <varlistentry><term><parameter>cc</parameter>&nbsp;:</term>
 110 <listitem><simpara>
 111 </simpara></listitem></varlistentry>
 112 <varlistentry><term><parameter>bcc</parameter>&nbsp;:</term>
 113 <listitem><simpara>
 114 </simpara></listitem></varlistentry>
 115 <varlistentry><term><parameter>subject</parameter>&nbsp;:</term>
 116 <listitem><simpara>
 117 </simpara></listitem></varlistentry>
 118 <varlistentry><term><parameter>body</parameter>&nbsp;:</term>
 119 <listitem><simpara>
 120 </simpara></listitem></varlistentry>
 121 <varlistentry><term><parameter>att</parameter>&nbsp;:</term>
 122 <listitem><simpara>
 123 </simpara></listitem></varlistentry>
 124 <varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 125
 126
 127 </simpara></listitem></varlistentry>
 128 </variablelist></refsect2>
 129
 130 </refsect1>
 131
 132
 133
 134
 135 </refentry>