GOffice.Editor

Fields

None

Methods

class new ()
  add_page (widget, label)
  free ()
  get_notebook ()
  get_page (name)
  get_registered_widget (name)
  register_widget (widget)
  set_store_page (store_page)
  set_use_scrolled_window (use_scrolled)

Details

class GOffice.Editor

Embeds a notebook containing all the pages added to the editor.

classmethod new()
Returns:a new GOffice.Editor object, which is used to store a collection of property edition widgets (pages). The returned object must be freed using go_editor_free.
Return type:GOffice.Editor
add_page(widget, label)
Parameters:
  • widget (object or None) – property edition widget
  • label (str) – a label identifying the widget

Adds a page to self.

free()

Frees a GOffice.Editor object.

get_notebook()
Returns:a Gtk.Notebook from the widget collection stored in self.
Return type:Gtk.Widget
get_page(name)
Parameters:name (str) – page name
Returns:the page with name as name if any
Return type:Gtk.Widget
get_registered_widget(name)
Parameters:name (str) – the name of the registered widget
Returns:a widget previously registered using go_editor_register_widget.
Return type:Gtk.Widget
register_widget(widget)
Parameters:widget (Gtk.Widget) – a Gtk.Widget

Registers a widget that then can be retrieved later using go_editor_get_registered_widget. The main use of this function is to provide the ability to extend a page.

set_store_page(store_page)
Parameters:store_page (int) – placeholder for the last selected page

Sets a placeholder for storing the last active editor page.

set_use_scrolled_window(use_scrolled)
Parameters:use_scrolled (bool) – boolean

Sets whether each page of the editor should be displayed inside a scrolled window.