File: gnome-mdi-session.xml

package info (click to toggle)
libgnomeui 2.20.1.1-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 13,400 kB
  • ctags: 7,371
  • sloc: ansic: 40,799; xml: 19,721; sh: 8,821; makefile: 443
file content (112 lines) | stat: -rw-r--r-- 5,308 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<refentry id="libgnomeui-gnome-mdi-session">
<refmeta>
<refentrytitle role="top_of_page">gnome-mdi-session</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gnome-mdi-session</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;libgnomeui/libgnomeui.h&gt;


<link linkend="GnomeMDIChild">GnomeMDIChild</link>*      (<link linkend="GnomeMDIChildCreator">*GnomeMDIChildCreator</link>)             (const <link linkend="gchar">gchar</link> *);
<link linkend="gboolean">gboolean</link>            <link linkend="gnome-mdi-restore-state">gnome_mdi_restore_state</link>             (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
                                                         const <link linkend="gchar">gchar</link> *section,
                                                         <link linkend="GnomeMDIChildCreator">GnomeMDIChildCreator</link> create_child_func);
<link linkend="void">void</link>                <link linkend="gnome-mdi-save-state">gnome_mdi_save_state</link>                (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
                                                         const <link linkend="gchar">gchar</link> *section);
</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GnomeMDIChildCreator" role="function" condition="deprecated:"/>GnomeMDIChildCreator ()</title>
<indexterm role="deprecated"><primary>GnomeMDIChildCreator</primary></indexterm><programlisting><link linkend="GnomeMDIChild">GnomeMDIChild</link>*      (*GnomeMDIChildCreator)             (const <link linkend="gchar">gchar</link> *);</programlisting>
<warning><para><literal>GnomeMDIChildCreator</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-restore-state" role="function" condition="deprecated:"/>gnome_mdi_restore_state ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_restore_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_mdi_restore_state             (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
                                                         const <link linkend="gchar">gchar</link> *section,
                                                         <link linkend="GnomeMDIChildCreator">GnomeMDIChildCreator</link> create_child_func);</programlisting>
<warning><para><literal>gnome_mdi_restore_state</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Restores the MDI state. Children are recreated with <parameter>create_child_func</parameter> that
restores information about a child from a config string that was provided
during saving state by the child.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>section</parameter>&nbsp;:</term>
<listitem><simpara> Name of the section to restore MDI state from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>create_child_func</parameter>&nbsp;:</term>
<listitem><simpara> A function that recreates a child from its config string.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
TRUE if state was successfully restored, FALSE otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-save-state" role="function" condition="deprecated:"/>gnome_mdi_save_state ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_save_state</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_mdi_save_state                (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
                                                         const <link linkend="gchar">gchar</link> *section);</programlisting>
<warning><para><literal>gnome_mdi_save_state</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Saves MDI state to the application's config file in section <parameter>section</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>section</parameter>&nbsp;:</term>
<listitem><simpara> Name of the section that the MDI config should be saved to.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>