zim.gui.insertedobjects.InsertedObjectWidget

class documentation

class InsertedObjectWidget(Gtk.EventBox): (source)

Known subclasses: zim.gui.insertedobjects.ImageFileWidget, zim.gui.insertedobjects.TextViewWidget, zim.gui.pageview.LineSeparator, zim.plugins.tableeditor.TableViewWidget

View In Hierarchy

Base class & contained for custom object widget

We derive from a Gtk.EventBox because we want to re-set the default cursor for the area of the object widget. For this the widget needs it's own window for drawing.

Unknown Field: signal
link-clicked (link): To be emitted when the user clicks a link
link-enter (link): To be emitted when the mouse pointer enters a link
link-leave (link): To be emitted when the mouse pointer leaves a link
grab-cursor (position): emitted when embedded widget should grab focus, position can be either POSITION_BEGIN or POSITION_END
release-cursor (position): emitted when the embedded widget wants to give back focus to the embedding TextView
Method __init__ Undocumented
Method add Add a widget to the object
Method add_header Add an header widget on top of the object
Method do_button_press_event Undocumented
Method do_button_release_event Undocumented
Method do_popup_menu Undocumented
Method do_realize Undocumented
Method edit_object Undocumented
Method grab_cursor Emits the grab-cursor signal
Method has_cursor No summary
Method populate_popup Undocumented
Method release_cursor Emits the release-cursor signal
Method remove Undocumented
Method set_has_cursor See has_cursor()
Method set_textview_wrap_width Undocumented
Class Variable __gsignals__ Undocumented
Class Variable expand Undocumented
Method _do_popup_menu Undocumented
Instance Variable _has_cursor Undocumented
Instance Variable _vbox Undocumented
def __init__(self, widget_style=None): (source)
overridden in zim.gui.insertedobjects.ImageFileWidget, zim.gui.insertedobjects.TextViewWidget, zim.gui.pageview.LineSeparator, zim.plugins.tableeditor.TableViewWidget

Undocumented

def add(self, widget): (source)
Add a widget to the object
def add_header(self, widget): (source)
Add an header widget on top of the object
def do_button_press_event(self, event): (source)

Undocumented

def do_button_release_event(self, event): (source)

Undocumented

def do_popup_menu(self): (source)

Undocumented

def do_realize(self): (source)

Undocumented

def edit_object(self): (source)
overridden in zim.plugins.base.imagegenerator.ImageGeneratorWidget

Undocumented

def grab_cursor(self, position): (source)
Emits the grab-cursor signal
def has_cursor(self): (source)
Returns True if this object has an internal cursor. Will be used by the TextView to determine if the cursor should go "into" the object or just jump from the position before to the position after the object. If True the embedded widget is expected to support grab_cursor() and use release_cursor().
def populate_popup(self, menu): (source)
overridden in zim.plugins.base.imagegenerator.ImageGeneratorWidget

Undocumented

def release_cursor(self, position): (source)
Emits the release-cursor signal
def remove(self, widget): (source)

Undocumented

def set_has_cursor(self, has_cursor): (source)
See has_cursor()
def set_textview_wrap_width(self, width): (source)

Undocumented

__gsignals__ = (source)

Undocumented

expand: bool = (source)
overridden in zim.gui.insertedobjects.ImageFileWidget, zim.plugins.tableeditor.TableViewWidget

Undocumented

def _do_popup_menu(self, event): (source)

Undocumented

_has_cursor = (source)
overridden in zim.plugins.tableeditor.TableViewWidget

Undocumented

_vbox = (source)

Undocumented