File: gnome-window.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 (88 lines) | stat: -rw-r--r-- 3,657 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
<refentry id="libgnomeui-gnome-window">
<refmeta>
<refentrytitle role="top_of_page">gnome-window</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gnome-window</refname>
<refpurpose>Convenience functions for setting window attributes.</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="void">void</link>                <link linkend="gnome-window-toplevel-set-title">gnome_window_toplevel_set_title</link>     (<link linkend="GtkWindow">GtkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *doc_name,
                                                         const <link linkend="gchar">gchar</link> *app_name,
                                                         const <link linkend="gchar">gchar</link> *extension);
</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
This module is a convenience wrapper for some similar functions in GTK+. This
allows all GNOME applications to have a consistent way of setting their window
and dialog titles. It is possible that in the future, a configurable way of
setting window titles may be added.
</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gnome-window-toplevel-set-title" role="function" condition="deprecated:"/>gnome_window_toplevel_set_title ()</title>
<indexterm role="deprecated"><primary>gnome_window_toplevel_set_title</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_window_toplevel_set_title     (<link linkend="GtkWindow">GtkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *doc_name,
                                                         const <link linkend="gchar">gchar</link> *app_name,
                                                         const <link linkend="gchar">gchar</link> *extension);</programlisting>
<warning><para><literal>gnome_window_toplevel_set_title</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Set the title of a toplevel window. This is done by appending the
window-specific name (less the extension, if any) to the application name.
So it appears as "&lt;appname&gt; : &lt;docname&gt;".
</para>
<para>
This parameters to this function are appopriate in that it identifies
application windows as containing certain files that are being worked on at
the time (for example, a word processor file, a spreadsheet or an image).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to the toplevel window.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>doc_name</parameter>&nbsp;:</term>
<listitem><simpara> The window-specific name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>app_name</parameter>&nbsp;:</term>
<listitem><simpara> The application name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>extension</parameter>&nbsp;:</term>
<listitem><simpara> The default extension that the application uses. <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there
is not a default extension.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>