multiWidget.rst 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.
  2. .. module:: multiWidget
  3. .. _multiWidget:
  4. Module multiWidget
  5. ==================
  6. This is the container widget for multiple subwindows
  7. .. py:class:: WidgetTypeError(Exception)
  8. Simple error that describes when a wrong window type gets added
  9. .. py:class:: MDIArea(kcgw.KCGWidgets)
  10. The MDI Area used by Multiwidget
  11. .. py:method:: __init__(self, parent)
  12. .. py:method:: newWidget(self, widget, name, unique_id, widget_type, minSize=False)
  13. Add a new Widget to the MDIArea
  14. :param widget: (subclass of QMdiSubWindow) The widget to show
  15. :param name: (str) name of the window
  16. :param unique_id: (int) unique id of the window
  17. :param widget_type: (int) the type of this window
  18. :param minSize: (bool) whether to shrink the window to minimum size upon creation
  19. .. py:class:: MultiWidget(QtGui.QWidget)
  20. The Widget used as Multiwidget. This is the main View during operation with KCG.
  21. .. py:method:: __init__(self)
  22. .. py:method:: addToolbarButton(self, icon, text, target, shortcut=None)
  23. Add a toolbar button.
  24. :param icon: (QIcon) The icon to show on the toolbar button
  25. :param text: (str) tooltip for this button
  26. :param target: (callable) The function to call upon press on button
  27. :param shortcut: (str) Keyboard shortcut to call target
  28. .. py:method:: evaluate_registered_widgets(self)
  29. Evaluate all the registered widgets and add a toolbar button for those
  30. .. py:method:: evaluate_registered_widget_functions(self)
  31. Evaluate the functions that are registered
  32. Those are in general functions that have to be called after widgets are created