Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 2.22 KB

mainwindow.rst

File metadata and controls

87 lines (57 loc) · 2.22 KB
Raw

MainWindow

A window that can use the full set of window-level user interface elements.

.. tabs::

  .. group-tab:: macOS

    .. figure:: /reference/images/mainwindow-cocoa.png
       :align: center
       :width: 450px

  .. group-tab:: Linux

    .. figure:: /reference/images/mainwindow-gtk.png
       :align: center
       :width: 450px

  .. group-tab:: Windows

    .. figure:: /reference/images/mainwindow-winforms.png
       :align: center
       :width: 450px

  .. group-tab:: Android

    .. figure:: /reference/images/mainwindow-android.png
       :align: center
       :width: 450px

  .. group-tab:: iOS

    .. figure:: /reference/images/mainwindow-iOS.png
       :align: center
       :width: 450px

  .. group-tab:: Web |beta|

    .. .. figure:: /reference/images/mainwindow-web.png
    ..    :align: center
    ..    :width: 300px

    Screenshot not available

  .. group-tab:: Textual |beta|

    .. .. figure:: /reference/images/mainwindow-textual.png
    ..    :align: center
    ..    :width: 300px

    Screenshot not available

Usage

A :class:`toga.MainWindow` is a :class:`toga.Window` that can serve as the main interface to an application. A :class:`toga.MainWindow` may optionally have a toolbar. The presentation of :class:`toga.MainWindow` is platform dependent:

  • On desktop platforms that place menus inside windows (e.g., Windows, and most Linux window managers), a :class:`toga.MainWindow` instance will display a menu bar that contains the defined app :attr:`~toga.App.commands`.
  • On desktop platforms that use an app-level menu bar (e.g., macOS, and some Linux window managers), the window will not have a menu bar; all menu items will be displayed in the app bar.
  • On mobile, web and console platforms, a :class:`toga.MainWindow` will include a title bar that can contain both menus and toolbar items.

Toolbar items can be added by adding them to :attr:`~toga.MainWindow.toolbar`; any command added to the toolbar will be automatically added to the App's commands as well.

import toga

main_window = toga.MainWindow(title='My Application')

self.toga.App.main_window = main_window
main_window.show()

Reference

.. autoclass:: toga.MainWindow