zim.plugins.pathbar.ScrolledHBox

class documentation

class ScrolledHBox(Gtk.HBox): (source)

Known subclasses: zim.plugins.pathbar.PathBar

View In Hierarchy

This class provides a widget that behaves like a HBox when there is enough space to render all child widgets. When space is limited it shows arrow buttons on the left and on the right to allow scrolling through the widgets.

Note that this class does not support packing options like 'expand', 'fill' etc. All child widgets can just be added with 'add()'.

Method __del__ Undocumented
Method __init__ Undocumented
Method add Undocumented
Method do_get_preferred_height Undocumented
Method do_get_preferred_width Undocumented
Method do_size_allocate Undocumented
Method get_scrolled_children Undocumented
Method get_visible_children Undocumented
Method pack_end Undocumented
Method pack_start Undocumented
Method remove Undocumented
Method scroll Scroll n items in either direction. Direction should be either DIR_FORWARD or DIR_BACKWARD, while n should be integer. Returns boolean for success.
Method scroll_to_child Undocumented
Method start_scrolling Start continues scrolling. Direction should be either DIR_FORWARD or DIR_BACKWARD. If we were scrolling already, stops this action before setting new scroll direction.
Method stop_scrolling Stop continues scrolling. Does not do anything if we were not scrolling.
Class Variable __gsignals__ Undocumented
Class Variable initial_scroll_timeout Undocumented
Class Variable scroll_timeout Undocumented
Method _distribute_size Undocumented
Method _on_button_clicked Undocumented
Method _on_button_press Undocumented
Method _on_button_release Undocumented
Instance Variable _anchor Undocumented
Instance Variable _back_button Undocumented
Instance Variable _forw_button Undocumented
Instance Variable _minwidth Undocumented
Instance Variable _scroll_timeout Undocumented
Instance Variable _state Undocumented
def __del__(self): (source)

Undocumented

def __init__(self): (source)
overridden in zim.plugins.pathbar.PathBar

Undocumented

def add(self, child): (source)

Undocumented

def do_get_preferred_height(self): (source)

Undocumented

def do_get_preferred_width(self): (source)

Undocumented

def do_size_allocate(self, allocation): (source)

Undocumented

def get_scrolled_children(self): (source)

Undocumented

def get_visible_children(self): (source)

Undocumented

def pack_end(*a): (source)

Undocumented

def pack_start(*a): (source)

Undocumented

def remove(self, child): (source)

Undocumented

def scroll(self, direction, n=1): (source)
Scroll n items in either direction. Direction should be either DIR_FORWARD or DIR_BACKWARD, while n should be integer. Returns boolean for success.
def scroll_to_child(self, child): (source)

Undocumented

def start_scrolling(self, direction, initial_timeout=False): (source)
Start continues scrolling. Direction should be either DIR_FORWARD or DIR_BACKWARD. If we were scrolling already, stops this action before setting new scroll direction.
def stop_scrolling(self): (source)
Stop continues scrolling. Does not do anything if we were not scrolling.
__gsignals__: dict[str, str] = (source)

Undocumented

initial_scroll_timeout: int = (source)

Undocumented

scroll_timeout: int = (source)

Undocumented

def _distribute_size(self, available, widths, first, last): (source)

Undocumented

def _on_button_clicked(self, button): (source)

Undocumented

def _on_button_press(self, button, event): (source)

Undocumented

def _on_button_release(self, button, event): (source)

Undocumented

_anchor = (source)

Undocumented

_back_button = (source)

Undocumented

_forw_button = (source)

Undocumented

_minwidth = (source)

Undocumented

_scroll_timeout = (source)

Undocumented

_state = (source)

Undocumented