Gladeui.EditorProperty¶

Subclasses:: Gladeui.EPropBool, Gladeui.EPropCheck, Gladeui.EPropColor, Gladeui.EPropEnum, Gladeui.EPropFlags, Gladeui.EPropNamedIcon, Gladeui.EPropNumeric, Gladeui.EPropObject, Gladeui.EPropObjects, Gladeui.EPropText, Gladeui.EPropUnichar

Methods¶

Inherited:: Gtk.Box (14), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Orientable (2), Gladeui.Editable (6)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`show_i18n_dialog` (parent, text, context, comment, translatable)
class	`show_object_dialog` (project, title, parent, object_type, exception, object)
class	`show_resource_dialog` (project, parent, filename)
	`commit` (value)
	`commit_no_callback` (value)
	`get_custom_text` ()
	`get_disable_check` ()
	`get_item_label` ()
	`get_property` ()
	`get_property_def` ()
	`load` (property)
	`load_by_widget` (widget)
	`loading` ()
	`set_custom_text` (custom_text)
	`set_disable_check` (disable_check)

Virtual Methods¶

Inherited:: Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gladeui.Editable (2)

	`do_changed` (property)
	`do_commit` (value)
	`do_load` (property)

Properties¶

Inherited:: Gtk.Box (3), Gtk.Container (3), Gtk.Widget (39), Gtk.Orientable (1)

Name	Type	Flags	Short Description
`custom-text`	`str`	r/w	Custom Text to display in the property label
`disable-check`	`bool`	r/w/c	Whether to explicitly disable the check button
`property-def`	`int`	r/w/co	The `Gladeui.PropertyDef` this `Gladeui.EditorProperty` was created for
`use-command`	`bool`	r/w	Whether we should use the command API for the undo/redo stack

Child Properties¶

Inherited:: Gtk.Box (5)

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Short Description
`commit`	Emitted when a property’s value is committed, can be useful to serialize commands before and after the property’s commit command from custom editors.
`value-changed`	Emitted when a contained property changes value

Fields¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gtk.Box`	r

Class Details¶

class Gladeui.EditorProperty(*args, **kwargs)¶

Bases:: Gtk.Box, Gladeui.Editable
Abstract:: No
Structure:: Gladeui.EditorPropertyClass

classmethod show_i18n_dialog(parent, text, context, comment, translatable)¶

Parameters:

parent (Gtk.Widget) – The parent widget for the dialog.
text (str) – A read/write pointer to the text property
context (str) – A read/write pointer to the translation context
comment (str) – A read/write pointer to the translator comment
translatable (bool) – A read/write pointer to the translatable setting]

Returns:

True if OK was selected.

Return type:

bool

Runs a dialog and updates the provided values.

classmethod show_object_dialog(project, title, parent, object_type, exception, object)¶

Parameters:

project (Gladeui.Project) –
title (str) –
parent (Gtk.Widget) –
object_type (GObject.GType) –
exception (Gladeui.Widget) –
object (Gladeui.Widget) –

Return type:

bool

classmethod show_resource_dialog(project, parent, filename)¶

Parameters:

project (Gladeui.Project) –
parent (Gtk.Widget) –
filename (str) –

Return type:

bool

commit(value)¶

Parameters:: value (GObject.Value) – The GObject.Value to commit

Commits value to the property currently being edited by self.

commit_no_callback(value)¶

Parameters:: value (GObject.Value) –

get_custom_text()¶

Return type:: str

get_disable_check()¶

Return type:: bool

get_item_label()¶

Returns:: the Gladeui.PropertyLabel
Return type:: Gtk.Widget

get_property()¶

Returns:: the Gladeui.Property
Return type:: Gladeui.Property

get_property_def()¶

Returns:: the Gladeui.PropertyDef
Return type:: Gladeui.PropertyDef

load(property)¶

Parameters:: property (Gladeui.Property) – A Gladeui.Property

Loads property values into self and connects. (the editor property will watch the property’s value until its loaded with another property or None)

load_by_widget(widget)¶

Parameters:: widget (Gladeui.Widget) – A Gladeui.Widget

Convenience function to load the appropriate Gladeui.Property into self from widget

loading()¶

Return type:: bool

set_custom_text(custom_text)¶

Parameters:: custom_text (str) –

set_disable_check(disable_check)¶

Parameters:: disable_check (bool) –

do_changed(property) virtual¶

Parameters:: property (Gladeui.Property) –
Return type:: object or None

do_commit(value) virtual¶

Parameters:: value (GObject.Value) – The GObject.Value to commit

Commits value to the property currently being edited by eprop.

do_load(property) virtual¶

Parameters:: property (Gladeui.Property) – A Gladeui.Property

Loads property values into eprop and connects. (the editor property will watch the property’s value until its loaded with another property or None)

Signal Details¶

Gladeui.EditorProperty.signals.commit(editor_property, arg1)¶

Signal Name:

commit

Flags:

RUN_LAST

Parameters:

editor_property (Gladeui.EditorProperty) – The object which received the signal
arg1 (object or None) – the new GObject.Value to commit.

Emitted when a property’s value is committed, can be useful to serialize commands before and after the property’s commit command from custom editors.

Gladeui.EditorProperty.signals.value_changed(editor_property, arg1)¶

Signal Name:

value-changed

Flags:

RUN_LAST

Parameters:

editor_property (Gladeui.EditorProperty) – The object which received the signal
arg1 (Gladeui.Property) – the Gladeui.Property that’s value changed.

Emitted when a contained property changes value

Property Details¶

Gladeui.EditorProperty.props.custom_text¶

Name:: custom-text
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Custom Text to display in the property label

Gladeui.EditorProperty.props.disable_check¶

Name:: disable-check
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

Whether to explicitly disable the check button

Gladeui.EditorProperty.props.property_def¶

Name:: property-def
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Gladeui.PropertyDef this Gladeui.EditorProperty was created for

Gladeui.EditorProperty.props.use_command¶

Name:: use-command
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether we should use the command API for the undo/redo stack