comparison src/browser/sat_browser/base_widget.py @ 617:5baca9d46c34 frontends_multi_profiles

browser_side: add/improve some docstrings
author souliane <souliane@mailoo.org>
date Wed, 11 Feb 2015 11:21:27 +0100
parents 5b19fb5eae7e
children 698bdb84f6a7 c2abadf31afb
comparison
equal deleted inserted replaced
616:1c0d5a87c554 617:5baca9d46c34
208 class WidgetMenuBar(base_menu.GenericMenuBar): 208 class WidgetMenuBar(base_menu.GenericMenuBar):
209 209
210 ITEM_TPL = "<img src='media/icons/misc/%s.png' />" 210 ITEM_TPL = "<img src='media/icons/misc/%s.png' />"
211 211
212 def __init__(self, parent, host, vertical=False, styles=None): 212 def __init__(self, parent, host, vertical=False, styles=None):
213 """
214
215 @param parent (Widget): LiberviaWidget, or instance of another class
216 implementing the method addMenus
217 @param host (SatWebFrontend)
218 @param vertical (bool): if True, set the menu vertically
219 @param styles (dict): optional styles dict
220 """
213 menu_styles = {'menu_bar': 'widgetHeader_buttonGroup'} 221 menu_styles = {'menu_bar': 'widgetHeader_buttonGroup'}
214 if styles: 222 if styles:
215 menu_styles.update(styles) 223 menu_styles.update(styles)
216 base_menu.GenericMenuBar.__init__(self, host, vertical=vertical, styles=menu_styles) 224 base_menu.GenericMenuBar.__init__(self, host, vertical=vertical, styles=menu_styles)
217 225
228 236
229 237
230 class WidgetSubMenuBar(base_menu.GenericMenuBar): 238 class WidgetSubMenuBar(base_menu.GenericMenuBar):
231 239
232 def __init__(self, host, vertical=True): 240 def __init__(self, host, vertical=True):
241 """
242
243 @param host (SatWebFrontend)
244 @param vertical (bool): if True, set the menu vertically
245 """
233 base_menu.GenericMenuBar.__init__(self, host, vertical=vertical, flat_level=1) 246 base_menu.GenericMenuBar.__init__(self, host, vertical=vertical, flat_level=1)
234 247
235 @classmethod 248 @classmethod
236 def getCategoryHTML(cls, menu_name_i18n, type_): 249 def getCategoryHTML(cls, menu_name_i18n, type_):
237 return menu_name_i18n 250 return menu_name_i18n
800 self.setStyleName('liberviaTabPanel') 813 self.setStyleName('liberviaTabPanel')
801 self.addStyleName('mainTabPanel') 814 self.addStyleName('mainTabPanel')
802 Window.addWindowResizeListener(self) 815 Window.addWindowResizeListener(self)
803 816
804 def getCurrentPanel(self): 817 def getCurrentPanel(self):
805 """ Get the panel of the currently selected tab """ 818 """ Get the panel of the currently selected tab
819
820 @return: WidgetsPanel
821 """
806 return self.deck.visibleWidget 822 return self.deck.visibleWidget
807 823
808 def onWindowResized(self, width, height): 824 def onWindowResized(self, width, height):
809 tab_panel_elt = self.getElement() 825 tab_panel_elt = self.getElement()
810 _elts = doc().getElementsByClassName('gwt-TabBar') 826 _elts = doc().getElementsByClassName('gwt-TabBar')