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/toolgrid.py

    r11345 r11366  
    11""" 
    2 Tool Grid Widget. 
    3 ================ 
    4  
    5 A Widget containing a grid of clickable actions/buttons. 
     2A widget containing a grid of clickable actions/buttons. 
    63 
    74""" 
     
    110107 
    111108class ToolGrid(QFrame): 
    112     """A widget containing a grid of actions/buttons. 
    113  
    114     Actions can be added using standard QWidget addAction and insertAction 
    115     methods. 
    116  
    117109    """ 
     110    A widget containing a grid of actions/buttons. 
     111 
     112    Actions can be added using standard :ref:`QWidget.addAction(QAction)` 
     113    and :ref:`QWidget.insertAction(int, QAction)` methods. 
     114 
     115    Parameters 
     116    ---------- 
     117    parent : :class:`QWidget` 
     118        Parent widget. 
     119    columns : int 
     120        Number of columns in the grid layout. 
     121    buttonSize : :class:`QSize`, optional 
     122        Size of tool buttons in the grid. 
     123    iconSize : :class:`QSize`, optional 
     124        Size of icons in the buttons. 
     125    toolButtonStyle : :class:`Qt.ToolButtonStyle` 
     126        Tool button style. 
     127 
     128    """ 
     129 
    118130    actionTriggered = Signal(QAction) 
    119131    actionHovered = Signal(QAction) 
     
    157169 
    158170    def setButtonSize(self, size): 
    159         """Set the button size. 
     171        """ 
     172        Set the button size. 
    160173        """ 
    161174        if self.__buttonSize != size: 
     
    165178 
    166179    def buttonSize(self): 
     180        """ 
     181        Return the button size. 
     182        """ 
    167183        return QSize(self.__buttonSize) 
    168184 
    169185    def setIconSize(self, size): 
    170         """Set the button icon size. 
     186        """ 
     187        Set the button icon size. 
    171188        """ 
    172189        if self.__iconSize != size: 
     
    176193 
    177194    def iconSize(self): 
     195        """ 
     196        Return the icon size 
     197        """ 
    178198        return QSize(self.__iconSize) 
    179199 
    180200    def setToolButtonStyle(self, style): 
    181         """Set the tool button style. 
     201        """ 
     202        Set the tool button style. 
    182203        """ 
    183204        if self.__toolButtonStyle != style: 
     
    187208 
    188209    def toolButtonStyle(self): 
     210        """ 
     211        Return the tool button style. 
     212        """ 
    189213        return self.__toolButtonStyle 
    190214 
    191215    def setColumnCount(self, columns): 
    192         """Set the number of button/action columns. 
     216        """ 
     217        Set the number of button/action columns. 
    193218        """ 
    194219        if self.__columns != columns: 
     
    197222 
    198223    def columns(self): 
     224        """ 
     225        Return the number of columns in the grid. 
     226        """ 
    199227        return self.__columns 
    200228 
    201229    def clear(self): 
    202         """Clear all actions. 
     230        """ 
     231        Clear all actions/buttons. 
    203232        """ 
    204233        for slot in reversed(list(self.__gridSlots)): 
     
    207236 
    208237    def insertAction(self, before, action): 
    209         """Insert a new action at the position currently occupied 
     238        """ 
     239        Insert a new action at the position currently occupied 
    210240        by `before` (can also be an index). 
     241 
     242        Parameters 
     243        ---------- 
     244        before : :class:`QAction` or int 
     245            Position where the `action` should be inserted. 
     246        action : :class:`QAction` 
     247            Action to insert 
    211248 
    212249        """ 
     
    214251            actions = list(self.actions()) 
    215252            if len(actions) == 0 or before >= len(actions): 
    216                 # Insert as the first action of the last action. 
     253                # Insert as the first action or the last action. 
    217254                return self.addAction(action) 
    218255 
     
    222259 
    223260    def setActions(self, actions): 
    224         """Clear the grid and add actions. 
     261        """ 
     262        Clear the grid and add `actions`. 
    225263        """ 
    226264        self.clear() 
     
    230268 
    231269    def buttonForAction(self, action): 
    232         """Return the `QToolButton` instance button for `action`. 
     270        """ 
     271        Return the :class:`QToolButton` instance button for `action`. 
    233272        """ 
    234273        actions = [slot.action for slot in self.__gridSlots] 
     
    237276 
    238277    def createButtonForAction(self, action): 
    239         """Create and return a QToolButton for action. 
     278        """ 
     279        Create and return a :class:`QToolButton` for action. 
    240280        """ 
    241281        button = _ToolGridButton(self) 
     
    252292 
    253293    def count(self): 
     294        """ 
     295        Return the number of buttons/actions in the grid. 
     296        """ 
    254297        return len(self.__gridSlots) 
    255298 
     
    349392 
    350393    def __onButtonRightClick(self, button): 
    351         print button 
     394        pass 
    352395 
    353396    def __onButtonEnter(self, button): 
     
    397440 
    398441class ToolButtonEventListener(QObject): 
    399     """An event listener(filter) for QToolButtons. 
     442    """ 
     443    An event listener(filter) for :class:`QToolButtons`. 
    400444    """ 
    401445    buttonLeftClicked = Signal(QToolButton) 
Note: See TracChangeset for help on using the changeset viewer.