devel-docs/libgimpwidgets/html/GimpFrame.html


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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpFrame: GIMP Widgets Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="prev" href="GimpFileEntry.html" title="GimpFileEntry">
<link rel="next" href="GimpHintBox.html" title="GimpHintBox">
<meta name="generator" content="GTK-Doc V1.32 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GimpFrame.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GimpFrame.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GimpFrame.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_style_properties">  <span class="dim">|</span> 
                  <a href="#GimpFrame.style-properties" class="shortcut">Style Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpFileEntry.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpHintBox.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpFrame"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpFrame.top_of_page"></a>GimpFrame</span></h2>
<p>GimpFrame — A widget providing a HIG-compliant subclass
of <a href="https://developer.gnome.org/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a>.</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="gimp-widget-frame.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpFrame.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpFrame.html#gimp-frame-new" title="gimp_frame_new ()">gimp_frame_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpFrame.style-properties"></a><h2>Style Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="style_properties_type">
<col width="300px" class="style_properties_name">
<col width="200px" class="style_properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GimpFrame.html#GimpFrame--s-label-bold" title="The “label-bold” style property">label-bold</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="GimpFrame.html#GimpFrame--s-label-spacing" title="The “label-spacing” style property">label-spacing</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpFrame.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GimpFrame.html#GimpFrame-struct" title="GimpFrame">GimpFrame</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpFrame.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> GtkObject
            <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
                <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
                    <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
                        <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gtk3/GtkFrame.html#GtkFrame-struct">GtkFrame</a>
                            <span class="lineart">╰──</span> GimpFrame
</pre>
</div>
<div class="refsect1">
<a name="GimpFrame.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpFrame implements
 AtkImplementorIface and  <a href="https://developer.gnome.org/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GimpFrame.description"></a><h2>Description</h2>
<p>A widget providing a HIG-compliant subclass of <a href="https://developer.gnome.org/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a>.</p>
</div>
<div class="refsect1">
<a name="GimpFrame.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-frame-new"></a><h3>gimp_frame_new ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gimp_frame_new (<em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre>
<p>Creates a <a class="link" href="GimpFrame.html" title="GimpFrame"><span class="type">GimpFrame</span></a> widget. A <a class="link" href="GimpFrame.html" title="GimpFrame"><span class="type">GimpFrame</span></a> is a HIG-compliant
variant of <a href="https://developer.gnome.org/gtk3/GtkFrame.html#GtkFrame-struct"><span class="type">GtkFrame</span></a>. It doesn't render a frame at all but
otherwise behaves like a frame. The frame's title is rendered in
bold and the frame content is indented four spaces as suggested by
the GNOME HIG (see https://developer.gnome.org/hig/stable/).</p>
<div class="refsect3">
<a name="gimp-frame-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>text to set as the frame's title label (or <code class="literal">NULL</code> for no title)</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-frame-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GimpFrame.html" title="GimpFrame"><span class="type">GimpFrame</span></a> widget</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="GimpFrame.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GimpFrame-struct"></a><h3>GimpFrame</h3>
<pre class="programlisting">typedef struct _GimpFrame GimpFrame;</pre>
</div>
</div>
<div class="refsect1">
<a name="GimpFrame.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2">
<a name="GimpFrame--s-label-bold"></a><h3>The <code class="literal">“label-bold”</code> style property</h3>
<pre class="programlisting">  “label-bold”               <span class="type">gboolean</span></pre>
<p>Whether the frame's label should be bold.</p>
<p>Owner: GimpFrame</p>
<p>Flags: Read</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpFrame--s-label-spacing"></a><h3>The <code class="literal">“label-spacing”</code> style property</h3>
<pre class="programlisting">  “label-spacing”            <span class="type">gint</span></pre>
<p>The spacing between the label and the frame content.</p>
<p>Owner: GimpFrame</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 6</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>