Gladeui.BaseEditor¶

Subclasses:: None

Methods¶

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

	`add_default_properties` (gchild)
	`add_editable` (gchild, page)
	`add_label` (str)
	`pack_new_window` (title, help_markup)
	`set_show_signal_editor` (val)

Virtual Methods¶

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

	`do_change_type` (gchild, type)
	`do_child_selected` (gchild)
	`do_delete_child` (parent, gchild)
	`do_get_display_name` (gchild)
	`do_move_child` (gparent, gchild)

Properties¶

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

Name	Type	Flags	Short Description
`container`	`GObject.Object`	r/w	The container object this editor is currently editing

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
`build-child`	Create a child widget here if something else must be done other than calling `Gladeui.Command.create`() such as creating an intermediate parent.
`change-type`
`child-selected`	Emitted when the user selects a child in the editor’s treeview.
`delete-child`
`get-display-name`
`move-child`	Move child here if something else must be done other than cut & paste.

Fields¶

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

Name	Type	Access	Description
parent_instance	`Gtk.Box`	r

Class Details¶

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

Bases:: Gtk.Box
Abstract:: No
Structure:: Gladeui.BaseEditorClass

add_default_properties(gchild)¶

Parameters:: gchild (Gladeui.Widget) – a Gladeui.Widget

Add gchild name and type property to self

NOTE: This function is intended to be used in “child-selected” callbacks

add_editable(gchild, page)¶

Parameters:

gchild (Gladeui.Widget) – the Gladeui.Widget
page (Gladeui.EditorPageType) – the Gladeui.EditorPageType of the desired page for gchild

Add gchild editor of type page to the base editor

NOTE: This function is intended to be used in “child-selected” callbacks

add_label(str)¶

Parameters:: str (str) – the label string

Adds a new label to self

NOTE: This function is intended to be used in “child-selected” callbacks

pack_new_window(title, help_markup)¶

Parameters:

title (str) – the window title
help_markup (str) – the help text

Returns:

the newly created window

Return type:

Gtk.Widget

This convenience function create a new dialog window and packs self in it.

set_show_signal_editor(val)¶

Parameters:: val (bool) – whether to show the signal editor

Shows/hide self ‘s signal editor

do_change_type(gchild, type) virtual¶

Parameters:

gchild (Gladeui.Widget) –
type (GObject.GType) –

Return type:

bool

do_child_selected(gchild) virtual¶

Parameters:: gchild (Gladeui.Widget) –

do_delete_child(parent, gchild) virtual¶

Parameters:

parent (Gladeui.Widget) –
gchild (Gladeui.Widget) –

Return type:

bool

do_get_display_name(gchild) virtual¶

Parameters:: gchild (Gladeui.Widget) –
Return type:: str

do_move_child(gparent, gchild) virtual¶

Parameters:

gparent (Gladeui.Widget) –
gchild (Gladeui.Widget) –

Return type:

bool

Signal Details¶

Gladeui.BaseEditor.signals.build_child(base_editor, gparent, type)¶

Signal Name:

build-child

Flags:

RUN_LAST

Parameters:

base_editor (Gladeui.BaseEditor) – The object which received the signal
gparent (GObject.Object) – the parent of the new child
type (GObject.GType) – the GObject.GType of the child

Returns:

the newly created Gladeui.Widget or None if child cant be created

Return type:

GObject.Object or None

Create a child widget here if something else must be done other than calling Gladeui.Command.create() such as creating an intermediate parent.

Gladeui.BaseEditor.signals.change_type(base_editor, object, p0)¶

Signal Name:

change-type

Flags:

RUN_LAST

Parameters:

base_editor (Gladeui.BaseEditor) – The object which received the signal
object (GObject.Object) –
p0 (GObject.GType) –

Return type:

bool

Gladeui.BaseEditor.signals.child_selected(base_editor, gchild)¶

Signal Name:

child-selected

Flags:

RUN_LAST

Parameters:

base_editor (Gladeui.BaseEditor) – The object which received the signal
gchild (GObject.Object) – the selected Gladeui.Widget.

Emitted when the user selects a child in the editor’s treeview. You can add the relevant child properties here using Gladeui.BaseEditor.add_default_properties() and glade_base_editor_add_properties() You can also add labels with Gladeui.BaseEditor.add_label to make the editor look pretty.

Gladeui.BaseEditor.signals.delete_child(base_editor, gparent, gchild)¶

Signal Name:

delete-child

Flags:

RUN_LAST

Parameters:

base_editor (Gladeui.BaseEditor) – The object which received the signal
gparent (GObject.Object) – the parent
gchild (GObject.Object) – the child to delete

Return type:

bool

Gladeui.BaseEditor.signals.get_display_name(base_editor, gchild)¶

Signal Name:

get-display-name

Flags:

RUN_LAST

Parameters:

base_editor (Gladeui.BaseEditor) – The object which received the signal
gchild (GObject.Object) – the child to get display name string to show in gladebaseeditor treeview.

Returns:

a newly allocated string.

Return type:

str

Gladeui.BaseEditor.signals.move_child(base_editor, gparent, gchild)¶

Signal Name:

move-child

Flags:

RUN_LAST

Parameters:

base_editor (Gladeui.BaseEditor) – The object which received the signal
gparent (GObject.Object) – the new parent of gchild
gchild (GObject.Object) – the Gladeui.Widget to move

Returns:

whether child has been successfully moved or not.

Return type:

bool

Move child here if something else must be done other than cut & paste.

Property Details¶

Gladeui.BaseEditor.props.container¶

Name:: container
Type:: GObject.Object
Default Value:: None
Flags:: READABLE, WRITABLE

The container object this editor is currently editing