File: libgnomeui-gnome-window.html

package info (click to toggle)
libgnomeui 2.24.5-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 12,428 kB
  • sloc: ansic: 37,044; sh: 11,082; makefile: 409; xml: 18
file content (109 lines) | stat: -rw-r--r-- 6,568 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gnome-window</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="deprecated.html" title="Deprecated Modules">
<link rel="prev" href="libgnomeui-GnomeThemeFile.html" title="GnomeThemeFile">
<link rel="next" href="libgnomeui-gnome-window-icon.html" title="gnome-window-icon">
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgnomeui-GnomeThemeFile.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="deprecated.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="libgnomeui-gnome-window-icon.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgnomeui-gnome-window.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgnomeui-gnome-window.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgnomeui-gnome-window"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgnomeui-gnome-window.top_of_page"></a>gnome-window</span></h2>
<p>gnome-window — Convenience functions for setting window attributes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgnomeui-gnome-window.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgnomeui/libgnomeui.h&gt;

<span class="returnvalue">void</span>                <a class="link" href="libgnomeui-gnome-window.html#gnome-window-toplevel-set-title" title="gnome_window_toplevel_set_title ()">gnome_window_toplevel_set_title</a>     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *doc_name</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *app_name</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *extension</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgnomeui-gnome-window.description"></a><h2>Description</h2>
<p>
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.
</p>
</div>
<div class="refsect1">
<a name="libgnomeui-gnome-window.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gnome-window-toplevel-set-title"></a><h3>gnome_window_toplevel_set_title ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_window_toplevel_set_title     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *doc_name</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *app_name</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *extension</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_window_toplevel_set_title</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
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;".
</p>
<p>
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).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>A pointer to the toplevel window.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc_name</code></em> :</span></p></td>
<td>The window-specific name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_name</code></em> :</span></p></td>
<td>The application name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>extension</code></em> :</span></p></td>
<td>The default extension that the application uses. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there
is not a default extension.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.16</div>
</body>
</html>