|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<html>
|
|
Packit |
1e8aac |
<head>
|
|
Packit |
1e8aac |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
1e8aac |
<title>Property Class Definitions: Glade User Interface Designer Reference Manual</title>
|
|
Packit |
1e8aac |
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
|
Packit |
1e8aac |
<link rel="home" href="index.html" title="Glade User Interface Designer Reference Manual">
|
|
Packit |
1e8aac |
<link rel="up" href="catalog.html" title="Part I. Adding your custom widgets">
|
|
Packit |
1e8aac |
<link rel="prev" href="widgetclasses.html" title="Widget Adaptor Definitions">
|
|
Packit |
1e8aac |
<link rel="next" href="pythonsupport.html" title="Python Gtk widgets support">
|
|
Packit |
1e8aac |
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
|
|
Packit |
1e8aac |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
1e8aac |
</head>
|
|
Packit |
1e8aac |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Property Class Definitions
|
|
Packit |
1e8aac |
Property Classes —
|
|
Packit |
1e8aac |
How to augment or define a GladePropertyClass
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Property Class Configuration
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Properties are introspected at load time and loaded into GladePropertyClass structures.
|
|
Packit |
1e8aac |
The behaviour of properties can be modified by the catalog and fake properties can be added
|
|
Packit |
1e8aac |
for editing purposes. Here is an example of the xml form:
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
...
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<property id="frobnicate-mode" default="FOO_FROBNICATE_RED">
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
... spec, tooltip etc
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<displayable-values>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
<value id="FOO_FROBNICATE_RED" name="Red"/>
|
|
Packit |
1e8aac |
<value id="FOO_FROBNICATE_BLUE" name="Blue"/>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
... values here
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
</displayable-values>
|
|
Packit |
1e8aac |
</property>
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
...
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Properties of the 'property' tag:
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
id
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
This is manditory and specifies the property that we are modifying (or adding)
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
name
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
The name to be used in the interface.
|
|
Packit |
1e8aac |
(if name is not specified; it defaults to the nickname of the GParamSpec)
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
since
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
A 'major.minor' formed version describing the version of the owning catalog in which this
|
|
Packit |
1e8aac |
property was introduced; example: since="1.0". Properties are initialized
|
|
Packit |
1e8aac |
to be supported since the introducing GladeWidgetAdaptor was supported.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
disabled
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Remove this property from this widget class and derived classes
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
default
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
A default value to be used for this property
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
translatable
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
For text properties, whether the property value is translatable in glade
|
|
Packit |
1e8aac |
interfaces (this will enable the i18n dialog on text properties). Defaults to False.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
common
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
If set to "True", the property will end up on the common tab even if
|
|
Packit |
1e8aac |
its not a property of GtkWidgetClass.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
optional
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Whether this property is an optional property, this will make the property
|
|
Packit |
1e8aac |
insensitive and add a check box to enable it (like width/height-request for
|
|
Packit |
1e8aac |
example).
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
optional-default
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
If this is in fact an optional property; whether it is enabled by default.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
query
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
If query is set; the property will be queried from the user in a dialog
|
|
Packit |
1e8aac |
when adding the owning widget class instance to the project.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
save
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Whether to save this property to the glade file (default "True")
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
visible
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Whether to show the property in the editor and reset dialog (default "True")
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
custom-layout
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
This is used to avoid loading this property in the editor when implementing
|
|
Packit |
1e8aac |
a custom GladeEditable that embeds the base GladeEditorTable implementation,
|
|
Packit |
1e8aac |
custom-layout properties will still show up in the reset dialog (default "False)
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
ignore
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Whether to set the property on the object instance (via g_object_set_property or
|
|
Packit |
1e8aac |
plugin override functions) when it changes in the editor (the value in the editor
|
|
Packit |
1e8aac |
is the value saved).
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
themed-icon
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Depicts a string property that is used for an icon from the theme. These will
|
|
Packit |
1e8aac |
the appropriate editor.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
weight
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
A numerical value to specify this properties position in the property editor.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
transfer-on-paste
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Used for packing properties; depicts packing properties that should follow
|
|
Packit |
1e8aac |
the widget when pasted to a new container that supports the same properties.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
save-always
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Specifies that the property should be saved regardless of its value (properties at thier
|
|
Packit |
1e8aac |
default values are normally not saved).
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Child tags of the 'property' tag:
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
spec
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Specifies a function to be used to return a GParamSpec for this property;
|
|
Packit |
1e8aac |
this is used to add virtual properties to an object (like the "size" property
|
|
Packit |
1e8aac |
on GtkBox).
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
tooltip
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
The tooltip to be displayed in the property editor for this property.
|
|
Packit |
1e8aac |
The tooltip defaults to the blurb of the associated GParamSpec.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
visible-lines
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
An integer value to specify how many lines will be shown for text properties
|
|
Packit |
1e8aac |
in the editor (this doesnt really work because of the complexity of calculating
|
|
Packit |
1e8aac |
size of rendered text; instead, just set this to 2 if you want the text property
|
|
Packit |
1e8aac |
to be edited in a textview with a scrolled window as opposed to a simple text entry).
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
displayable-values
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Allows you to specify user friendly strings for enum and flag values as shown in the
|
|
Packit |
1e8aac |
example above, use the `id' property in the value tag to depict the real value name
|
|
Packit |
1e8aac |
and the `name' property for the human readable one.
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
|
|
Packit |
1e8aac |
Generated by GTK-Doc V1.28
|
|
Packit |
1e8aac |
</body>
|
|
Packit |
1e8aac |
</html>
|