multiWidget.rst 1.2 KB

12345678910111213141516171819202122232425262728293031
  1. Multi Widget Module
  2. ===================
  3. .. module:: multiWidget
  4. This module containts the definition of the MultiWidget Area and Toolbar
  5. .. class:: MDIArea
  6. This class is the center of the MultiWidget. An Instance of this class is accessible throughout the whole Gui after
  7. importing ``base.kcgwidget`` as ``base.kcgwidget.area``
  8. .. _newWidget:
  9. .. py:method:: newWidget(self, widget, name, unique_id, widget_type[, minSize=False])
  10. This function adds the provided widget to the MultiWidget Area. It also handles all the things necessary to cleanly
  11. close the widget from the viewpoint of the Area.
  12. :param subclass of KCGWidgets widget: The widget that is to be added as subwindow
  13. :param str name: The name of the widget
  14. :param int unique_id: the unique id of the widget that is unique throughout the whole Gui
  15. :param int widget_type: the type of the widget
  16. :param bool minSize: Whether the window has a fixed minimum size or not
  17. Adding a Toolbar Button for a new Widget
  18. ''''''''''''''''''''''''''''''''''''''''
  19. To add a Toolbar button for a new Widget you have to register the widget with the kcgwidget module:
  20. See :ref:`kcgwidget_register_widget`