Ignore:
Timestamp:
02/19/13 15:01:43 (14 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Added rst documentation for the canvas gui package.

Fixing docstrings in the process.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/gui/toolbox.py

    r11365 r11366  
    11""" 
    22============== 
    3 ToolBox Widget 
     3Tool Box Widget 
    44============== 
    55 
    6 A reimplementation of the QToolBox widget but with all the tabs 
    7 in a single QScrollArea and support for multiple open tabs. 
     6A reimplementation of the :class:`QToolBox` widget that keeps all the tabs 
     7in a single :class:`QScrollArea` instance and can keep multiple open tabs. 
    88 
    99""" 
     
    4040 
    4141def create_tab_gradient(base_color): 
    42     """Create a default background gradient for a tab button from a single 
     42    """ 
     43    Create a default background gradient for a tab button from a single 
    4344    color. 
    4445 
     
    5556 
    5657class ToolBoxTabButton(QToolButton): 
    57     """A tab button for an item in a ToolBox. 
     58    """ 
     59    A tab button for an item in a :class:`ToolBox`. 
    5860    """ 
    5961 
    6062    def setNativeStyling(self, state): 
    61         """Render tab buttons as native QToolButtons. 
     63        """ 
     64        Render tab buttons as native :class:`QToolButtons`. 
     65        If set to `False` (default) the button is pained using a 
     66        custom routine. 
     67 
    6268        """ 
    6369        self.__nativeStyling = state 
     
    6571 
    6672    def nativeStyling(self): 
    67         """Use native QStyle's QToolButton look. 
     73        """ 
     74        Use :class:`QStyle`'s to paint the class:`QToolButton` look. 
    6875        """ 
    6976        return self.__nativeStyling 
     
    210217 
    211218class ToolBox(QFrame): 
    212     """A tool box widget. 
    213     """ 
     219    """ 
     220    A tool box widget. 
     221    """ 
     222    # Emitted when a tab is toggled. 
    214223    tabToogled = Signal(int, bool) 
    215224 
    216225    def setExclusive(self, exclusive): 
    217         """Set exclusive tabs (only one tab can be open at a time). 
     226        """ 
     227        Set exclusive tabs (only one tab can be open at a time). 
    218228        """ 
    219229        if self.__exclusive != exclusive: 
     
    222232 
    223233    def exclusive(self): 
     234        """ 
     235        Are the tabs in the toolbox exclusive. 
     236        """ 
    224237        return self.__exclusive 
    225238 
    226239    exclusive_ = Property(bool, 
    227                          fget=exclusive, 
    228                          fset=setExclusive, 
    229                          designable=True) 
     240                          fget=exclusive, 
     241                          fset=setExclusive, 
     242                          designable=True, 
     243                          doc="Exclusive tabs") 
    230244 
    231245    def __init__(self, parent=None, **kwargs): 
     
    283297 
    284298    def setTabButtonHeight(self, height): 
    285         """Set the tab button height. 
     299        """ 
     300        Set the tab button height. 
    286301        """ 
    287302        if self.__tabButtonHeight != height: 
     
    291306 
    292307    def tabButtonHeight(self): 
     308        """ 
     309        Return the tab button height. 
     310        """ 
    293311        return self.__tabButtonHeight 
    294312 
    295313    def setTabIconSize(self, size): 
    296         """Set the tab button icon size. 
     314        """ 
     315        Set the tab button icon size. 
    297316        """ 
    298317        if self.__tabIconSize != size: 
     
    302321 
    303322    def tabIconSize(self): 
     323        """ 
     324        Return the tab icon size. 
     325        """ 
    304326        return self.__tabIconSize 
    305327 
    306     def tabButton(self, i): 
    307         """Return the tab button for the `i`-th item. 
    308         """ 
    309         return self.__pages[i].button 
    310  
    311     def tabAction(self, i): 
    312         """Return open/close action for the `i`-th tab. 
    313         """ 
    314         return self.__pages[i].action 
     328    def tabButton(self, index): 
     329        """ 
     330        Return the tab button at `index` 
     331        """ 
     332        return self.__pages[index].button 
     333 
     334    def tabAction(self, index): 
     335        """ 
     336        Return open/close action for the tab at `index`. 
     337        """ 
     338        return self.__pages[index].action 
    315339 
    316340    def addItem(self, widget, text, icon=None, toolTip=None): 
    317         """Add the `widget` in a new tab. Return the index of the new tab. 
     341        """ 
     342        Append the `widget` in a new tab and return its index. 
     343 
     344        Parameters 
     345        ---------- 
     346        widget : :class:`QWidget` 
     347            A widget to be inserted. The toolbox takes ownership 
     348            of the widget. 
     349 
     350        text : str 
     351            Name/title of the new tab. 
     352 
     353        icon : :class:`QIcon`, optional 
     354            An icon for the tab button. 
     355 
     356        toolTip : str, optional 
     357            Tool tip for the tab button. 
     358 
    318359        """ 
    319360        return self.insertItem(self.count(), widget, text, icon, toolTip) 
    320361 
    321362    def insertItem(self, index, widget, text, icon=None, toolTip=None): 
    322         """Insert the `widget` in a new tab at position `index`. 
     363        """ 
     364        Insert the `widget` in a new tab at position `index`. 
     365 
     366        See also 
     367        -------- 
     368        ToolBox.addItem 
     369 
    323370        """ 
    324371        button = self.createTabButton(widget, text, icon, toolTip) 
     
    347394 
    348395    def removeItem(self, index): 
     396        """ 
     397        Remove the widget at `index`. 
     398 
     399        .. note:: The widget hidden but is is not deleted. 
     400 
     401        """ 
    349402        self.__contentsLayout.takeAt(2 * index + 1) 
    350403        self.__contentsLayout.takeAt(2 * index) 
    351404        page = self.__pages.pop(index) 
    352405 
     406        # Update the page indexes 
    353407        for i in range(index, self.count()): 
    354408            self.__pages[i] = self.__pages[i]._replace(index=i) 
     
    367421 
    368422    def count(self): 
     423        """ 
     424        Return the number of widgets inserted in the toolbox. 
     425        """ 
    369426        return len(self.__pages) 
    370427 
    371428    def widget(self, index): 
    372         """Return the widget at index. 
     429        """ 
     430        Return the widget at `index`. 
    373431        """ 
    374432        return self.__pages[index].widget 
    375433 
    376434    def createTabButton(self, widget, text, icon=None, toolTip=None): 
    377         """Create the tab button for `widget`. 
     435        """ 
     436        Create the tab button for `widget`. 
    378437        """ 
    379438        action = QAction(text, self) 
     
    404463 
    405464    def ensureWidgetVisible(self, child, xmargin=50, ymargin=50): 
    406         """Scroll the contents so child widget instance is visible inside 
     465        """ 
     466        Scroll the contents so child widget instance is visible inside 
    407467        the viewport. 
    408468 
     
    507567 
    508568def find(iterable, *what, **kwargs): 
    509     """find(iterable, [what, [key=None, [predicate=operator.eq]]]) 
     569    """ 
     570    find(iterable, [what, [key=None, [predicate=operator.eq]]]) 
    510571    """ 
    511572    if what: 
Note: See TracChangeset for help on using the changeset viewer.