/usr/share/gtk-doc/html/gladeui-2/properties.html is in glade 3.18.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Glade User Interface Designer Reference Manual: Property Class Definitions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Glade User Interface Designer Reference Manual">
<link rel="up" href="catalog.html" title="Part I. Adding your custom widgets">
<link rel="prev" href="widgetclasses.html" title="Widget Adaptor Definitions">
<link rel="next" href="pythonsupport.html" title="Python Gtk widgets support">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></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="catalog.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="widgetclasses.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="pythonsupport.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="properties"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">Property Class Definitions</span></h2>
<p>Property Classes —
How to augment or define a <a class="link" href="gladeui-GladePropertyClass.html#GladePropertyClass" title="GladePropertyClass"><span class="type">GladePropertyClass</span></a>
</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="id-1.2.4.3"></a><h2>Property Class Configuration</h2>
<p>
Properties are introspected at load time and loaded into <a class="link" href="gladeui-GladePropertyClass.html#GladePropertyClass" title="GladePropertyClass"><span class="type">GladePropertyClass</span></a> structures.
The behaviour of properties can be modified by the catalog and fake properties can be added
for editing purposes. Here is an example of the xml form:
</p>
<pre class="programlisting">...
<property id="frobnicate-mode" default="FOO_FROBNICATE_RED">
... spec, tooltip etc
<displayable-values>
<value id="FOO_FROBNICATE_RED" name="Red"/>
<value id="FOO_FROBNICATE_BLUE" name="Blue"/>
... values here
</displayable-values>
</property>
...</pre>
<p>
</p>
<p>
Properties of the 'property' tag:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">id</span></p></td>
<td><p>
This is manditory and specifies the property that we are modifying (or adding)
</p></td>
</tr>
<tr>
<td><p><span class="term">name</span></p></td>
<td><p>
The name to be used in the interface.
(if name is not specified; it defaults to the nickname of the <span class="type">GParamSpec</span>)
</p></td>
</tr>
<tr>
<td><p><span class="term">since</span></p></td>
<td><p>
A 'major.minor' formed version describing the version of the owning catalog in which this
property was introduced; example: <code class="literal">since="1.0"</code>. Properties are initialized
to be supported since the introducing <a class="link" href="gladeui-glade-widget-adaptor.html#GladeWidgetAdaptor"><span class="type">GladeWidgetAdaptor</span></a> was supported.
</p></td>
</tr>
<tr>
<td><p><span class="term">disabled</span></p></td>
<td><p>
Remove this property from this widget class and derived classes
</p></td>
</tr>
<tr>
<td><p><span class="term">default</span></p></td>
<td><p>
A default value to be used for this property
</p></td>
</tr>
<tr>
<td><p><span class="term">translatable</span></p></td>
<td><p>
For text properties, whether the property value is translatable in glade
interfaces (this will enable the i18n dialog on text properties). Defaults to False.
</p></td>
</tr>
<tr>
<td><p><span class="term">common</span></p></td>
<td><p>
If set to "True", the property will end up on the common tab even if
its not a property of GtkWidgetClass.
</p></td>
</tr>
<tr>
<td><p><span class="term">optional</span></p></td>
<td><p>
Whether this property is an optional property, this will make the property
insensitive and add a check box to enable it (like width/height-request for
example).
</p></td>
</tr>
<tr>
<td><p><span class="term">optional-default</span></p></td>
<td><p>
If this is in fact an optional property; whether it is enabled by default.
</p></td>
</tr>
<tr>
<td><p><span class="term">query</span></p></td>
<td><p>
If query is set; the property will be queried from the user in a dialog
when adding the owning widget class instance to the project.
</p></td>
</tr>
<tr>
<td><p><span class="term">save</span></p></td>
<td><p>
Whether to save this property to the glade file (default "True")
</p></td>
</tr>
<tr>
<td><p><span class="term">visible</span></p></td>
<td><p>
Whether to show the property in the editor and reset dialog (default "True")
</p></td>
</tr>
<tr>
<td><p><span class="term">custom-layout</span></p></td>
<td><p>
This is used to avoid loading this property in the editor when implementing
a custom <span class="type">GladeEditable</span> that embeds the base <a class="link" href="gladeui-glade-editor.html#GladeEditorTable" title="struct GladeEditorTable"><span class="type">GladeEditorTable</span></a> implementation,
custom-layout properties will still show up in the reset dialog (default "False)
</p></td>
</tr>
<tr>
<td><p><span class="term">ignore</span></p></td>
<td><p>
Whether to set the property on the object instance (via g_object_set_property or
plugin override functions) when it changes in the editor (the value in the editor
is the value saved).
</p></td>
</tr>
<tr>
<td><p><span class="term">themed-icon</span></p></td>
<td><p>
Depicts a string property that is used for an icon from the theme. These will
the appropriate editor.
</p></td>
</tr>
<tr>
<td><p><span class="term">weight</span></p></td>
<td><p>
A numerical value to specify this properties position in the property editor.
</p></td>
</tr>
<tr>
<td><p><span class="term">transfer-on-paste</span></p></td>
<td><p>
Used for packing properties; depicts packing properties that should follow
the widget when pasted to a new container that supports the same properties.
</p></td>
</tr>
<tr>
<td><p><span class="term">save-always</span></p></td>
<td><p>
Specifies that the property should be saved regardless of its value (properties at thier
default values are normally not saved).
</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
<p>
Child tags of the 'property' tag:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">spec</span></p></td>
<td><p>
Specifies a function to be used to return a <span class="type">GParamSpec</span> for this property;
this is used to add virtual properties to an object (like the "size" property
on <span class="type">GtkBox</span>).
</p></td>
</tr>
<tr>
<td><p><span class="term">tooltip</span></p></td>
<td><p>
The tooltip to be displayed in the property editor for this property.
The tooltip defaults to the blurb of the associated <span class="type">GParamSpec</span>.
</p></td>
</tr>
<tr>
<td><p><span class="term">visible-lines</span></p></td>
<td><p>
An integer value to specify how many lines will be shown for text properties
in the editor (this doesnt really work because of the complexity of calculating
size of rendered text; instead, just set this to 2 if you want the text property
to be edited in a textview with a scrolled window as opposed to a simple text entry).
</p></td>
</tr>
<tr>
<td><p><span class="term">displayable-values</span></p></td>
<td><p>
Allows you to specify user friendly strings for enum and flag values as shown in the
example above, use the `id' property in the value tag to depict the real value name
and the `name' property for the human readable one.
</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|