← Back to branch summary

~ubuntu-branches/ubuntu/feisty/libgnome/feisty

« back to all changes in this revision

Viewing changes to doc/reference/xml/gnome-program.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-01-09 10:07:49 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20070109100749-uc3lve73086th31g
Tags: 2.17.2-0ubuntu1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/gnome-program.xml
251
251
    GnomeModuleHook pre_args_parse, post_args_parse;
252
252
 
253
253
#ifdef GNOME_DISABLE_DEPRECATED
254
 
    struct poptOption *_options;
 
254
    void *_options;
255
255
#else
256
256
    struct poptOption *options;
257
257
#endif
429
429
<parameter class="option">--load-modules</parameter> and also in the <parameter
430
430
class="option">GNOME_MODULES</parameter> environment variable.
431
431
</para>
432
 
<para>
433
 
After setting up the module loading, this function then calls (in order)
434
 
<link linkend="gnome-program-preinit"><function>gnome_program_preinit()</function></link>, <link linkend="gnome-program-parse-args"><function>gnome_program_parse_args()</function></link> and
435
 
<link linkend="gnome-program-postinit"><function>gnome_program_postinit()</function></link>.
436
 
</para>
437
432
<para>The following example shows how one might initialise a typical program
438
433
using a goption table that is defined elsewhere.
439
434
</para>
791
786
</simpara></listitem></varlistentry>
792
787
</variablelist></refsect2>
793
788
<refsect2>
794
 
<title><anchor id="gnome-program-preinit" role="function"/>gnome_program_preinit ()</title>
795
 
<indexterm><primary>gnome_program_preinit</primary></indexterm><programlisting><link linkend="poptContext">poptContext</link> gnome_program_preinit           (<link linkend="GnomeProgram">GnomeProgram</link> *program,
 
789
<title><anchor id="gnome-program-preinit" role="function" condition="deprecated:2.18: Use gnome_program_init() instead."/>gnome_program_preinit ()</title>
 
790
<indexterm role="deprecated"><primary>gnome_program_preinit</primary></indexterm><programlisting><link linkend="poptContext">poptContext</link> gnome_program_preinit           (<link linkend="GnomeProgram">GnomeProgram</link> *program,
796
791
                                             const <link linkend="char">char</link> *app_id,
797
792
                                             const <link linkend="char">char</link> *app_version,
798
793
                                             <link linkend="int">int</link> argc,
799
794
                                             <link linkend="char">char</link> **argv);</programlisting>
 
795
<warning><para><literal>gnome_program_preinit</literal> has been deprecated since version 2.18 and should not be used in newly-written code. Use <link linkend="gnome-program-init"><function>gnome_program_init()</function></link> instead.</para></warning>
800
796
<para>
801
797
This function performs the portion of application initialization that
802
798
needs to be done prior to command line argument parsing. The poptContext
824
820
</simpara></listitem></varlistentry>
825
821
</variablelist></refsect2>
826
822
<refsect2>
827
 
<title><anchor id="gnome-program-parse-args" role="function"/>gnome_program_parse_args ()</title>
828
 
<indexterm><primary>gnome_program_parse_args</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_program_parse_args        (<link linkend="GnomeProgram">GnomeProgram</link> *program);</programlisting>
 
823
<title><anchor id="gnome-program-parse-args" role="function" condition="deprecated:2.18: Use gnome_program_init() instead."/>gnome_program_parse_args ()</title>
 
824
<indexterm role="deprecated"><primary>gnome_program_parse_args</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_program_parse_args        (<link linkend="GnomeProgram">GnomeProgram</link> *program);</programlisting>
 
825
<warning><para><literal>gnome_program_parse_args</literal> has been deprecated since version 2.18 and should not be used in newly-written code. Use <link linkend="gnome-program-init"><function>gnome_program_init()</function></link> instead.</para></warning>
829
826
<para>
830
827
Parses the command line arguments for the application</para>
831
828
<para>
836
833
</simpara></listitem></varlistentry>
837
834
</variablelist></refsect2>
838
835
<refsect2>
839
 
<title><anchor id="gnome-program-postinit" role="function"/>gnome_program_postinit ()</title>
840
 
<indexterm><primary>gnome_program_postinit</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_program_postinit          (<link linkend="GnomeProgram">GnomeProgram</link> *program);</programlisting>
 
836
<title><anchor id="gnome-program-postinit" role="function" condition="deprecated:2.18: Use gnome_program_init() instead."/>gnome_program_postinit ()</title>
 
837
<indexterm role="deprecated"><primary>gnome_program_postinit</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_program_postinit          (<link linkend="GnomeProgram">GnomeProgram</link> *program);</programlisting>
 
838
<warning><para><literal>gnome_program_postinit</literal> has been deprecated since version 2.18 and should not be used in newly-written code. Use <link linkend="gnome-program-init"><function>gnome_program_init()</function></link> instead.</para></warning>
841
839
<para>
842
840
Called after <link linkend="gnome-program-parse-args"><function>gnome_program_parse_args()</function></link>, this function
843
841
takes care of post-parse initialization and cleanup</para>
885
883
GOption parsing (write on init only). The <link linkend="GnomeProgram"><type>GnomeProgram</type></link> will assume ownership of the
886
884
passed <link linkend="GOptionContext"><type>GOptionContext</type></link>.
887
885
Mutually exclusive with using the <link linkend="GNOME-PARAM-POPT-TABLE:CAPS"><type>GNOME_PARAM_POPT_TABLE</type></link> parameter.
888
 
</para><para role="since">Since 2.14
 
886
</para><para>Since 2.14
889
887
 
890
888
 
891
889
</para></refsect2>