Gladeui.Widget

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	get_device_from_event (event)
class	get_from_gobject (object)
class	pop_superuser ()
class	push_superuser ()
class	read (project, parent, node, internal)
class	superuser ()
	adaptor_create_internal (internal_object, internal_name, parent_name, anarchist, reason)
	add_child (child, at_mouse)
	add_prop_ref (property)
	add_signal_handler (signal_handler)
	add_verify (child, user_feedback)
	change_signal_handler (old_signal_handler, new_signal_handler)
	child_get_property (child, property_name, value)
	child_set_property (child, property_name, value)
	copy_properties (template_widget, copy_parentless, exact)
	copy_signals (template_widget)
	create_editor_property (property, packing, use_command)
	depends (other)
	dup (exact)
	dup_properties (template_props, as_load, copy_parentless, exact)
	ensure_name (project, use_command)
	event (event)
	find_child (name)
	generate_path_name ()
	get_action (action_path)
	get_actions ()
	get_adaptor ()
	get_children ()
	get_display_name ()
	get_internal ()
	get_is_composite ()
	get_locker ()
	get_name ()
	get_object ()
	get_pack_action (action_path)
	get_pack_actions ()
	get_pack_property (id_property)
	get_packing_properties ()
	get_parent ()
	get_parentless_reffed_widgets ()
	get_parentless_widget_ref ()
	get_project ()
	get_properties ()
	get_property (id_property)
	get_signal_list ()
	get_signal_model ()
	get_toplevel ()
	has_decendant (type)
	has_name ()
	has_prop_refs ()
	hide ()
	in_project ()
	is_ancestor (ancestor)
	list_locked_widgets ()
	list_prop_refs ()
	list_signal_handlers (signal_name)
	lock (locked)
	object_get_property (property_name, value)
	object_set_property (property_name, value)
	pack_property_default (id_property)
	pack_property_reset (id_property)
	pack_property_set_enabled (id_property, enabled)
	pack_property_set_save_always (id_property, setting)
	pack_property_set_sensitive (id_property, sensitive, reason)
	pack_property_string (id_property, value)
	placeholder_relation (widget)
	property_default (id_property)
	property_original_default (id_property)
	property_reset (id_property)
	property_set_enabled (id_property, enabled)
	property_set_save_always (id_property, setting)
	property_set_sensitive (id_property, sensitive, reason)
	property_string (id_property, value)
	read_child (node)
	rebuild ()
	remove_child (child)
	remove_prop_ref (property)
	remove_property (id_property)
	remove_signal_handler (signal_handler)
	replace (old_object, new_object)
	set_action_sensitive (action_path, sensitive)
	set_action_visible (action_path, visible)
	set_child_type_from_node (child, node)
	set_in_project (in_project)
	set_internal (internal)
	set_is_composite (composite)
	set_name (name)
	set_pack_action_sensitive (action_path, sensitive)
	set_pack_action_visible (action_path, visible)
	set_packing_properties (container)
	set_parent (parent)
	set_project (project)
	set_support_warning (warning)
	show ()
	support_changed ()
	support_warning ()
	unlock ()
	verify ()
	write (context, node)
	write_child (child, context, node)
	write_placeholder (object, context, node)
	write_signals (context, node)
	write_special_child_prop (object, context, node)

Virtual Methods

Inherited:

GObject.Object (7)

	do_add_child (child, at_mouse)
	do_add_signal_handler (signal_handler)
	do_button_press_event (event)
	do_button_release_event (event)
	do_change_signal_handler (new_signal_handler)
	do_event (event)
	do_motion_notify_event (event)
	do_remove_child (child)
	do_remove_signal_handler (signal_handler)
	do_replace_child (old_object, new_object)

Properties

Name	Type	Flags	Short Description
adaptor	Gladeui.WidgetAdaptor	r/w/co	The class adaptor for the associated widget
anarchist	bool	r/w/co	Whether this composite child is an ancestral child or an anarchist child
composite	bool	r/w	Whether this widget is the template for a composite widget
internal	str	r/w/c	The internal name of the widget
internal-name	str	w/co	A generic name prefix for internal widgets
name	str	r/w/c	The name of the widget
object	GObject.Object	r/w/c	The object associated
parent	Gladeui.Widget	r/w/c	A pointer to the parenting Gladeui.Widget
project	Gladeui.Project	r/w/c	The glade project that this widget belongs to
properties	int	r/w/co	A list of GladeProperties
reason	int	r/w/co	A Gladeui.CreateReason for this creation
support-warning	str	r	A warning string about version mismatches
template	Gladeui.Widget	w/co	A Gladeui.Widget template to base a new widget on
template-exact	bool	w/co	Whether we are creating an exact duplicate when using a template
toplevel-height	int	r/w	The height of the widget when toplevel in the GladeDesignLayout
toplevel-width	int	r/w	The width of the widget when toplevel in the GladeDesignLayout
visible	bool	r	Whether the widget is visible or not

Signals

Inherited:

GObject.Object (1)

Name	Short Description
add-signal-handler
button-press-event
button-release-event
change-signal-handler
motion-notify-event
remove-signal-handler
support-changed	Emitted when property and signal support metadatas and messages have been updated.

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	GObject.InitiallyUnowned	r

Class Details

class Gladeui.Widget(**kwargs)

Bases:

GObject.InitiallyUnowned

Abstract:

No

Structure:

Gladeui.WidgetClass

classmethod get_device_from_event(event)

Parameters:

event (Gdk.Event) – a Gdk.Event

Returns:

the associated Gdk.Device for this glade widget event.

Return type:

Gdk.Device

Currently only motion and button events are handled (see GLADE_WIDGET_IS_EVENT)

Deprecated since version ???: use Gdk.Event.get_device() instead.

classmethod get_from_gobject(object)

Parameters:

object (object or None) – A GObject.Object containing the widget

Returns:

a Gladeui.Widget

Return type:

Gladeui.Widget

classmethod pop_superuser()

Unsets superuser mode

classmethod push_superuser()

Sets superuser mode

classmethod read(project, parent, node, internal)

Parameters:

• project (Gladeui.Project) – a Gladeui.Project

• parent (Gladeui.Widget or None) – The parent Gladeui.Widget or None

• node (Gladeui.XmlNode) – a Gladeui.XmlNode

• internal (str or None) – the name of an internal child name

Returns:

a new Gladeui.Widget for project, based on node

Return type:

Gladeui.Widget

Creates a new Gladeui.Widget from a XML node.

If node is a template and its parent class is abstract/non instantiatable, Glade will use a class with the GladeInstantiable prefix instead.

For example, with a Gtk.Bin template Glade will GladeInstantiableGtkBin class

classmethod superuser()

Return type:

bool

Checks if we are in superuser mode.

Superuser mode is when we are

• Loading a project

• Dupping a widget recursively

• Rebuilding an instance for a construct-only property

In these cases, we must act like a load, this should be checked from the plugin when implementing containers, when undo/redo comes around, the plugin is responsable for maintaining the same container size when widgets are added/removed.

adaptor_create_internal(internal_object, internal_name, parent_name, anarchist, reason)

Parameters:

• internal_object (GObject.Object) – the GObject.Object

• internal_name (str) – a string identifier for this internal widget.

• parent_name (str) – the generic name of the parent used for fancy child names.

• anarchist (bool) – Whether or not this widget is a widget outside of the parent’s hierarchy (like a popup window)

• reason (Gladeui.CreateReason) – The Gladeui.CreateReason for which this internal widget was created (usually just pass the reason from the post_create function; note also this is used only by the plugin code so pass something useful here).

Returns:

a freshly created Gladeui.Widget wrapper object for the internal_object of name internal_name

Return type:

Gladeui.Widget

A convenience function to create a Gladeui.Widget of the prescribed type for internal widgets.

add_child(child, at_mouse)

Parameters:

• child (Gladeui.Widget) – the Gladeui.Widget to add

• at_mouse (bool) – whether the added widget should be added at the current mouse position

Adds child to self in a generic way for this Gladeui.Widget parent.

add_prop_ref(property)

Parameters:

property (Gladeui.Property) – the Gladeui.Property

Adds property to self ‘s list of referenced properties.

Note: this is used to track properties on other objects that refer to this object.

add_signal_handler(signal_handler)

Parameters:

signal_handler (Gladeui.Signal) – The Gladeui.Signal

Adds a signal handler for self

add_verify(child, user_feedback)

Parameters:

• child (Gladeui.Widget) – The child Gladeui.Widget to add

• user_feedback (bool) – whether a notification dialog should be presented in the case that the child cannot not be added.

Returns:

whether child can be added to self.

Return type:

bool

Checks whether child can be added to parent.

If user_feedback is True and child cannot be added then this shows a notification dialog to the user explaining why.

change_signal_handler(old_signal_handler, new_signal_handler)

Parameters:

• old_signal_handler (Gladeui.Signal) – the old Gladeui.Signal

• new_signal_handler (Gladeui.Signal) – the new Gladeui.Signal

Changes a Gladeui.Signal on self

child_get_property(child, property_name, value)

Parameters:

• child (Gladeui.Widget) – The Gladeui.Widget child

• property_name (str) – The id of the property

• value (GObject.Value) – The GValue

Gets child's packing property identified by property_name.

child_set_property(child, property_name, value)

Parameters:

• child (Gladeui.Widget) – The Gladeui.Widget child

• property_name (str) – The id of the property

• value (GObject.Value) – The GValue

Sets child's packing property identified by property_name to value.

copy_properties(template_widget, copy_parentless, exact)

Parameters:

• template_widget (Gladeui.Widget) – a ‘src’ Gladeui.Widget

• copy_parentless (bool) – whether to copy reffed widgets at all

• exact (bool) – whether to copy reffed widgets exactly

Sets properties in self based on the values of matching properties in template_widget

copy_signals(template_widget)

Parameters:

template_widget (Gladeui.Widget) – a ‘src’ Gladeui.Widget

Sets signals in self based on the values of matching signals in template_widget

create_editor_property(property, packing, use_command)

Parameters:

• property (str) – The widget’s property

• packing (bool) – whether property indicates a packing property or not.

• use_command (bool) – Whether the undo/redo stack applies here.

Returns:

A newly created and connected Gladeui.EditorProperty

Return type:

Gladeui.EditorProperty

This is a convenience function to create a Gladeui.EditorProperty corresponding to property

depends(other)

Parameters:

other (Gladeui.Widget) – another Gladeui.Widget

Returns:

True if self depends on other.

Return type:

bool

Determines whether self is somehow dependent on other, in which case it should be serialized after other.

A widget is dependent on another widget. It does not take into account for children dependencies.

Deprecated since version 3.18.

dup(exact)

Parameters:

exact (bool) – whether or not to creat an exact duplicate

Returns:

The newly created Gladeui.Widget

Return type:

Gladeui.Widget

Creates a deep copy of Gladeui.Widget. if exact is specified, the widget name is preserved and signals are carried over (this is used to maintain names & signals in Cut/Paste context as opposed to Copy/Paste contexts).

dup_properties(template_props, as_load, copy_parentless, exact)

Parameters:

• template_props ([Gladeui.Property]) – the Gladeui.Property list to copy

• as_load (bool) – whether to behave as if loading the project

• copy_parentless (bool) – whether to copy reffed widgets at all

• exact (bool) – whether to copy reffed widgets exactly

Returns:

A newly allocated GLib.List of new Gladeui.Property objects.

Return type:

[Gladeui.Property]

Copies a list of properties, if as_load is specified, then properties that are not saved to the glade file are ignored.

ensure_name(project, use_command)

Parameters:

• project (Gladeui.Project) –

• use_command (bool) –

event(event)

Parameters:

event (Gdk.Event) – A Gdk.Event

Returns:

whether the event was handled or not.

Return type:

bool

Feed an event to be handled on the project Gladeui.Widget hierarchy.

find_child(name)

Parameters:

name (str) – child name

Returns:

The child of widget or None if it was not found.

Return type:

Gladeui.Widget or None

Finds a child widget named name.

generate_path_name()

Returns:

A newly allocated string

Return type:

str

Creates a user friendly name to describe project widgets

get_action(action_path)

Parameters:

action_path (str) – a full action path including groups

Returns:

the action or None if not found.

Return type:

Gladeui.WidgetAction or None

Returns a Gladeui.WidgetAction object indentified by action_path.

get_actions()

Returns:

the list of Gladeui.WidgetAction

Return type:

[Gladeui.WidgetAction]

get_adaptor()

Returns:

the Gladeui.WidgetAdaptor of self

Return type:

Gladeui.WidgetAdaptor

get_children()

Returns:

The children of widget

This differs from a direct call to Gladeui.WidgetAdaptor.get_children() as it only returns children which have an associated Gladeui.Widget. This function will not return any placeholders or internal composite children that have not been exposed for Glade configuration

Return type:

[GObject.Object]

Fetches any wrapped children of self.

get_display_name()

Returns:

a pointer to self's displayable name

This should be used to display the widget’s ID in the UI, it will automatically return the class name if the widget has no name.

Return type:

str

get_internal()

Returns:

the internal name of self

Return type:

str

get_is_composite()

Returns:

whether self is composite.

Return type:

bool

Checks if self is a composite template to be used with Gtk.WidgetClass.set_template().

get_locker()

Returns:

a Gladeui.Widget or None if none is locked

Return type:

Gladeui.Widget or None

Get the current locked widget, locked widgets cannot be removed from the project until unlocked

get_name()

Returns:

a pointer to self's name

This is what will be serialized as the widget’s ID, unless the name currently carries the Gladeui.UNNAMED_PREFIX.

Return type:

str

get_object()

Returns:

the GObject.Object associated with self

Return type:

GObject.Object

get_pack_action(action_path)

Parameters:

action_path (str) – a full action path including groups

Returns:

the action or None if not found.

Return type:

Gladeui.WidgetAction or None

Returns a Gladeui.WidgetAction object indentified by action_path.

get_pack_actions()

Returns:

the list of Gladeui.WidgetAction

Return type:

[Gladeui.WidgetAction]

get_pack_property(id_property)

Parameters:

id_property (str) – a string naming a Gladeui.Property

Returns:

the Gladeui.Property in self named id_property

Return type:

Gladeui.Property or None

get_packing_properties()

Returns:

the list of Gladeui.Property

Return type:

[Gladeui.Property]

get_parent()

Returns:

The parenting Gladeui.Widget

Return type:

Gladeui.Widget

get_parentless_reffed_widgets()

Returns:

a list of Gladeui.Property

Return type:

[Gladeui.Property]

get_parentless_widget_ref()

Returns:

a Gladeui.Property

Return type:

Gladeui.Property

get_project()

Returns:

the Gladeui.Project that self belongs to

Return type:

Gladeui.Project

get_properties()

Returns:

the list of Gladeui.Property

Return type:

[Gladeui.Property]

get_property(id_property)

Parameters:

id_property (str) – a string naming a Gladeui.Property

Returns:

the Gladeui.Property in self named id_property

Return type:

Gladeui.Property or None

get_signal_list()

Returns:

a newly allocated GLib.List of Gladeui.Signal, the caller must call g_list_free() to free the list.

Return type:

[Gladeui.Signal]

Compiles a list of Gladeui.Signal elements

get_signal_model()

Returns:

a Gtk.TreeModel that can be used to view the widget’s signals. The signal model is owned by the Gladeui.Widget.

Return type:

Gtk.TreeModel

get_toplevel()

Returns:

The toplevel Gladeui.Widget in the hierarchy (or self)

Return type:

Gladeui.Widget

has_decendant(type)

Parameters:

type (GObject.GType) – a GObject.GType

Returns:

whether this Gladeui.Widget has any descendants of type type or any descendants that implement the type interface

Return type:

bool

has_name()

Returns:

whether the user has named this widget with an ID

Return type:

bool

has_prop_refs()

Return type:

bool

hide()

Hide self

in_project()

Return type:

bool

is_ancestor(ancestor)

Parameters:

ancestor (Gladeui.Widget) – another Gladeui.Widget

Returns:

True if ancestor contains self as a child, grandchild, great grandchild, etc.

Return type:

bool

Determines whether self is somewhere inside ancestor, possibly with intermediate containers.

list_locked_widgets()

Returns:

the list of Gladeui.Widget

Return type:

[Gladeui.Widget]

list_prop_refs()

Returns:

a list of Gladeui.Property

Return type:

[Gladeui.Property]

list_signal_handlers(signal_name)

Parameters:

signal_name (str) – the name of the signal

Returns:

A GLib.PtrArray of Gladeui.Signal for signal_name

Return type:

[Gladeui.Signal]

lock(locked)

Parameters:

locked (Gladeui.Widget) – The Gladeui.Widget to lock

Sets locked to be in a locked up state spoken for by self, locked widgets cannot be removed from the project until unlocked.

object_get_property(property_name, value)

Parameters:

• property_name (str) – The property identifier

• value (GObject.Value) – The GObject.Value

This function retrieves the value of the property property_name on the runtime object of self and sets it in value.

object_set_property(property_name, value)

Parameters:

• property_name (str) – The property identifier

• value (GObject.Value) – The GObject.Value

This function applies value to the property property_name on the runtime object of self.

pack_property_default(id_property)

Parameters:

id_property (str) – a string naming a Gladeui.Property

Returns:

whether whether id_property was found and is currently set to it’s default value.

Return type:

bool

pack_property_reset(id_property)

Parameters:

id_property (str) – a string naming a Gladeui.Property

Returns:

whether id_property was found or not.

Return type:

bool

Resets id_property in self's packing properties to it’s default value

pack_property_set_enabled(id_property, enabled)

Parameters:

• id_property (str) – a string naming a Gladeui.Property

• enabled (bool) – setting enabled or disabled

Returns:

whether id_property was found or not.

Return type:

bool

Sets the enabled state of id_property in self's packing properties; this is used for optional properties.

pack_property_set_save_always(id_property, setting)

Parameters:

• id_property (str) – a string naming a Gladeui.Property

• setting (bool) – the setting

Returns:

whether id_property was found or not.

Return type:

bool

Sets whether id_property in self should be special cased to always be saved regardless of its default value. (used for some special cases like properties that are assigned initial values in composite widgets or derived widget code).

pack_property_set_sensitive(id_property, sensitive, reason)

Parameters:

• id_property (str) – a string naming a Gladeui.Property

• sensitive (bool) – setting sensitive or insensitive

• reason (str) – a description of why the user cant edit this property which will be used as a tooltip

Returns:

whether id_property was found or not.

Return type:

bool

Sets the sensitivity of id_property in self's packing properties.

pack_property_string(id_property, value)

Parameters:

• id_property (str) – a string naming a Gladeui.Property

• value (GObject.Value) – the GObject.Value to print or None

Returns:

A newly allocated string representing id_property

Return type:

str

Same as Gladeui.Widget.property_string() but for packing properties.

placeholder_relation(widget)

Parameters:

widget (Gladeui.Widget) – The child Gladeui.Widget

Returns:

whether to use placeholders for this relationship.

Return type:

bool

Returns whether placeholders should be used in operations concerning this parent & child.

Currently that criteria is whether self is a Gtk.Container, widget is a Gtk.Widget and the parent adaptor has been marked to use placeholders.

property_default(id_property)

Parameters:

id_property (str) – a string naming a Gladeui.Property

Returns:

whether whether id_property was found and is currently set to it’s default value.

Return type:

bool

property_original_default(id_property)

Parameters:

id_property (str) – a string naming a Gladeui.Property

Returns:

whether whether id_property was found and is currently set to it’s original default value.

Return type:

bool

property_reset(id_property)

Parameters:

id_property (str) – a string naming a Gladeui.Property

Returns:

whether id_property was found or not.

Return type:

bool

Resets id_property in self to it’s default value

property_set_enabled(id_property, enabled)

Parameters:

• id_property (str) – a string naming a Gladeui.Property

• enabled (bool) – setting enabled or disabled

Returns:

whether id_property was found or not.

Return type:

bool

Sets the enabled state of id_property in self; this is used for optional properties.

property_set_save_always(id_property, setting)

Parameters:

• id_property (str) – a string naming a Gladeui.Property

• setting (bool) – the setting

Returns:

whether id_property was found or not.

Return type:

bool

Sets whether id_property in self should be special cased to always be saved regardless of its default value. (used for some special cases like properties that are assigned initial values in composite widgets or derived widget code).

property_set_sensitive(id_property, sensitive, reason)

Parameters:

• id_property (str) – a string naming a Gladeui.Property

• sensitive (bool) – setting sensitive or insensitive

• reason (str) – a description of why the user cant edit this property which will be used as a tooltip

Returns:

whether id_property was found or not.

Return type:

bool

Sets the sensitivity of id_property in self

property_string(id_property, value)

Parameters:

• id_property (str) – a string naming a Gladeui.Property

• value (GObject.Value) – the GObject.Value to print or None

Returns:

A newly allocated string representing id_property

Return type:

str

Creates a printable string representing id_property in self, if value is specified it will be used in place of id_property's real value (this is a convenience function to print/debug properties usually from plugin backends).

read_child(node)

Parameters:

node (Gladeui.XmlNode) – a Gladeui.XmlNode

Reads in a child widget from the xml (handles ‘child’ tag)

rebuild()

Replaces the current widget instance with a new one while preserving all properties children and takes care of reparenting.

remove_child(child)

Parameters:

child (Gladeui.Widget) – the Gladeui.Widget to add

Removes child from self in a generic way for this Gladeui.Widget parent.

remove_prop_ref(property)

Parameters:

property (Gladeui.Property) – the Gladeui.Property

Removes property from self ‘s list of referenced properties.

Note: this is used to track properties on other objects that refer to this object.

remove_property(id_property)

Parameters:

id_property (str) – the name of the property

Removes the Gladeui.Property indicated by id_property from self (this is intended for use in the plugin, to remove properties from composite children that don’t make sense to allow the user to specify, notably - properties that are proxied through the composite widget’s properties or style properties).

remove_signal_handler(signal_handler)

Parameters:

signal_handler (Gladeui.Signal) – The Gladeui.Signal

Removes a signal handler from self

replace(old_object, new_object)

Parameters:

• old_object (GObject.Object) – a GObject.Object

• new_object (GObject.Object) – a GObject.Object

Replaces a GObject.Object with another GObject.Object inside a Gladeui.Widget which behaves as a container.

Note that both GObjects must be owned by a Gladeui.Widget.

set_action_sensitive(action_path, sensitive)

Parameters:

• action_path (str) – a full action path including groups

• sensitive (bool) – setting sensitive or insensitive

Returns:

whether action_path was found or not.

Return type:

bool

Sets the sensitivity of action_path in self

set_action_visible(action_path, visible)

Parameters:

• action_path (str) – a full action path including groups

• visible (bool) – setting visible or invisible

Returns:

whether action_path was found or not.

Return type:

bool

Sets the visibility of action_path in self

set_child_type_from_node(child, node)

Parameters:

• child (GObject.Object) –

• node (Gladeui.XmlNode) –

set_in_project(in_project)

Parameters:

in_project (bool) –

set_internal(internal)

Parameters:

internal (str) – The internal name

Sets the internal name of self to internal

set_is_composite(composite)

Parameters:

composite (bool) – whether self should be a composite template

Set’s this widget to be toplevel composite object to be eventually used with Gtk.WidgetClass.set_template()

Only one widget in a project should be composite.

set_name(name)

Parameters:

name (str) – a string

Sets self's name to name.

set_pack_action_sensitive(action_path, sensitive)

Parameters:

• action_path (str) – a full action path including groups

• sensitive (bool) – setting sensitive or insensitive

Returns:

whether action_path was found or not.

Return type:

bool

Sets the sensitivity of action_path in self

set_pack_action_visible(action_path, visible)

Parameters:

• action_path (str) – a full action path including groups

• visible (bool) – setting visible or invisible

Returns:

whether action_path was found or not.

Return type:

bool

Sets the visibility of action_path in self

set_packing_properties(container)

Parameters:

container (Gladeui.Widget) – The parent Gladeui.Widget

Generates the packing_properties list of the widget, given the class of the container we are adding the widget to. If the widget already has packing_properties, but the container has changed, the current list is freed and replaced.

set_parent(parent)

Parameters:

parent (Gladeui.Widget or None) – the parenting Gladeui.Widget (or None)

sets the parenting Gladeui.Widget

set_project(project)

Parameters:

project (Gladeui.Project) – a Gladeui.Project

Makes self belong to project.

set_support_warning(warning)

Parameters:

warning (str) –

show()

xlib.Display self in it’s project’s Gladeui.DesignView

support_changed()

Notifies that support metadata has changed on the widget.

support_warning()

Return type:

str

unlock()

Unlocks self so that it can be removed from the project again

verify()

Verify this widget for deprecation and versioning warnings.

This function will update the widget’s support warning.

write(context, node)

Parameters:

• context (Gladeui.XmlContext) – A Gladeui.XmlContext

• node (Gladeui.XmlNode) – A Gladeui.XmlNode

Recursively writes out self and its children and appends the created Gladeui.XmlNode to node.

write_child(child, context, node)

Parameters:

• child (Gladeui.Widget) – The child Gladeui.Widget to write

• context (Gladeui.XmlContext) – A Gladeui.XmlContext

• node (Gladeui.XmlNode) – A Gladeui.XmlNode

Writes out a widget to the xml, takes care of packing properties and special child types.

write_placeholder(object, context, node)

Parameters:

• object (GObject.Object) – A Gladeui.Placeholder

• context (Gladeui.XmlContext) – A Gladeui.XmlContext

• node (Gladeui.XmlNode) – A Gladeui.XmlNode

Writes out a placeholder to the xml

write_signals(context, node)

Parameters:

• context (Gladeui.XmlContext) –

• node (Gladeui.XmlNode) –

write_special_child_prop(object, context, node)

Parameters:

• object (GObject.Object) –

• context (Gladeui.XmlContext) –

• node (Gladeui.XmlNode) –

do_add_child(child, at_mouse) virtual

Parameters:

• child (Gladeui.Widget) – the Gladeui.Widget to add

• at_mouse (bool) – whether the added widget should be added at the current mouse position

Adds child to parent in a generic way for this Gladeui.Widget parent.

do_add_signal_handler(signal_handler) virtual

Parameters:

signal_handler (Gladeui.Signal) – The Gladeui.Signal

Adds a signal handler for widget

do_button_press_event(event) virtual

Parameters:

event (Gdk.Event) –

Return type:

int

do_button_release_event(event) virtual

Parameters:

event (Gdk.Event) –

Return type:

int

do_change_signal_handler(new_signal_handler) virtual

Parameters:

new_signal_handler (Gladeui.Signal) –

do_event(event) virtual

Parameters:

event (Gdk.Event) – A Gdk.Event

Returns:

whether the event was handled or not.

Return type:

bool

Feed an event to be handled on the project Gladeui.Widget hierarchy.

do_motion_notify_event(event) virtual

Parameters:

event (Gdk.Event) –

Return type:

int

do_remove_child(child) virtual

Parameters:

child (Gladeui.Widget) – the Gladeui.Widget to add

Removes child from parent in a generic way for this Gladeui.Widget parent.

do_remove_signal_handler(signal_handler) virtual

Parameters:

signal_handler (Gladeui.Signal) – The Gladeui.Signal

Removes a signal handler from widget

do_replace_child(old_object, new_object) virtual

Parameters:

• old_object (GObject.Object) –

• new_object (GObject.Object) –

Signal Details

Gladeui.Widget.signals.add_signal_handler(widget, arg1)

Signal Name:

add-signal-handler

Flags:

RUN_LAST

Parameters:

• widget (Gladeui.Widget) – The object which received the signal

• arg1 (Gladeui.Signal) – the Gladeui.Signal that was added to gladewidget.

Gladeui.Widget.signals.button_press_event(widget, arg1)

Signal Name:

button-press-event

Flags:

RUN_LAST

Parameters:

• widget (Gladeui.Widget) – The object which received the signal

• arg1 (Gdk.Event) – the Gdk.Event

Return type:

bool

Gladeui.Widget.signals.button_release_event(widget, arg1)

Signal Name:

button-release-event

Flags:

RUN_LAST

Parameters:

• widget (Gladeui.Widget) – The object which received the signal

• arg1 (Gdk.Event) – the Gdk.Event

Return type:

bool

Gladeui.Widget.signals.change_signal_handler(widget, arg1)

Signal Name:

change-signal-handler

Flags:

RUN_LAST

Parameters:

• widget (Gladeui.Widget) – The object which received the signal

• arg1 (Gladeui.Signal) – the Gladeui.Signal that changed

Gladeui.Widget.signals.motion_notify_event(widget, arg1)

Signal Name:

motion-notify-event

Flags:

RUN_LAST

Parameters:

• widget (Gladeui.Widget) – The object which received the signal

• arg1 (Gdk.Event) – the Gdk.Event

Return type:

bool

Gladeui.Widget.signals.remove_signal_handler(widget, arg1)

Signal Name:

remove-signal-handler

Flags:

RUN_LAST

Parameters:

• widget (Gladeui.Widget) – The object which received the signal

• arg1 (Gladeui.Signal) – the Gladeui.Signal that was removed from gladewidget.

Gladeui.Widget.signals.support_changed(widget)

Signal Name:

support-changed

Flags:

RUN_LAST

Parameters:

widget (Gladeui.Widget) – The object which received the signal

Emitted when property and signal support metadatas and messages have been updated.

Property Details

Gladeui.Widget.props.adaptor

Name:

adaptor

Type:

Gladeui.WidgetAdaptor

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The class adaptor for the associated widget

Gladeui.Widget.props.anarchist

Name:

anarchist

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Whether this composite child is an ancestral child or an anarchist child

Gladeui.Widget.props.composite

Name:

composite

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

Whether this widget is the template for a composite widget

Gladeui.Widget.props.internal

Name:

internal

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The internal name of the widget

Gladeui.Widget.props.internal_name

Name:

internal-name

Type:

str

Default Value:

None

Flags:

WRITABLE, CONSTRUCT_ONLY

A generic name prefix for internal widgets

Gladeui.Widget.props.name

Name:

name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The name of the widget

Gladeui.Widget.props.object

Name:

object

Type:

GObject.Object

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The object associated

Gladeui.Widget.props.parent

Name:

parent

Type:

Gladeui.Widget

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

A pointer to the parenting Gladeui.Widget

Gladeui.Widget.props.project

Name:

project

Type:

Gladeui.Project

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The glade project that this widget belongs to

Gladeui.Widget.props.properties

Name:

properties

Type:

int

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

A list of GladeProperties

Gladeui.Widget.props.reason

Name:

reason

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

A Gladeui.CreateReason for this creation

Gladeui.Widget.props.support_warning

Name:

support-warning

Type:

str

Default Value:

None

Flags:

READABLE

A warning string about version mismatches

Gladeui.Widget.props.template

Name:

template

Type:

Gladeui.Widget

Default Value:

None

Flags:

WRITABLE, CONSTRUCT_ONLY

A Gladeui.Widget template to base a new widget on

Gladeui.Widget.props.template_exact

Name:

template-exact

Type:

bool

Default Value:

False

Flags:

WRITABLE, CONSTRUCT_ONLY

Whether we are creating an exact duplicate when using a template

Gladeui.Widget.props.toplevel_height

Name:

toplevel-height

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

The height of the widget when toplevel in the GladeDesignLayout

Gladeui.Widget.props.toplevel_width

Name:

toplevel-width

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE

The width of the widget when toplevel in the GladeDesignLayout

Gladeui.Widget.props.visible

Name:

visible

Type:

bool

Default Value:

False

Flags:

READABLE

Whether the widget is visible or not