RB.DisplayPage¶
Subclasses: | RB.DisplayPageGroup , RB.Source |
---|
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) |
activate () |
|
can_remove () |
|
delete_thyself () |
|
deselected () |
|
get_config_widget (prefs) |
|
get_status (text, busy) |
|
notify_status_changed () |
|
receive_drag (data) |
|
remove () |
|
selectable () |
|
selected () |
|
set_icon_name (icon_name) |
Virtual Methods¶
Inherited: | Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10) |
---|
do_activate () |
|
do_can_remove () |
|
do_delete_thyself () |
|
do_deleted () |
|
do_deselected () |
|
do_get_config_widget (prefs) |
|
do_get_status (text, busy) |
|
do_receive_drag (data) |
|
do_remove () |
|
do_selectable () |
|
do_selected () |
|
do_status_changed () |
Properties¶
Inherited: | Gtk.Box (3), Gtk.Container (3), Gtk.Widget (39), Gtk.Orientable (1) |
---|
Name | Type | Flags | Short Description |
---|---|---|---|
icon |
Gio.Icon |
r/w/c | Page icon |
plugin |
GObject.Object |
r/w/c | plugin instance that created the page |
selected |
bool |
r | Whether the page is currently selected |
shell |
RB.Shell |
r/w/co | RB.Shell object |
visibility |
bool |
r/w | Whether the page should be displayed in the tree |
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 |
---|---|
deleted |
Emitted when the page is being deleted. |
status-changed |
Emitted when the page’s status changes. |
Fields¶
Inherited: | Gtk.Container (4), Gtk.Widget (69), GObject.Object (1) |
---|
Name | Type | Access | Description |
---|---|---|---|
parent | Gtk.Box |
r |
Class Details¶
-
class
RB.
DisplayPage
(*args, **kwargs)¶ Bases: Gtk.Box
Abstract: Yes Structure: RB.DisplayPageClass
-
activate
()¶ Called when the page is activated (double clicked, etc.) in the page tree.
-
can_remove
()¶ Returns: True
if the page can be removedReturn type: bool
Called to check whether the user is able to remove the page
-
delete_thyself
()¶ This is called when the page should delete itself. The ‘deleted’ signal will be emitted, which removes the page from the page model. This will not actually dispose of the page object, so reference counting must still be handled correctly.
-
deselected
()¶ Called when the page is deselected in the page tree.
-
get_config_widget
(prefs)¶ Parameters: prefs ( RB.ShellPreferences
) – theRB.ShellPreferences
objectReturns: configuration widget Return type: Gtk.Widget
Source implementations can use this to return an optional configuration widget. The widget will be displayed in a page in the preferences dialog.
-
get_status
(text, busy)¶ Parameters: Returns: text: holds the returned status text busy: holds the busy status Return type: Retrieves status details for the page.
-
notify_status_changed
()¶ Page implementations call this when their status bar information changes.
-
receive_drag
(data)¶ Parameters: data ( Gtk.SelectionData
) –Return type: bool
-
remove
()¶ Called when the user requests removal of a page.
-
selected
()¶ Called when the page is selected in the page tree.
-
set_icon_name
(icon_name)¶ Parameters: icon_name ( str
) – icon name to useSets the icon for the page to the specified icon name.
-
do_activate
() virtual¶ Called when the page is activated (double clicked, etc.) in the page tree.
-
do_can_remove
() virtual¶ Returns: True
if the page can be removedReturn type: bool
Called to check whether the user is able to remove the page
-
do_delete_thyself
() virtual¶ This is called when the page should delete itself. The ‘deleted’ signal will be emitted, which removes the page from the page model. This will not actually dispose of the page object, so reference counting must still be handled correctly.
-
do_deleted
() virtual¶
-
do_deselected
() virtual¶ Called when the page is deselected in the page tree.
-
do_get_config_widget
(prefs) virtual¶ Parameters: prefs ( RB.ShellPreferences
) – theRB.ShellPreferences
objectReturns: configuration widget Return type: Gtk.Widget
Source implementations can use this to return an optional configuration widget. The widget will be displayed in a page in the preferences dialog.
-
do_get_status
(text, busy) virtual¶ Parameters: Returns: text: holds the returned status text busy: holds the busy status Return type: Retrieves status details for the page.
-
do_receive_drag
(data) virtual¶ Parameters: data ( Gtk.SelectionData
) –Return type: bool
-
do_remove
() virtual¶ Called when the user requests removal of a page.
-
do_selected
() virtual¶ Called when the page is selected in the page tree.
-
do_status_changed
() virtual¶
-
Signal Details¶
-
RB.DisplayPage.signals.
deleted
(display_page)¶ Signal Name: deleted
Flags: RUN_LAST
Parameters: display_page ( RB.DisplayPage
) – The object which received the signalEmitted when the page is being deleted.
-
RB.DisplayPage.signals.
status_changed
(display_page)¶ Signal Name: status-changed
Flags: RUN_LAST
Parameters: display_page ( RB.DisplayPage
) – The object which received the signalEmitted when the page’s status changes.
Property Details¶
-
RB.DisplayPage.props.
icon
¶ Name: icon
Type: Gio.Icon
Default Value: None
Flags: READABLE
,WRITABLE
,CONSTRUCT
Icon to display in the page tree
-
RB.DisplayPage.props.
plugin
¶ Name: plugin
Type: GObject.Object
Default Value: None
Flags: READABLE
,WRITABLE
,CONSTRUCT
The plugin that created this page.
-
RB.DisplayPage.props.
selected
¶ Name: selected
Type: bool
Default Value: False
Flags: READABLE
True
when the page is selected in the page tree.