Package horizons :: Package gui :: Package tabs :: Module selectmultitab :: Class SelectMultiTab
[hide private]
[frames] | no frames]

Class SelectMultiTab

source code

tabinterface.TabInterface --+
                            |
                           SelectMultiTab

Tab shown when multiple units are selected

Instance Methods [hide private]
 
__init__(self, selected_instances=None) source code
 
init_widget(self)
Initialize widget after it was loaded.
source code
 
add_entry(self, entry) source code
 
draw_selected_units_widget(self) source code
 
hide_selected_units_widget(self) source code
 
schedule_unit_widget_refresh(self) source code
 
refresh_unit_widget(self) source code
 
on_instance_removed(self, instance) source code
 
show_stance_widget(self) source code
 
hide_stance_widget(self) source code
 
set_stance(self, stance) source code
 
toggle_stance(self)
Toggles the stance.
source code
    Inherited from tabinterface.TabInterface
 
_get_position(self) source code
 
_schedule_refresh(self)
Schedule a refresh soon, dropping all other refresh request, that appear until then.
source code
 
_set_position(self, value)
Sets the widgets position to tuple *value*
source code
 
_setup_widget(self)
Gets the widget and sets up some attributes and helper.
source code
 
ensure_loaded(self)
Called when a tab is shown, acts as hook for lazy loading
source code
 
get_widget(self)
Loads the filename in self.widget.
source code
 
hide(self)
Hides the current widget
source code
 
is_visible(self) source code
 
refresh(self)
This function is called by the TabWidget to redraw the widget.
source code
 
show(self)
Shows the current widget
source code
Class Methods [hide private]
    Inherited from tabinterface.TabInterface
 
shown_for(cls, instance)
Method for fine-grained control of which tabs to show.
source code
Class Variables [hide private]
  widget = 'overview_select_multi.xml'
hash(x)
  icon_path = 'icons/tabwidget/common/inventory'
  helptext = LazyT("Selected Units")
  max_row_entry_number = 3
  max_column_entry_number = 4
    Inherited from tabinterface.TabInterface
  lazy_loading = True
  position = property(_get_position, _set_position)
  scheduled_update_delay = 0.4
Method Details [hide private]

__init__(self, selected_instances=None)
(Constructor)

source code 
Parameters:
  • widget - filename of a widget. Set this to None if you create your widget in `get_widget`.
  • widget - Filename of widget to load.
  • icon_path - Where to look for ImageButton icons. Note: this is a `path` attribute!
Overrides: tabinterface.TabInterface.__init__
(inherited documentation)

init_widget(self)

source code 

Initialize widget after it was loaded.

Override this in your subclass if you have custom post-load code.

Overrides: tabinterface.TabInterface.init_widget
(inherited documentation)

toggle_stance(self)

source code 

Toggles the stance. Assumes at least one stance unit is selected.