Changeset 11372:3c196fa6a03a in orange


Ignore:
Timestamp:
02/26/13 12:53:37 (14 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Fixed docstrings for widget toolbox.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeCanvas/application/widgettoolbox.py

    r11309 r11372  
    3232 
    3333def iter_item(item): 
    34     """Iterate over child items of a `QStandardItem`. 
     34    """ 
     35    Iterate over child items of a `QStandardItem`. 
    3536    """ 
    3637    for i in range(item.rowCount()): 
     
    3940 
    4041class WidgetToolGrid(ToolGrid): 
    41     """A Tool Grid with widget buttons. Populates the widget buttons 
     42    """ 
     43    A Tool Grid with widget buttons. Populates the widget buttons 
    4244    from a item model. Also adds support for drag operations. 
    4345 
     
    5961 
    6062    def setModel(self, model, rootIndex=QModelIndex()): 
    61         """Set a model (`QStandardItemModel`) for the tool grid. The 
     63        """ 
     64        Set a model (`QStandardItemModel`) for the tool grid. The 
    6265        widget actions are children of the rootIndex. 
    6366 
     
    8184 
    8285    def model(self): 
    83         """Return the model for the tool grid. 
     86        """ 
     87        Return the model for the tool grid. 
    8488        """ 
    8589        return self.__model 
    8690 
    8791    def rootIndex(self): 
     92        """ 
     93        Return the root index of the model. 
     94        """ 
    8895        return self.__rootIndex 
    8996 
    9097    def setActionRole(self, role): 
    91         """Set the action role. 
     98        """ 
     99        Set the action role. This is the model role containing a 
     100        `QAction` instance. 
     101 
    92102        """ 
    93103        if self.__actionRole != role: 
     
    97107 
    98108    def actionRole(self): 
    99         """Return the action role. 
     109        """ 
     110        Return the action role. 
    100111        """ 
    101112        return self.__actionRole 
     
    114125            button.removeEventFilter(self.__dragListener) 
    115126            button.removeEventFilter(self.__statusTipPromoter) 
     127 
    116128            # Removes the button 
    117129            ToolGrid.actionEvent(self, event) 
     
    121133 
    122134    def __initFromModel(self, model, rootIndex): 
    123         """Initialize the grid from the model with rootIndex as the root. 
     135        """ 
     136        Initialize the grid from the model with rootIndex as the root. 
    124137        """ 
    125138        if not rootIndex.isValid(): 
     
    134147 
    135148    def __insertItem(self, index, item): 
    136         """Insert a widget action (from a `QStandardItem`) at index. 
     149        """ 
     150        Insert a widget action (from a `QStandardItem`) at index. 
    137151        """ 
    138152        value = item.data(self.__actionRole) 
     
    150164 
    151165    def __on_rowsInserted(self, parent, start, end): 
    152         """Insert items from range start:end into the grid. 
     166        """ 
     167        Insert items from range start:end into the grid. 
    153168        """ 
    154169        item = self.__model.itemForIndex(parent) 
     
    159174 
    160175    def __on_rowsRemoved(self, parent, start, end): 
    161         """Remove items from range start:end from the grid. 
     176        """ 
     177        Remove items from range start:end from the grid. 
    162178        """ 
    163179        item = self.__model.itemForIndex(parent) 
     
    168184 
    169185    def __startDrag(self, button): 
    170         """Start a drag from button 
     186        """ 
     187        Start a drag from button 
    171188        """ 
    172189        action = button.defaultAction() 
     
    185202 
    186203class DragStartEventListener(QObject): 
    187     """An event filter object that can be used to detect drag start 
     204    """ 
     205    An event filter object that can be used to detect drag start 
    188206    operation on buttons which otherwise do not support it. 
    189207 
    190208    """ 
    191209    dragStartOperationRequested = Signal(QAbstractButton) 
     210    """A drag operation started on a button.""" 
    192211 
    193212    def __init__(self, parent=None, **kwargs): 
     
    223242 
    224243class WidgetToolBox(ToolBox): 
     244    """ 
     245    `WidgetToolBox` widget shows a tool box containing button grids of 
     246    actions for a :class:`QtWidgetRegistry` item model. 
     247 
     248    """ 
    225249 
    226250    triggered = Signal(QAction) 
     
    236260 
    237261    def setIconSize(self, size): 
    238         """Set the widget icon size. 
     262        """ 
     263        Set the widget icon size (icons in the button grid). 
    239264        """ 
    240265        self.__iconSize = size 
     
    243268 
    244269    def iconSize(self): 
    245         """Return the widget buttons icon size. 
     270        """ 
     271        Return the widget buttons icon size. 
    246272        """ 
    247273        return self.__iconSize 
     
    251277 
    252278    def setButtonSize(self, size): 
    253         """Set fixed widget button size. 
     279        """ 
     280        Set fixed widget button size. 
    254281        """ 
    255282        self.__buttonSize = size 
     
    258285 
    259286    def buttonSize(self): 
     287        """Return the widget button size 
     288        """ 
    260289        return self.__buttonSize 
    261290 
     
    264293 
    265294    def saveState(self): 
    266         """Return the toolbox state. 
     295        """ 
     296        Return the toolbox state (as a `QByteArray`). 
    267297 
    268298        .. note:: Individual tabs are stored by their action's text. 
     
    283313 
    284314    def restoreState(self, state): 
    285         """Restore the toolbox from a :class:`QByteArray` `state`. 
     315        """ 
     316        Restore the toolbox from a :class:`QByteArray` `state`. 
    286317 
    287318        .. note:: The toolbox should already be populated for the state 
     
    304335 
    305336    def setModel(self, model): 
    306         """Set the widget registry model for this toolbox. 
     337        """ 
     338        Set the widget registry model (:class:`QStandardItemModel`) for 
     339        this toolbox. 
     340 
    307341        """ 
    308342        if self.__model is not None: 
    309343            self.__model.itemChanged.disconnect(self.__on_itemChanged) 
    310344            self.__model.rowsInserted.disconnect(self.__on_rowsInserted) 
    311             self.__model.rowsRemoved.disconect(self.__on_rowsRemoved) 
     345            self.__model.rowsRemoved.disconnect(self.__on_rowsRemoved) 
    312346 
    313347        self.__model = model 
     
    324358 
    325359    def __insertItem(self, item, index): 
    326         """Insert category item at index. 
     360        """ 
     361        Insert category item at index. 
    327362        """ 
    328363        grid = WidgetToolGrid() 
     
    363398 
    364399    def __on_itemChanged(self, item): 
    365         """Item contents have changed. 
     400        """ 
     401        Item contents have changed. 
    366402        """ 
    367403        parent = item.parent() 
     
    373409 
    374410    def __on_rowsInserted(self, parent, start, end): 
    375         """Items have been inserted in the model. 
     411        """ 
     412        Items have been inserted in the model. 
    376413        """ 
    377414        # Only the top level items (categories) are handled here. 
     
    383420 
    384421    def __on_rowsRemoved(self, parent, start, end): 
    385         """Rows have been removed from the model. 
     422        """ 
     423        Rows have been removed from the model. 
    386424        """ 
    387425        # Only the top level items (categories) are handled here. 
Note: See TracChangeset for help on using the changeset viewer.