|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QWidget
com.trolltech.qt.gui.QMainWindow
public class QMainWindow
The QMainWindow class provides a main application window.
A main window provides a framework for building an application's user interface. Qt has QMainWindow and its related classes for main window management. QMainWindow has its own layout to which you can add QToolBars, QDockWidgets, a QMenuBar, and a QStatusBar. The layout has a center area that can be occupied by any kind of widget. You can see an image of the layout below.
A central widget will typically be a standard Qt widget such as a QTextEdit or a QGraphicsView. Custom widgets can also be used for advanced applications. You set the central widget with setCentralWidget().
Main windows have either a single (SDI) or multiple (MDI) document interface. You create MDI applications in Qt by using a QMdiArea as the central widget.
We will now examine each of the other widgets that can be added to a main window. We give examples on how to create and add them.
Qt implements menus in QMenu and QMainWindow keeps them in a QMenuBar. QActions are added to the menus, which display them as menu items.
You can add new menus to the main window's menu bar by calling menuBar(), which returns the QMenuBar for the window, and then add a menu with QMenuBar::addMenu().
QMainWindow comes with a default menu bar, but you can also set one yourself with setMenuBar(). If you wish to implement a custom menu bar (i.e., not use the QMenuBar widget), you can set it with setMenuWidget().
An example of how to create menus follows:
void MainWindow::createMenus() { fileMenu = menuBar()->addMenu(tr("&File")); fileMenu->addAction(newAct); fileMenu->addAction(openAct); fileMenu->addAction(saveAct);
The createPopupMenu() function creates popup menus when the main window receives context menu events. The default implementation generates a menu with the checkable actions from the dock widgets and toolbars. You can reimplement createPopupMenu() for a custom menu.
Toolbars are implemented in the QToolBar class. You add a toolbar to a main window with addToolBar().
You control the initial position of toolbars by assigning them to a specific Qt::ToolBarArea. You can split an area by inserting a toolbar break - think of this as a line break in text editing - with addToolBarBreak() or insertToolBarBreak(). You can also restrict placement by the user with QToolBar::setAllowedAreas() and QToolBar::setMovable().
The size of toolbar icons can be retrieved with iconSize(). The sizes are platform dependent; you can set a fixed size with setIconSize(). You can alter the appearance of all tool buttons in the toolbars with setToolButtonStyle().
An example of toolbar creation follows:
void MainWindow::createToolBars() { fileToolBar = addToolBar(tr("File")); fileToolBar->addAction(newAct);
Dock widgets are implemented in the QDockWidget class. A dock widget is a window that can be docked into the main window. You add dock widgets to a main window with addDockWidget().
There are four dock widget areas as given by the Qt::DockWidgetArea enum: left, right, top, and bottom. You can specify which dock widget area that should occupy the corners where the areas overlap with setDockWidgetCorner(). By default each area can only contain one row (vertical or horizontal) of dock widgets, but if you enable nesting with setDockNestingEnabled(), dock widgets can be added in either direction.
Two dock widgets may also be stacked on top of each other. A QTabBar is then used to select which of the widgets that should be displayed.
We give an example of how to create and add dock widgets to a main window:
QDockWidget *dockWidget = new QDockWidget(tr("Dock Widget"), this); dockWidget->setAllowedAreas(Qt::LeftDockWidgetArea | Qt::RightDockWidgetArea); dockWidget->setWidget(dockWidgetContents); addDockWidget(Qt::LeftDockWidgetArea, dockWidget);
You can set a status bar with setStatusBar(), but one is created the first time statusBar() (which returns the main window's status bar) is called. See QStatusBar for information on how to use it.
QMainWindow can store the state of its layout with saveState(); it can later be retrieved with restoreState(). It is the position and size (relative to the size of the main window) of the toolbars and dock widgets that are stored.
Widgets Example
,
Example
,
Example
,
Menus ExampleNested Class Summary | |
---|---|
static class |
QMainWindow.DockOption
This enum contains flags that specify the docking behavior of QMainWindow. |
static class |
QMainWindow.DockOptions
This QFlag class provides flags for the int enum. |
Nested classes/interfaces inherited from class com.trolltech.qt.gui.QWidget |
---|
QWidget.RenderFlag, QWidget.RenderFlags |
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I> |
Field Summary | |
---|---|
QSignalEmitter.Signal1<QSize> |
iconSizeChanged
This signal is emitted when the size of the icons used in the window is changed. |
QSignalEmitter.Signal1<Qt.ToolButtonStyle> |
toolButtonStyleChanged
This signal is emitted when the style used for tool buttons in the window is changed. |
Fields inherited from class com.trolltech.qt.gui.QWidget |
---|
customContextMenuRequested |
Constructor Summary | |
---|---|
QMainWindow()
Equivalent to QMainWindow(0, 0). |
|
QMainWindow(QWidget parent)
Equivalent to QMainWindow(parent, 0). |
|
QMainWindow(QWidget parent,
Qt.WindowFlags flags)
Constructs a QMainWindow with the given parent and the specified widget flags. |
Method Summary | |
---|---|
void |
addDockWidget(Qt.DockWidgetArea area,
QDockWidget dockwidget)
Adds the given dockwidget to the specified area. |
void |
addDockWidget(Qt.DockWidgetArea area,
QDockWidget dockwidget,
Qt.Orientation orientation)
Adds dockwidget into the given area in the direction specified by the orientation. |
void |
addToolBar(Qt.ToolBarArea area,
QToolBar toolbar)
Adds the toolbar into the specified area in this main window. |
void |
addToolBar(QToolBar toolbar)
Equivalent of calling addToolBar(Qt::TopToolBarArea, toolbar) |
QToolBar |
addToolBar(java.lang.String title)
Creates a QToolBar object, setting its window title to title, and inserts it into the top toolbar area. |
void |
addToolBarBreak()
Equivalent to addToolBarBreak(Qt::TopToolBarArea). |
void |
addToolBarBreak(Qt.ToolBarArea area)
Adds a toolbar break to the given area after all the other objects that are present. |
QWidget |
centralWidget()
Returns the central widget for the main window. |
protected void |
contextMenuEvent(QContextMenuEvent event)
This function is reimplemented for internal reasons. |
Qt.DockWidgetArea |
corner(Qt.Corner corner)
Returns the dock widget area that occupies the specified corner. |
QMenu |
createPopupMenu()
Returns a popup menu containing checkable entries for the toolbars and dock widgets present in the main window. |
QMainWindow.DockOptions |
dockOptions()
Returns the docking behavior of QMainWindow. |
Qt.DockWidgetArea |
dockWidgetArea(QDockWidget dockwidget)
Returns the Qt::DockWidgetArea for dockwidget. |
boolean |
event(QEvent event)
This function is reimplemented for internal reasons. |
static QMainWindow |
fromNativePointer(QNativePointer nativePointer)
This function returns the QMainWindow instance pointed to by nativePointer |
QSize |
iconSize()
Returns size of toolbar icons in this mainwindow.. |
void |
insertToolBar(QToolBar before,
QToolBar toolbar)
Inserts the toolbar into the area occupied by the before toolbar so that it appears before it. |
void |
insertToolBarBreak(QToolBar before)
Inserts a toolbar break before the toolbar specified by before. |
boolean |
isAnimated()
Returns whether manipulating dock widgets and tool bars is animated. |
boolean |
isDockNestingEnabled()
Returns whether docks can be nested. |
boolean |
isSeparator(QPoint pos)
|
QMenuBar |
menuBar()
Returns the menu bar for the main window. |
QWidget |
menuWidget()
Returns the menu bar for the main window. |
void |
removeDockWidget(QDockWidget dockwidget)
Removes the dockwidget from the main window layout and hides it. |
void |
removeToolBar(QToolBar toolbar)
Removes the toolbar from the main window layout and hides it. |
void |
removeToolBarBreak(QToolBar before)
Removes a toolbar break previously inserted before the toolbar specified by before. |
boolean |
restoreState(QByteArray state)
Equivalent to restoreState(state, 0). |
boolean |
restoreState(QByteArray state,
int version)
Restores the state of this mainwindow's toolbars and dockwidgets. |
QByteArray |
saveState()
Equivalent to saveState(0). |
QByteArray |
saveState(int version)
Saves the current state of this mainwindow's toolbars and dockwidgets. |
void |
setAnimated(boolean enabled)
Sets whether manipulating dock widgets and tool bars is animated to enabled. |
void |
setCentralWidget(QWidget widget)
Sets the given widget to be the main window's central widget. |
void |
setCorner(Qt.Corner corner,
Qt.DockWidgetArea area)
Sets the given dock widget area to occupy the specified corner. |
void |
setDockNestingEnabled(boolean enabled)
Sets whether docks can be nested to enabled. |
void |
setDockOptions(QMainWindow.DockOption... options)
Sets the docking behavior of QMainWindow to options. |
void |
setDockOptions(QMainWindow.DockOptions options)
Sets the docking behavior of QMainWindow to options. |
void |
setIconSize(QSize iconSize)
Sets size of toolbar icons in this mainwindow. |
void |
setMenuBar(QMenuBar menubar)
Sets the menu bar for the main window to menubar. |
void |
setMenuWidget(QWidget menubar)
Sets the menu bar for the main window to menubar. |
void |
setStatusBar(QStatusBar statusbar)
Sets the status bar for the main window to statusbar. |
void |
setToolButtonStyle(Qt.ToolButtonStyle toolButtonStyle)
Sets style of toolbar buttons in this mainwindow. |
void |
setUnifiedTitleAndToolBarOnMac(boolean set)
Sets whether the window uses the unified title and toolbar look on Mac OS X to set. |
void |
splitDockWidget(QDockWidget after,
QDockWidget dockwidget,
Qt.Orientation orientation)
Splits the space covered by the after dock widget into two parts, moves the after dock widget into the first part, and moves the dockwidget dock widget into the second part. |
QStatusBar |
statusBar()
Returns the status bar for the main window. |
void |
tabifyDockWidget(QDockWidget first,
QDockWidget second)
Moves second dock widget on top of first dock widget, creating a tabbed docked area in the main window. |
Qt.ToolBarArea |
toolBarArea(QToolBar toolbar)
Returns the Qt::ToolBarArea for toolbar. |
boolean |
toolBarBreak(QToolBar toolbar)
Returns whether there is a toolbar break before the toolbar. |
Qt.ToolButtonStyle |
toolButtonStyle()
Returns style of toolbar buttons in this mainwindow.. |
boolean |
unifiedTitleAndToolBarOnMac()
Returns whether the window uses the unified title and toolbar look on Mac OS X. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
blockSignals, childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, property, removeEventFilter, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread, timerEvent |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
disconnect, disconnect, signalSender |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal1<QSize> iconSizeChanged
This signal is emitted when the size of the icons used in the window is changed. The new icon size is passed in iconSize.
You can connect this signal to other components to help maintain a consistent appearance for your application.
public final QSignalEmitter.Signal1<Qt.ToolButtonStyle> toolButtonStyleChanged
This signal is emitted when the style used for tool buttons in the window is changed. The new style is passed in toolButtonStyle.
You can connect this signal to other components to help maintain a consistent appearance for your application.
Constructor Detail |
---|
public QMainWindow(QWidget parent)
Equivalent to QMainWindow(parent, 0).
public QMainWindow()
Equivalent to QMainWindow(0, 0).
public QMainWindow(QWidget parent, Qt.WindowFlags flags)
Constructs a QMainWindow with the given parent and the specified widget flags.
Method Detail |
---|
public final void addDockWidget(Qt.DockWidgetArea area, QDockWidget dockwidget)
Adds the given dockwidget to the specified area.
public final void addDockWidget(Qt.DockWidgetArea area, QDockWidget dockwidget, Qt.Orientation orientation)
Adds dockwidget into the given area in the direction specified by the orientation.
public final void addToolBar(QToolBar toolbar)
Equivalent of calling addToolBar(Qt::TopToolBarArea, toolbar)
public final void addToolBar(Qt.ToolBarArea area, QToolBar toolbar)
Adds the toolbar into the specified area in this main window. The toolbar is placed at the end of the current tool bar block (i.e. line). If the main window already manages toolbar then it will only move the toolbar to area.
public final QToolBar addToolBar(java.lang.String title)
Creates a QToolBar object, setting its window title to title, and inserts it into the top toolbar area.
public final void addToolBarBreak()
Equivalent to addToolBarBreak(Qt::TopToolBarArea).
public final void addToolBarBreak(Qt.ToolBarArea area)
Adds a toolbar break to the given area after all the other objects that are present.
public final QWidget centralWidget()
Returns the central widget for the main window. This function returns zero if the central widget has not been set.
public final Qt.DockWidgetArea corner(Qt.Corner corner)
Returns the dock widget area that occupies the specified corner.
public final QMainWindow.DockOptions dockOptions()
Returns the docking behavior of QMainWindow.
The default value is AnimatedDocks | AllowTabbedDocks.
public final Qt.DockWidgetArea dockWidgetArea(QDockWidget dockwidget)
Returns the Qt::DockWidgetArea for dockwidget. If dockwidget has not been added to the main window, this function returns Qt::NoDockWidgetArea.
public final QSize iconSize()
Returns size of toolbar icons in this mainwindow..
The default is the default tool bar icon size of the GUI style. Note that the icons used must be at least of this size as the icons are only scaled down.
public final void insertToolBar(QToolBar before, QToolBar toolbar)
Inserts the toolbar into the area occupied by the before toolbar so that it appears before it. For example, in normal left-to-right layout operation, this means that toolbar will appear to the left of the toolbar specified by before in a horizontal toolbar area.
public final void insertToolBarBreak(QToolBar before)
Inserts a toolbar break before the toolbar specified by before.
public final boolean isAnimated()
Returns whether manipulating dock widgets and tool bars is animated.
When a dock widget or tool bar is dragged over the main window, the main window adjusts its contents to indicate where the dock widget or tool bar will be docked if it is dropped. Setting this property causes QMainWindow to move its contents in a smooth animation. Clearing this property causes the contents to snap into their new positions.
By default, this property is set. It may be cleared if the main window contains widgets which are slow at resizing or repainting themselves.
Setting this property is identical to setting the AnimatedDocks option using setDockOptions.
public final boolean isDockNestingEnabled()
Returns whether docks can be nested.
If this property is false, dock areas can only contain a single row (horizontal or vertical) of dock widgets. If this property is true, the area occupied by a dock widget can be split in either direction to contain more dock widgets.
Dock nesting is only necessary in applications that contain a lot of dock widgets. It gives the user greater freedom in organizing their main window. However, dock nesting leads to more complex (and less intuitive) behavior when a dock widget is dragged over the main window, since there are more ways in which a dropped dock widget may be placed in the dock area.
Setting this property is identical to setting the AllowNestedDocks option using setDockOptions.
public final boolean isSeparator(QPoint pos)
public final QMenuBar menuBar()
Returns the menu bar for the main window. This function creates and returns an empty menu bar if the menu bar does not exist.
public final QWidget menuWidget()
Returns the menu bar for the main window. This function returns null if a menu bar hasn't been constructed yet.
public final void removeDockWidget(QDockWidget dockwidget)
Removes the dockwidget from the main window layout and hides it. Note that the dockwidget is not deleted.
public final void removeToolBar(QToolBar toolbar)
Removes the toolbar from the main window layout and hides it. Note that the toolbar is not deleted.
public final void removeToolBarBreak(QToolBar before)
Removes a toolbar break previously inserted before the toolbar specified by before.
public final boolean restoreState(QByteArray state)
Equivalent to restoreState(state, 0).
public final boolean restoreState(QByteArray state, int version)
Restores the state of this mainwindow's toolbars and dockwidgets. The version number is compared with that stored in state. If they do not match, the mainwindow's state is left unchanged, and this function returns false; otherwise, the state is restored, and this function returns true.
public final QByteArray saveState()
Equivalent to saveState(0).
public final QByteArray saveState(int version)
Saves the current state of this mainwindow's toolbars and dockwidgets. The version number is stored as part of the data.
The objectName property is used to identify each QToolBar and QDockWidget. You should make sure that this property is unique for each QToolBar and QDockWidget you add to the QMainWindow
To restore the saved state, pass the return value and version number to restoreState.
public final void setAnimated(boolean enabled)
Sets whether manipulating dock widgets and tool bars is animated to enabled.
When a dock widget or tool bar is dragged over the main window, the main window adjusts its contents to indicate where the dock widget or tool bar will be docked if it is dropped. Setting this property causes QMainWindow to move its contents in a smooth animation. Clearing this property causes the contents to snap into their new positions.
By default, this property is set. It may be cleared if the main window contains widgets which are slow at resizing or repainting themselves.
Setting this property is identical to setting the AnimatedDocks option using setDockOptions.
public final void setCentralWidget(QWidget widget)
Sets the given widget to be the main window's central widget.
Note: QMainWindow takes ownership of the widget pointer and deletes it at the appropriate time.
public final void setCorner(Qt.Corner corner, Qt.DockWidgetArea area)
Sets the given dock widget area to occupy the specified corner.
public final void setDockNestingEnabled(boolean enabled)
Sets whether docks can be nested to enabled.
If this property is false, dock areas can only contain a single row (horizontal or vertical) of dock widgets. If this property is true, the area occupied by a dock widget can be split in either direction to contain more dock widgets.
Dock nesting is only necessary in applications that contain a lot of dock widgets. It gives the user greater freedom in organizing their main window. However, dock nesting leads to more complex (and less intuitive) behavior when a dock widget is dragged over the main window, since there are more ways in which a dropped dock widget may be placed in the dock area.
Setting this property is identical to setting the AllowNestedDocks option using setDockOptions.
public final void setDockOptions(QMainWindow.DockOption... options)
Sets the docking behavior of QMainWindow to options.
The default value is AnimatedDocks | AllowTabbedDocks.
public final void setDockOptions(QMainWindow.DockOptions options)
Sets the docking behavior of QMainWindow to options.
The default value is AnimatedDocks | AllowTabbedDocks.
public final void setIconSize(QSize iconSize)
Sets size of toolbar icons in this mainwindow. to iconSize.
The default is the default tool bar icon size of the GUI style. Note that the icons used must be at least of this size as the icons are only scaled down.
public final void setMenuBar(QMenuBar menubar)
Sets the menu bar for the main window to menubar.
Note: QMainWindow takes ownership of the menubar pointer and deletes it at the appropriate time.
public final void setMenuWidget(QWidget menubar)
Sets the menu bar for the main window to menubar.
QMainWindow takes ownership of the menubar pointer and deletes it at the appropriate time.
public final void setStatusBar(QStatusBar statusbar)
Sets the status bar for the main window to statusbar.
Setting the status bar to 0 will remove it from the main window. Note that QMainWindow takes ownership of the statusbar pointer and deletes it at the appropriate time.
public final void setToolButtonStyle(Qt.ToolButtonStyle toolButtonStyle)
Sets style of toolbar buttons in this mainwindow. to toolButtonStyle.
The default is Qt::ToolButtonIconOnly.
public final void setUnifiedTitleAndToolBarOnMac(boolean set)
Sets whether the window uses the unified title and toolbar look on Mac OS X to set.
This property is false by default and only has any effect on Mac OS X 10.4 or higher.
If set to true, then the top toolbar area is replaced with a Carbon HIToolbar and all toolbars in the top toolbar area are moved to that. Any toolbars added afterwards will also be added to the Carbon HIToolbar. This means a couple of things.
Setting this back to false will remove these restrictions.
The Qt::WA_MacBrushedMetal attribute takes precedence over this property.
public final void splitDockWidget(QDockWidget after, QDockWidget dockwidget, Qt.Orientation orientation)
Splits the space covered by the after dock widget into two parts, moves the after dock widget into the first part, and moves the dockwidget dock widget into the second part.
The orientation specifies how the space is divided: A Qt::Horizontal split places the second dock widget to the right of the first; a Qt::Vertical split places the second dock widget below the first.
Note: if after is currently in a tabbed docked area, dockwidget will be added as a new tab, not as a neighbor of after. This is because a single tab can contain only one dock widget.
Note: The Qt::LayoutDirection influences the order of the dock widgets in the two parts of the divided area. When right-to-left layout direction is enabled, the placing of the dock widgets will be reversed.
public final QStatusBar statusBar()
Returns the status bar for the main window. This function creates and returns an empty status bar if the status bar does not exist.
public final void tabifyDockWidget(QDockWidget first, QDockWidget second)
Moves second dock widget on top of first dock widget, creating a tabbed docked area in the main window.
public final Qt.ToolBarArea toolBarArea(QToolBar toolbar)
Returns the Qt::ToolBarArea for toolbar. If toolbar has not been added to the main window, this function returns Qt::NoToolBarArea.
public final boolean toolBarBreak(QToolBar toolbar)
Returns whether there is a toolbar break before the toolbar.
public final Qt.ToolButtonStyle toolButtonStyle()
Returns style of toolbar buttons in this mainwindow..
The default is Qt::ToolButtonIconOnly.
public final boolean unifiedTitleAndToolBarOnMac()
Returns whether the window uses the unified title and toolbar look on Mac OS X.
This property is false by default and only has any effect on Mac OS X 10.4 or higher.
If set to true, then the top toolbar area is replaced with a Carbon HIToolbar and all toolbars in the top toolbar area are moved to that. Any toolbars added afterwards will also be added to the Carbon HIToolbar. This means a couple of things.
Setting this back to false will remove these restrictions.
The Qt::WA_MacBrushedMetal attribute takes precedence over this property.
protected void contextMenuEvent(QContextMenuEvent event)
This function is reimplemented for internal reasons.
contextMenuEvent
in class QWidget
public QMenu createPopupMenu()
Returns a popup menu containing checkable entries for the toolbars and dock widgets present in the main window. If there are no toolbars and dock widgets present, this function returns a null pointer.
By default, this function is called by the main window when the user activates a context menu, typically by right-clicking on a toolbar or a dock widget.
If you want to create a custom popup menu, reimplement this function and return a newly-created popup menu. Ownership of the popup menu is transferred to the caller.
public boolean event(QEvent event)
This function is reimplemented for internal reasons.
event
in class QWidget
public static QMainWindow fromNativePointer(QNativePointer nativePointer)
nativePointer
- the QNativePointer of which object should be returned.
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |