Gladeui.PropertyDef¶

Fields¶

None

Methods¶

class	`get_default_from_spec` (spec)
class	`make_flags_from_string` (type, string)
class	`new` (adaptor, id)
class	`new_from_spec` (adaptor, spec)
class	`new_from_spec_full` (adaptor, spec, need_handle)
class	`set_weights` (properties, parent)
class	`update_from_node` (node, object_type, property_def_ref, domain)
	`atk` ()
	`clone` ()
	`common` ()
	`compare` (value1, value2)
	`create_type` ()
	`custom_layout` ()
	`deprecated` ()
	`deprecated_since_major` ()
	`deprecated_since_minor` ()
	`free` ()
	`get_adaptor` ()
	`get_construct_only` ()
	`get_default` ()
	`get_ignore` ()
	`get_is_packing` ()
	`get_name` ()
	`get_original_default` ()
	`get_pspec` ()
	`get_tooltip` ()
	`get_virtual` ()
	`id` ()
	`is_object` ()
	`is_visible` ()
	`load_defaults_from_spec` ()
	`make_adjustment` ()
	`make_gvalue_from_string` (string, project)
	`make_string_from_gvalue` (value)
	`match` (comp)
	`multiline` ()
	`needs_sync` ()
	`optional` ()
	`optional_default` ()
	`parentless_widget` ()
	`query` ()
	`save` ()
	`save_always` ()
	`set_adaptor` (adaptor)
	`set_construct_only` (construct_only)
	`set_ignore` (ignore)
	`set_is_packing` (is_packing)
	`set_name` (name)
	`set_pspec` (pspec)
	`set_tooltip` (tooltip)
	`set_virtual` (value)
	`since_major` ()
	`since_minor` ()
	`stock` ()
	`stock_icon` ()
	`themed_icon` ()
	`transfer_on_paste` ()
	`translatable` ()
	`void_value` (value)
	`weight` ()

Details¶

class Gladeui.PropertyDef¶

classmethod get_default_from_spec(spec)¶

Parameters:: spec (GObject.ParamSpec) –
Return type:: GObject.Value

classmethod make_flags_from_string(type, string)¶

Parameters:

type (GObject.GType) –
string (str) –

Return type:

int

classmethod new(adaptor, id)¶

Parameters:

adaptor (Gladeui.WidgetAdaptor) – The Gladeui.WidgetAdaptor to create this property for
id (str) – the id for the new property class

Returns:

a new Gladeui.PropertyDef

Return type:

Gladeui.PropertyDef

classmethod new_from_spec(adaptor, spec)¶

Parameters:

adaptor (Gladeui.WidgetAdaptor) – A generic pointer (i.e. a Gladeui.WidgetAdaptor)
spec (GObject.ParamSpec) – A GObject.ParamSpec

Returns:

a newly created Gladeui.PropertyDef based on spec or None if its unsupported.

Return type:

Gladeui.PropertyDef

classmethod new_from_spec_full(adaptor, spec, need_handle)¶

Parameters:

adaptor (Gladeui.WidgetAdaptor) –
spec (GObject.ParamSpec) –
need_handle (bool) –

Return type:

Gladeui.PropertyDef

classmethod set_weights(properties, parent)¶

Parameters:

properties ([Gladeui.PropertyDef]) – a list of Gladeui.PropertyDef
parent (GObject.GType) – the GObject.GType of the parent

This function assigns “weight” to each property in its natural order staring from 1. If parent is 0 weight will be set for every Gladeui.PropertyDef in the list. This function will not override weight if it is already set (weight >= 0.0)

classmethod update_from_node(node, object_type, property_def_ref, domain)¶

Parameters:

node (Gladeui.XmlNode) – the property node
object_type (GObject.GType) – the GObject.GType of the owning object
property_def_ref (Gladeui.PropertyDef or None) – a pointer to the property class
domain (str) – the domain to translate catalog strings from

Returns:

True on success. property_def_ref is set to None if the property has Disabled=”True".

property_def_ref:: a pointer to the property class

Return type:

(bool, property_def_ref: Gladeui.PropertyDef or None)

Updates the property_def_ref with the contents of the node in the xml file. Only the values found in the xml file are overridden.

atk()¶

Return type:: bool

clone()¶

Returns:: a new Gladeui.PropertyDef cloned from self
Return type:: Gladeui.PropertyDef

common()¶

Return type:: bool

compare(value1, value2)¶

Parameters:

value1 (GObject.Value) – a GObject.Value of correct type for self
value2 (GObject.Value) – a GObject.Value of correct type for self

Returns:

-1, 0 or +1, if value1 is found to be less than, equal to or greater than value2, respectively.

Return type:

int

Compares value1 with value2 according to self.

create_type()¶

Return type:: str

custom_layout()¶

Return type:: bool

deprecated()¶

Return type:: bool

deprecated_since_major()¶

Return type:: int

deprecated_since_minor()¶

Return type:: int

free()¶: Frees self and its associated memory.

get_adaptor()¶

Returns:: The Gladeui.WidgetAdaptor associated with the self
Return type:: Gladeui.WidgetAdaptor

get_construct_only()¶

Return type:: bool

get_default()¶

Return type:: GObject.Value

get_ignore()¶

Return type:: bool

get_is_packing()¶

Return type:: bool

get_name()¶

Return type:: str

get_original_default()¶

Return type:: GObject.Value

get_pspec()¶

Returns:: The GObject.ParamSpec associated with the self
Return type:: GObject.ParamSpec

get_tooltip()¶

Return type:: str

get_virtual()¶

Return type:: bool

id()¶

Return type:: str

is_object()¶

Returns:: whether or not this is an object property that refers to another object in this project.
Return type:: bool

is_visible()¶

Returns:: whether or not to show this property in the editor
Return type:: bool

load_defaults_from_spec()¶

make_adjustment()¶

Returns:: An appropriate Gtk.Adjustment for use in the Property editor
Return type:: Gtk.Adjustment

Creates and appropriate Gtk.Adjustment for use in the editor

make_gvalue_from_string(string, project)¶

Parameters:

string (str) – a string representation of this property
project (Gladeui.Project) – the Gladeui.Project that the property should be resolved for

Returns:

A GObject.Value created based on the self and string criteria.

Return type:

GObject.Value

make_string_from_gvalue(value)¶

Parameters:: value (GObject.Value) – A GObject.Value
Returns:: A newly allocated string representation of value
Return type:: str

match(comp)¶

Parameters:: comp (Gladeui.PropertyDef) – a Gladeui.PropertyDef
Returns:: whether self and comp are a match or not (properties in separate descendant hierarchies that have the same name are not matches).
Return type:: bool

multiline()¶

Return type:: bool

needs_sync()¶

Return type:: bool

optional()¶

Return type:: bool

optional_default()¶

Return type:: bool

parentless_widget()¶

Return type:: bool

query()¶

Return type:: bool

save()¶

Return type:: bool

save_always()¶

Return type:: bool

set_adaptor(adaptor)¶

Parameters:: adaptor (Gladeui.WidgetAdaptor) – A Gladeui.WidgetAdaptor

set_construct_only(construct_only)¶

Parameters:: construct_only (bool) –

set_ignore(ignore)¶

Parameters:: ignore (bool) –

set_is_packing(is_packing)¶

Parameters:: is_packing (bool) –

set_name(name)¶

Parameters:: name (str) –

set_pspec(pspec)¶

Parameters:: pspec (GObject.ParamSpec) – A GObject.ParamSpec

set_tooltip(tooltip)¶

Parameters:: tooltip (str) –

set_virtual(value)¶

Parameters:: value (bool) –

since_major()¶

Return type:: int

since_minor()¶

Return type:: int

stock()¶

Return type:: bool

stock_icon()¶

Return type:: bool

themed_icon()¶

Return type:: bool

transfer_on_paste()¶

Return type:: bool

translatable()¶

Return type:: bool

void_value(value)¶

Parameters:: value (GObject.Value) – a GObject.Value of correct type for self
Returns:: Whether value for this self is voided; a voided value can be a None value for boxed or object type param specs.
Return type:: bool

weight()¶

Return type:: float