| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106 |
- .. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.
- .. module:: multipage
- .. _multipage:
- Module multipage
- ================
- .. py:class:: RightSwitch(kcgw.ClickableSVG)
- Buttons to change the Page in a MultiPage
- .. py:method:: __init__(self, pagesWidget, width=10, height=20, wwidth=None, hidden=False)
- Initialise a RightSwitch
- :param pagesWidget: (MultiPage) The MultiPage widget to switch pages upon press
- :param width: (int) width of the icon shown on the switch
- :param height: (int) height of the icon shown on the switch
- :param wwidth: (int) Width of the switch
- :param hidden: (bool) whether this switch is shown or hidden
- .. py:class:: LeftSwitch(kcgw.ClickableSVG)
- Buttons to change the Page in a MultiPage Widget
- .. py:method:: __init__(self, pagesWidget, width=10, height=20, wwidth=None, hidden=False)
- Initialise a LeftSwitch
- :param pagesWidget: (MultiPage) The MultiPage widget to switch pages upon press
- :param width: (int) width of the icon shown on the switch
- :param height: (int) height of the icon shown on the switch
- :param wwidth: (int) Width of the switch
- :param hidden: (bool) whether this switch is shown or hidden
- .. py:class:: LeftRightSwitch(QtGui.QWidget)
- Small Buttons to change the Page in a MultiPage Widget
- .. py:method:: __init__(self, pagesWidget)
- Initialise a combination of left and right switch
- :param pagesWidget: (MultiPage) The multipage widget instance to change pages on
- .. py:method:: disable_left(self)
- Disable the switch to the page left of the current one
- .. py:method:: enable_left(self)
- Enable the switch to the page left of the current one
- .. py:method:: disable_right(self)
- Disable the switch to the page right of the current one
- .. py:method:: enable_right(self)
- Enable the switch to the page right of the current one
- .. py:class:: MultiPage(QtGui.QStackedWidget)
- Implementation of a Paginated View Widget
- .. py:method:: __init__(self, parent=None)
- .. py:method:: addPage(self, NewPage, name=None, set_to_first=True)
- Add a page (a Widget) to the MultiPage Widget
- :param NewPage: widget to add as new page
- :param name: name of that page (e.g. to show in the status bar)
- :param bool set_to_first: Set the current page to first page
- .. py:method:: removePage(self, page)
- Removes a page from the pages widget and adjusts switches accordingly
- :param page: what page to remove
- .. py:method:: left(self)
- .. py:method:: right(self)
- .. py:method:: setCurrentIndex(self, p_int)
- Set te current Index of the MultiPage Widget (e.g. set the current page)
- :param p_int: (int) what page
|
