| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|---|
| 2 | <!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qtoolbar.cpp:210 -->
|
|---|
| 3 | <html>
|
|---|
| 4 | <head>
|
|---|
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|---|
| 6 | <title>QToolBar Class</title>
|
|---|
| 7 | <style type="text/css"><!--
|
|---|
| 8 | fn { margin-left: 1cm; text-indent: -1cm; }
|
|---|
| 9 | a:link { color: #004faf; text-decoration: none }
|
|---|
| 10 | a:visited { color: #672967; text-decoration: none }
|
|---|
| 11 | body { background: #ffffff; color: black; }
|
|---|
| 12 | --></style>
|
|---|
| 13 | </head>
|
|---|
| 14 | <body>
|
|---|
| 15 |
|
|---|
| 16 | <table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|---|
| 17 | <tr bgcolor="#E5E5E5">
|
|---|
| 18 | <td valign=center>
|
|---|
| 19 | <a href="index.html">
|
|---|
| 20 | <font color="#004faf">Home</font></a>
|
|---|
| 21 | | <a href="classes.html">
|
|---|
| 22 | <font color="#004faf">All Classes</font></a>
|
|---|
| 23 | | <a href="mainclasses.html">
|
|---|
| 24 | <font color="#004faf">Main Classes</font></a>
|
|---|
| 25 | | <a href="annotated.html">
|
|---|
| 26 | <font color="#004faf">Annotated</font></a>
|
|---|
| 27 | | <a href="groups.html">
|
|---|
| 28 | <font color="#004faf">Grouped Classes</font></a>
|
|---|
| 29 | | <a href="functions.html">
|
|---|
| 30 | <font color="#004faf">Functions</font></a>
|
|---|
| 31 | </td>
|
|---|
| 32 | <td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QToolBar Class Reference</h1>
|
|---|
| 33 |
|
|---|
| 34 | <p>The QToolBar class provides a movable panel containing
|
|---|
| 35 | widgets such as tool buttons.
|
|---|
| 36 | <a href="#details">More...</a>
|
|---|
| 37 | <p><tt>#include <<a href="qtoolbar-h.html">qtoolbar.h</a>></tt>
|
|---|
| 38 | <p>Inherits <a href="qdockwindow.html">QDockWindow</a>.
|
|---|
| 39 | <p><a href="qtoolbar-members.html">List of all member functions.</a>
|
|---|
| 40 | <h2>Public Members</h2>
|
|---|
| 41 | <ul>
|
|---|
| 42 | <li class=fn>QToolBar ( const QString & label, QMainWindow *, ToolBarDock = DockTop, bool newLine = FALSE, const char * name = 0 ) <em>(obsolete)</em></li>
|
|---|
| 43 | <li class=fn><a href="#QToolBar-2"><b>QToolBar</b></a> ( const QString & label, QMainWindow * mainWindow, QWidget * parent, bool newLine = FALSE, const char * name = 0, WFlags f = 0 )</li>
|
|---|
| 44 | <li class=fn><a href="#QToolBar-3"><b>QToolBar</b></a> ( QMainWindow * parent = 0, const char * name = 0 )</li>
|
|---|
| 45 | <li class=fn>void <a href="#addSeparator"><b>addSeparator</b></a> ()</li>
|
|---|
| 46 | <li class=fn>QMainWindow * <a href="#mainWindow"><b>mainWindow</b></a> () const</li>
|
|---|
| 47 | <li class=fn>virtual void <a href="#setStretchableWidget"><b>setStretchableWidget</b></a> ( QWidget * w )</li>
|
|---|
| 48 | <li class=fn>virtual void <a href="#setLabel"><b>setLabel</b></a> ( const QString & )</li>
|
|---|
| 49 | <li class=fn>QString <a href="#label"><b>label</b></a> () const</li>
|
|---|
| 50 | <li class=fn>virtual void <a href="#clear"><b>clear</b></a> ()</li>
|
|---|
| 51 | </ul>
|
|---|
| 52 | <h2>Properties</h2>
|
|---|
| 53 | <ul>
|
|---|
| 54 | <li class=fn>QString <a href="#label-prop"><b>label</b></a> - the toolbar's label</li>
|
|---|
| 55 | </ul>
|
|---|
| 56 | <hr><a name="details"></a><h2>Detailed Description</h2>
|
|---|
| 57 |
|
|---|
| 58 |
|
|---|
| 59 | The QToolBar class provides a movable panel containing
|
|---|
| 60 | widgets such as tool buttons.
|
|---|
| 61 | <p>
|
|---|
| 62 |
|
|---|
| 63 | <p> A toolbar is a panel that contains a set of controls, usually
|
|---|
| 64 | represented by small icons. It's purpose is to provide quick
|
|---|
| 65 | access to frequently used commands or options. Within a
|
|---|
| 66 | <a href="qmainwindow.html">QMainWindow</a> the user can drag toolbars within and between the
|
|---|
| 67 | <a href="qdockarea.html">dock areas</a>. Toolbars can also be dragged
|
|---|
| 68 | out of any dock area to float freely as top-level windows.
|
|---|
| 69 | <p> QToolBar is a specialization of <a href="qdockwindow.html">QDockWindow</a>, and so provides all
|
|---|
| 70 | the functionality of a QDockWindow.
|
|---|
| 71 | <p> To use QToolBar you simply create a QToolBar as a child of a
|
|---|
| 72 | QMainWindow, create a number of <a href="qtoolbutton.html">QToolButton</a> widgets (or other
|
|---|
| 73 | widgets) in left to right (or top to bottom) order and call
|
|---|
| 74 | <a href="#addSeparator">addSeparator</a>() when you want a separator. When a toolbar is
|
|---|
| 75 | floated the caption used is the label given in the constructor
|
|---|
| 76 | call. This can be changed with <a href="#setLabel">setLabel</a>().
|
|---|
| 77 | <p>
|
|---|
| 78 |
|
|---|
| 79 | <pre> QToolBar * fileTools = new QToolBar( this, "file operations" );
|
|---|
| 80 | fileTools-><a href="#setLabel">setLabel</a>( "File Operations" );
|
|---|
| 81 | fileOpenAction-><a href="qaction.html#addTo">addTo</a>( fileTools );
|
|---|
| 82 | fileSaveAction-><a href="qaction.html#addTo">addTo</a>( fileTools );
|
|---|
| 83 | </pre>
|
|---|
| 84 | <p> This extract from the <a href="simple-application-example.html">application/application.cpp</a> example shows
|
|---|
| 85 | the creation of a new toolbar as a child of a <a href="qmainwindow.html">QMainWindow</a> and
|
|---|
| 86 | adding two QActions.
|
|---|
| 87 | <p> You may use most widgets within a toolbar, with QToolButton and
|
|---|
| 88 | <a href="qcombobox.html">QComboBox</a> being the most common.
|
|---|
| 89 | <p> If you create a new widget on an already visible QToolBar, this
|
|---|
| 90 | widget will automatically become visible without needing a <a href="qwidget.html#show">show</a>()
|
|---|
| 91 | call. (This differs from every other Qt widget container. We
|
|---|
| 92 | recommend calling show() anyway since we hope to fix this anomaly
|
|---|
| 93 | in a future release.)
|
|---|
| 94 | <p> QToolBars, like QDockWindows, are located in <a href="qdockarea.html">QDockArea</a>s or
|
|---|
| 95 | float as top-level windows. QMainWindow provides four QDockAreas
|
|---|
| 96 | (top, left, right and bottom). When you create a new toolbar (as
|
|---|
| 97 | in the example above) as a child of a QMainWindow the toolbar will
|
|---|
| 98 | be added to the top dock area. You can move it to another dock
|
|---|
| 99 | area (or float it) by calling <a href="qmainwindow.html#moveDockWindow">QMainWindow::moveDockWindow</a>(). QDock
|
|---|
| 100 | areas lay out their windows in <a href="qdockarea.html#lines">Lines</a>.
|
|---|
| 101 | <p> If the main window is resized so that the area occupied by the
|
|---|
| 102 | toolbar is too small to show all its widgets a little arrow button
|
|---|
| 103 | (which looks like a right-pointing chevron, '»') will appear
|
|---|
| 104 | at the right or bottom of the toolbar depending on its
|
|---|
| 105 | orientation. Clicking this button pops up a menu that shows the
|
|---|
| 106 | 'overflowing' items. QToolButtons are represented in the menu using
|
|---|
| 107 | their textLabel property, other <a href="qbutton.html">QButton</a> subclasses are represented
|
|---|
| 108 | using their text property, and QComboBoxes are represented as submenus,
|
|---|
| 109 | with the caption text being used in the submenu item.
|
|---|
| 110 | <p> Usually a toolbar will get precisely the space it needs. However,
|
|---|
| 111 | with <a href="qdockwindow.html#setHorizontalStretchable">setHorizontalStretchable</a>(), <a href="qdockwindow.html#setVerticalStretchable">setVerticalStretchable</a>() or
|
|---|
| 112 | <a href="#setStretchableWidget">setStretchableWidget</a>() you can tell the main window to expand the
|
|---|
| 113 | toolbar to fill all available space in the specified orientation.
|
|---|
| 114 | <p> The toolbar arranges its buttons either horizontally or vertically
|
|---|
| 115 | (see <a href="qdockwindow.html#orientation">orientation</a>() for details). Generally, <a href="qdockarea.html">QDockArea</a> will set the
|
|---|
| 116 | orientation correctly for you, but you can set it yourself with
|
|---|
| 117 | <a href="qdockwindow.html#setOrientation">setOrientation</a>() and track any changes by connecting to the
|
|---|
| 118 | <a href="qdockwindow.html#orientationChanged">orientationChanged</a>() signal.
|
|---|
| 119 | <p> You can use the <a href="#clear">clear</a>() method to remove all items from a toolbar.
|
|---|
| 120 | <p> <center><img src="qdockwindow.png" alt="Toolbar (dock window)"></center> <blockquote><p align="center"><em> A floating QToolbar (dock window)
|
|---|
| 121 | </em></p>
|
|---|
| 122 | </blockquote><p> <p>See also <a href="qtoolbutton.html">QToolButton</a>, <a href="qmainwindow.html">QMainWindow</a>, <a href="http://www.iarchitect.com/visual.htm">Parts of Isys on Visual Design</a>, <a href="guibooks.html#fowler">GUI Design Handbook: Tool Bar</a>, and <a href="application.html">Main Window and Related Classes</a>.
|
|---|
| 123 |
|
|---|
| 124 | <hr><h2>Member Function Documentation</h2>
|
|---|
| 125 | <h3 class=fn><a name="QToolBar"></a>QToolBar::QToolBar ( const <a href="qstring.html">QString</a> & label, <a href="qmainwindow.html">QMainWindow</a> *, ToolBarDock = DockTop, bool newLine = FALSE, const char * name = 0 )
|
|---|
| 126 | </h3>
|
|---|
| 127 |
|
|---|
| 128 | <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code.
|
|---|
| 129 | <p>
|
|---|
| 130 | <h3 class=fn><a name="QToolBar-2"></a>QToolBar::QToolBar ( const <a href="qstring.html">QString</a> & label, <a href="qmainwindow.html">QMainWindow</a> * mainWindow, <a href="qwidget.html">QWidget</a> * parent, bool newLine = FALSE, const char * name = 0, WFlags f = 0 )
|
|---|
| 131 | </h3>
|
|---|
| 132 | Constructs an empty horizontal toolbar.
|
|---|
| 133 | <p> The toolbar is called <em>name</em> and is a child of <em>parent</em> and is
|
|---|
| 134 | managed by <em>mainWindow</em>. The <em>label</em> and <em>newLine</em> parameters
|
|---|
| 135 | are passed straight to <a href="qmainwindow.html#addDockWindow">QMainWindow::addDockWindow</a>(). <em>name</em> and
|
|---|
| 136 | the widget flags <em>f</em> are passed on to the <a href="qdockwindow.html">QDockWindow</a> constructor.
|
|---|
| 137 | <p> Use this constructor if you want to create torn-off (undocked,
|
|---|
| 138 | floating) toolbars or toolbars in the <a href="qstatusbar.html">status
|
|---|
| 139 | bar</a>.
|
|---|
| 140 |
|
|---|
| 141 | <h3 class=fn><a name="QToolBar-3"></a>QToolBar::QToolBar ( <a href="qmainwindow.html">QMainWindow</a> * parent = 0, const char * name = 0 )
|
|---|
| 142 | </h3>
|
|---|
| 143 | This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
|
|---|
| 144 | <p> Constructs an empty toolbar called <em>name</em>, with parent <em>parent</em>,
|
|---|
| 145 | in its <em>parent</em>'s top dock area, without any label and without
|
|---|
| 146 | requiring a newline.
|
|---|
| 147 |
|
|---|
| 148 | <h3 class=fn>void <a name="addSeparator"></a>QToolBar::addSeparator ()
|
|---|
| 149 | </h3>
|
|---|
| 150 | Adds a separator to the right/bottom of the toolbar.
|
|---|
| 151 |
|
|---|
| 152 | <p>Examples: <a href="canvas-chart-example.html#x2894">chart/chartform.cpp</a>, <a href="fileiconview-example.html#x895">fileiconview/mainwindow.cpp</a>, <a href="helpviewer-example.html#x1033">helpviewer/helpwindow.cpp</a>, <a href="qfd-example.html#x2010">qfd/fontdisplayer.cpp</a>, and <a href="scribble-example.html#x943">scribble/scribble.cpp</a>.
|
|---|
| 153 | <h3 class=fn>void <a name="clear"></a>QToolBar::clear ()<tt> [virtual]</tt>
|
|---|
| 154 | </h3>
|
|---|
| 155 | Deletes all the toolbar's child widgets.
|
|---|
| 156 |
|
|---|
| 157 | <h3 class=fn><a href="qstring.html">QString</a> <a name="label"></a>QToolBar::label () const
|
|---|
| 158 | </h3><p>Returns the toolbar's label.
|
|---|
| 159 | See the <a href="qtoolbar.html#label-prop">"label"</a> property for details.
|
|---|
| 160 | <h3 class=fn><a href="qmainwindow.html">QMainWindow</a> * <a name="mainWindow"></a>QToolBar::mainWindow () const
|
|---|
| 161 | </h3>
|
|---|
| 162 | Returns a pointer to the <a href="qmainwindow.html">QMainWindow</a> which manages this toolbar.
|
|---|
| 163 |
|
|---|
| 164 | <h3 class=fn>void <a name="setLabel"></a>QToolBar::setLabel ( const <a href="qstring.html">QString</a> & )<tt> [virtual]</tt>
|
|---|
| 165 | </h3><p>Sets the toolbar's label.
|
|---|
| 166 | See the <a href="qtoolbar.html#label-prop">"label"</a> property for details.
|
|---|
| 167 | <h3 class=fn>void <a name="setStretchableWidget"></a>QToolBar::setStretchableWidget ( <a href="qwidget.html">QWidget</a> * w )<tt> [virtual]</tt>
|
|---|
| 168 | </h3>
|
|---|
| 169 | Sets the widget <em>w</em> to be expanded if this toolbar is requested
|
|---|
| 170 | to stretch.
|
|---|
| 171 | <p> The request to stretch might occur because <a href="qmainwindow.html">QMainWindow</a>
|
|---|
| 172 | right-justifies the dock area the toolbar is in, or because this
|
|---|
| 173 | toolbar's <a href="qdockwindow.html#isVerticalStretchable">isVerticalStretchable</a>() or <a href="qdockwindow.html#isHorizontalStretchable">isHorizontalStretchable</a>() is
|
|---|
| 174 | set to TRUE.
|
|---|
| 175 | <p> If you call this function and the toolbar is not yet stretchable,
|
|---|
| 176 | setStretchable() is called.
|
|---|
| 177 | <p> <p>See also <a href="qmainwindow.html#rightJustification-prop">QMainWindow::rightJustification</a>, <a href="qdockwindow.html#setVerticalStretchable">setVerticalStretchable</a>(), and <a href="qdockwindow.html#setHorizontalStretchable">setHorizontalStretchable</a>().
|
|---|
| 178 |
|
|---|
| 179 | <p>Examples: <a href="fileiconview-example.html#x896">fileiconview/mainwindow.cpp</a> and <a href="helpviewer-example.html#x1034">helpviewer/helpwindow.cpp</a>.
|
|---|
| 180 | <hr><h2>Property Documentation</h2>
|
|---|
| 181 | <h3 class=fn><a href="qstring.html">QString</a> <a name="label-prop"></a>label</h3>
|
|---|
| 182 | <p>This property holds the toolbar's label.
|
|---|
| 183 | <p>If the toolbar is floated the label becomes the toolbar window's
|
|---|
| 184 | caption. There is no default label text.
|
|---|
| 185 |
|
|---|
| 186 | <p>Set this property's value with <a href="#setLabel">setLabel</a>() and get this property's value with <a href="#label">label</a>().
|
|---|
| 187 | <!-- eof -->
|
|---|
| 188 | <hr><p>
|
|---|
| 189 | This file is part of the <a href="index.html">Qt toolkit</a>.
|
|---|
| 190 | Copyright © 1995-2007
|
|---|
| 191 | <a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
|---|
| 192 | <table width=100% cellspacing=0 border=0><tr>
|
|---|
| 193 | <td>Copyright © 2007
|
|---|
| 194 | <a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
|---|
| 195 | <td align=right><div align=right>Qt 3.3.8</div>
|
|---|
| 196 | </table></div></address></body>
|
|---|
| 197 | </html>
|
|---|
