From a17103fb41c8f53e29b4abe26a45b8ba2cd460a4 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Tue, 15 Sep 2009 17:17:07 +0200 Subject: Doc: Cleaned up the Designer main window and Embedded Linux pages. Reviewed-by: Trust Me --- doc/src/development/designer-manual.qdoc | 258 +++++++++++++-------- .../designer-adding-toolbar-action1.png | Bin 14911 -> 21640 bytes .../qtopiacore/qt-embedded-linux-architecture.sk | 5 +- doc/src/frameworks-technologies/gestures.qdoc | 36 +-- doc/src/getting-started/examples.qdoc | 53 +++-- doc/src/images/designer-action-editor.png | Bin 46233 -> 28378 bytes doc/src/images/designer-adding-menu-action.png | Bin 6168 -> 9962 bytes doc/src/images/designer-adding-toolbar-action.png | Bin 5644 -> 7428 bytes doc/src/images/qt-embedded-linux-architecture.png | Bin 22979 -> 23199 bytes 9 files changed, 223 insertions(+), 129 deletions(-) diff --git a/doc/src/development/designer-manual.qdoc b/doc/src/development/designer-manual.qdoc index ff05228..bdadcf7 100644 --- a/doc/src/development/designer-manual.qdoc +++ b/doc/src/development/designer-manual.qdoc @@ -1520,26 +1520,34 @@ \target CreatingAMenu - \table - \row - \i \inlineimage designer-creating-menu1.png - \i \inlineimage designer-creating-menu2.png - \i \bold{Creating a Menu} - - Double-click the placeholder item to begin editing. The menu text, - displayed using a line edit, can be modified. - - \row - \i \inlineimage designer-creating-menu3.png - \i \inlineimage designer-creating-menu4.png - \i Insert the required text for the new menu. Inserting an - ampersand character (&) causes the letter following it to be - used as a mnemonic for the menu. - - Press \key Return or \key Enter to accept the new text, or press - \key Escape to reject it. You can undo the editing operation later if - required. - \endtable + \raw HTML +
+ \endraw + \inlineimage designer-creating-menu1.png + \inlineimage designer-creating-menu2.png + \br + \inlineimage designer-creating-menu3.png + \inlineimage designer-creating-menu4.png + \raw HTML +
+ \endraw + + \section2 Creating a Menu + + Double-click the placeholder item to begin editing. The menu text, + displayed using a line edit, can be modified. + + Insert the required text for the new menu. Inserting an + ampersand character (&) causes the letter following it to be + used as a mnemonic for the menu. + + Press \key Return or \key Enter to accept the new text, or press + \key Escape to reject it. You can undo the editing operation later if + required. + + \raw HTML +
+ \endraw Menus can also be rearranged in the menu bar simply by dragging and dropping them in the preferred location. A vertical red line indicates the @@ -1550,31 +1558,40 @@ navigating the menu structure in the usual way. \target CreatingAMenuEntry + \raw HTML +
+ \endraw + \inlineimage designer-creating-menu-entry1.png + \inlineimage designer-creating-menu-entry2.png + \br + \inlineimage designer-creating-menu-entry3.png + \inlineimage designer-creating-menu-entry4.png + \raw HTML +
+ \endraw \table - \row - \i \inlineimage designer-creating-menu-entry1.png - \i \inlineimage designer-creating-menu-entry2.png - \i \bold{Creating a Menu Entry} - Double-click the \gui{new action} placeholder to begin editing, or - double-click \gui{new separator} to insert a new separator line after - the last entry in the menu. + \section2 Creating a Menu Entry - The menu entry's text is displayed using a line edit, and can be - modified. + Double-click the \gui{new action} placeholder to begin editing, or + double-click \gui{new separator} to insert a new separator line after + the last entry in the menu. - \row - \i \inlineimage designer-creating-menu-entry3.png - \i \inlineimage designer-creating-menu-entry4.png - \i Insert the required text for the new entry, optionally using - the ampersand character (&) to mark the letter to use as a - mnemonic for the entry. + The menu entry's text is displayed using a line edit, and can be + modified. - Press \key Return or \key Enter to accept the new text, or press - \key Escape to reject it. The action created for this menu entry will - be accessible via the \l{#TheActionEditor}{Action Editor}, and any - associated keyboard shortcut can be set there. - \endtable + Insert the required text for the new entry, optionally using + the ampersand character (&) to mark the letter to use as a + mnemonic for the entry. + + Press \key Return or \key Enter to accept the new text, or press + \key Escape to reject it. The action created for this menu entry will + be accessible via the \l{#TheActionEditor}{Action Editor}, and any + associated keyboard shortcut can be set there. + + \raw HTML +
+ \endraw Just like with menus, entries can be moved around simply by dragging and dropping them in the preferred location. When an entry is dragged over a @@ -1582,53 +1599,92 @@ menu entries are based on actions, they can also be dropped onto toolbars, where they will be displayed as toolbar buttons. - \section1 Toolbars + \raw HTML +
+ \endraw + \inlineimage designer-creating-toolbar.png + \raw HTML +
+ \endraw - ### SCREENSHOT + \section2 Creating and Removing a Toolbar - Toolbars ared added to a main window in a similar way to the menu bar: + Toolbars are added to a main window in a similar way to the menu bar: Select the \gui{Add Tool Bar} option from the form's context menu. Alternatively, if there is an existing toolbar in the main window, you can click the arrow on its right end to create a new toolbar. - Toolbar buttons are created using the action system to populate each - toolbar, rather than by using specific button widgets from the widget box. - Since actions can be represented by menu entries and toolbar buttons, they - can be moved between menus and toolbars. To share an action between a menu - and a toolbar, drag its icon from the \l{#TheActionEditor}{Action Editor} - to the toolbar rather than from the menu where its entry is located. + Toolbars are removed from the form via an entry in the toolbar's context + menu. + + \raw HTML +
+ \endraw - New actions for menus and toolbars can be created in the - \l{#TheActionEditor}{Action Editor}. + \section2 Adding and Removing Toolbar Buttons + Toolbar buttons are created as actions in the + \l{#TheActionEditor}{Action Editor} and dragged onto the toolbar. + Since actions can be represented by menu entries and toolbar buttons, + they can be moved between menus and toolbars. + + \target AddingAnAction + \raw HTML +
+ \endraw + \inlineimage designer-adding-toolbar-action.png + \inlineimage designer-removing-toolbar-action.png + \raw HTML +
+ \endraw + + To share an action between a menu and a toolbar, drag its icon from the + action editor to the toolbar rather than from the menu where its entry is + located. See \l{#Adding an Action}{Adding an Action} for more information + about this process. + + Toolbar buttons are removed via the toolbar's context menu. + + \raw HTML +
+ \endraw \section1 Actions With the menu bar and the toolbars in place, it's time to populate them - with action: \QD provides an action editor to simplify the creation and - management of actions. - + with actions. New actions for both menus and toolbars are created in the + action editor window, simplifying the creation and management of actions. \target TheActionEditor - \table - \row - \i \inlineimage designer-action-editor.png - \i \bold{The Action Editor} + \raw HTML +
+ \endraw + \inlineimage designer-action-editor.png + \raw HTML +
+ \endraw - Enable the action editor by opening the \gui Tools menu, and switching - on the \gui{Action Editor} option. + \section2 The Action Editor - The action editor allows you to create \gui New actions and \gui Delete - actions. It also provides a search function, \gui Filter, using the - action's text. + Enable the action editor by opening the \gui Tools menu, and switching + on the \gui{Action Editor} option. - \QD's action editor can be viewed in the classic \gui{Icon View} and - \gui{Detailed View}. The screenshot below shows the action editor in - \gui{Detailed View}. You can also copy and paste actions between menus, - toolbars and forms. - \endtable + The action editor allows you to create \gui New actions and \gui Delete + actions. It also provides a search function, \gui Filter, using the + action's text. + + \QD's action editor can be viewed in the classic \gui{Icon View} and + \gui{Detailed View}. The screenshot below shows the action editor in + \gui{Detailed View}. You can also copy and paste actions between menus, + toolbars and forms. + + \raw HTML +
+ \endraw + + \section2 Creating an Action To create an action, use the action editor's \gui New button, which will then pop up an input dialog. Provide the new action with a \gui Text -- @@ -1641,23 +1697,33 @@ Once the action is created, it can be used wherever actions are applicable. + \raw HTML +
+ \endraw \target AddingAnAction - \table - \row - \i \inlineimage designer-adding-menu-action.png - \i \inlineimage designer-adding-toolbar-action.png - \i \bold{Adding an Action} + \raw HTML +
+ \endraw + \inlineimage designer-adding-menu-action.png + \inlineimage designer-adding-toolbar-action.png + \raw HTML +
+ \endraw - To add an action to a menu or a toolbar, simply press the left mouse - button over the action in the action editor, and drag it to the - preferred location. + \section2 Adding an Action - \QD provides highlighted guide lines that tell you where the action - will be added. Release the mouse button to add the action when you have - found the right spot. - \endtable + To add an action to a menu or a toolbar, simply press the left mouse + button over the action in the action editor, and drag it to the + preferred location. + + \QD provides highlighted guide lines that tell you where the action + will be added. Release the mouse button to add the action when you have + found the right spot. + \raw HTML +
+ \endraw \section1 Dock Widgets @@ -1668,21 +1734,29 @@ and choose an appropriate value for its \gui{dockWidgetArea} property. \target AddingADockWidget - \table - \row - \i \inlineimage designer-adding-dockwidget.png - \i \bold{Adding a Dock Widget} - To add a dock widget, simply drag one from the \gui Containers section - of the widget box, and drop it onto the main form area. Just like other - widgets, its properties can be modified with the \gui{Property Editor}. + \raw HTML +
+ \endraw + \inlineimage designer-adding-dockwidget.png + \raw HTML +
+ \endraw - Dock widgets can be optionally floated as indpendent tool windows. - Hence, it is useful to give them window titles by setting their - \gui{windowTitle} property. This also helps to identify them on the - form. + \section2 Adding a Dock Widget - \endtable + To add a dock widget, simply drag one from the \gui Containers section + of the widget box, and drop it onto the main form area. Just like other + widgets, its properties can be modified with the \gui{Property Editor}. + + Dock widgets can be optionally floated as indpendent tool windows. + Hence, it is useful to give them window titles by setting their + \gui{windowTitle} property. This also helps to identify them on the + form. + + \raw HTML +
+ \endraw */ diff --git a/doc/src/diagrams/designer-manual/designer-adding-toolbar-action1.png b/doc/src/diagrams/designer-manual/designer-adding-toolbar-action1.png index 6b82373..4d28722 100644 Binary files a/doc/src/diagrams/designer-manual/designer-adding-toolbar-action1.png and b/doc/src/diagrams/designer-manual/designer-adding-toolbar-action1.png differ diff --git a/doc/src/diagrams/qtopiacore/qt-embedded-linux-architecture.sk b/doc/src/diagrams/qtopiacore/qt-embedded-linux-architecture.sk index ee60589..3c00b17 100644 --- a/doc/src/diagrams/qtopiacore/qt-embedded-linux-architecture.sk +++ b/doc/src/diagrams/qtopiacore/qt-embedded-linux-architecture.sk @@ -295,6 +295,9 @@ txt('Graphics',(222.876,42.6)) G_() fp((1,1,1)) Fn('Helvetica') -txt('Qt for Embedded Linux',(85.802,85.126)) +txt('Qt for Embedded Linux',(85.802,86.934)) +le() +lw(1) +r(280,0,0,-125,7.5,157.5) guidelayer('Guide Lines',1,0,0,1,(0,0,1)) grid((0,0,2.5,2.5),1,(0,0,1),'Grid') diff --git a/doc/src/frameworks-technologies/gestures.qdoc b/doc/src/frameworks-technologies/gestures.qdoc index a0eab21..b9b7771 100644 --- a/doc/src/frameworks-technologies/gestures.qdoc +++ b/doc/src/frameworks-technologies/gestures.qdoc @@ -63,16 +63,16 @@ QPanGesture, QPinchGesture, and QSwipeGesture. These standard classes are ready to use, and each exposes functions and properties that give gesture-specific information about the user's - input. This is described in the section \l{Using Standard Gestures - With Widgets}. + input. This is described in the \l{Using Standard Gestures With Widgets} + section. QGesture is also designed to be subclassed and extended so that support for new gestures can be implemented by developers. Adding support for a new gesture involves implementing code to recognize - the gesture from incoming events. This is described in the section - \l{Creating Your Own Gesture Recognizer}. + the gesture from incoming events. This is described in the + \l{Creating Your Own Gesture Recognizer} section. - \section1 Using Standard Gestures With Widgets + \section1 Using Standard Gestures with Widgets Gesture objects are applied directly to widgets and other controls that accept user input \mdash these are the \e{target objects}. When a gesture object is @@ -91,11 +91,10 @@ \snippet examples/gestures/imageviewer/imagewidget.cpp connect swipe gesture - Here, the \l{QGesture::} {triggered()} signal is used to inform - the application that a gesture was used. More precise monitoring - of a gesture can be implemented by connecting its \l{QGesture::} - {started()}, \l{QGesture::} {canceled()} and \l{QGesture::} - {finished()} signals to slots. + Here, the \l{QGesture::}{triggered()} signal is used to inform the application + that a gesture was used. More precise monitoring of a gesture can be implemented + by connecting its \l{QGesture::}{started()}, \l{QGesture::}{canceled()} and + \l{QGesture::}{finished()} signals to slots. Responding to a signal is simply a matter of obtaining the gesture that sent it and examining the information it contains. @@ -132,9 +131,18 @@ likely scenario. To find how to connect a source of events to automatically feed into the recognizer see the QGesture documentation. - Recognizers based on QGesture can emit any of the following signals: + Recognizers based on QGesture can emit any of the following signals to + indicate their progress in recognizing user input: - \snippet doc/src/snippets/gestures/qgesture.h qgesture-signals + \list + \o \l{QGesture::}{triggered()} is emitted when a gesture is recognized. + \o \l{QGesture::}{started()} indicates that the gesture object has started + to recognize user input. + \o \l{QGesture::}{finished()} is emitted when the gesture object has + recognized the user input as a gesture, and finished handling it. + \o \l{QGesture::}{canceled()} indicates that the gesture was canceled, + either by the user or by the application. + \endlist These signals are emitted when the state changes with the call to \l{QGesture::}{updateState()}, more than one signal may @@ -224,8 +232,4 @@ \o The signals are caught by the defined slots in ImageWidget \o The widget logic changes and an update() results in a paint event. \endlist - - - */ - diff --git a/doc/src/getting-started/examples.qdoc b/doc/src/getting-started/examples.qdoc index 81a8363..1ed1b30 100644 --- a/doc/src/getting-started/examples.qdoc +++ b/doc/src/getting-started/examples.qdoc @@ -1051,7 +1051,7 @@ \previouspage State Machine Examples \contentspage Qt Examples - \nextpage Qt for Embedded Linux Examples + \nextpage Gestures Examples \image animation-examples.png Animation @@ -1066,10 +1066,40 @@ */ /*! + \page examples-gestures.html + \title Gestures Examples + + \previouspage Animation Framework Examples + \contentspage Qt Examples + \nextpage D-Bus Examples + + \list + \o \l{gestures/imageviewer}{Image Viewer} + \endlist +*/ + +/*! + \page examples-dbus.html + \title D-Bus Examples + + \previouspage Gestures Examples + \contentspage Qt Examples + \nextpage Qt for Embedded Linux Examples + + \list + \o \l{dbus/dbus-chat}{Chat} + \o \l{dbus/complexpingpong}{Complex Ping Pong} + \o \l{dbus/listnames}{List Names} + \o \l{dbus/pingpong}{Ping Pong} + \o \l{dbus/remotecontrolledcar}{Remote Controlled Car} + \endlist +*/ + +/*! \page examples-embeddedlinux.html \title Qt for Embedded Linux Examples - \previouspage Animation Framework Examples + \previouspage D-Bus Examples \contentspage Qt Examples \nextpage ActiveQt Examples @@ -1094,7 +1124,7 @@ \previouspage Qt for Embedded Linux Examples \contentspage Qt Examples - \nextpage D-Bus Examples + \nextpage Qt Quarterly \image activeqt-examples.png ActiveQt @@ -1111,20 +1141,3 @@ \o \l{activeqt/wrapper}{Wrapper}\raisedaster \endlist */ - -/*! - \page examples-dbus.html - \title D-Bus Examples - - \previouspage ActiveQt Examples - \contentspage Qt Examples - \nextpage Qt Quarterly - - \list - \o \l{dbus/dbus-chat}{Chat} - \o \l{dbus/complexpingpong}{Complex Ping Pong} - \o \l{dbus/listnames}{List Names} - \o \l{dbus/pingpong}{Ping Pong} - \o \l{dbus/remotecontrolledcar}{Remote Controlled Car} - \endlist -*/ diff --git a/doc/src/images/designer-action-editor.png b/doc/src/images/designer-action-editor.png index 7d17573..1e99706 100644 Binary files a/doc/src/images/designer-action-editor.png and b/doc/src/images/designer-action-editor.png differ diff --git a/doc/src/images/designer-adding-menu-action.png b/doc/src/images/designer-adding-menu-action.png index cf2a9c9..595dd8e 100644 Binary files a/doc/src/images/designer-adding-menu-action.png and b/doc/src/images/designer-adding-menu-action.png differ diff --git a/doc/src/images/designer-adding-toolbar-action.png b/doc/src/images/designer-adding-toolbar-action.png index e2201cb..404ad0d 100644 Binary files a/doc/src/images/designer-adding-toolbar-action.png and b/doc/src/images/designer-adding-toolbar-action.png differ diff --git a/doc/src/images/qt-embedded-linux-architecture.png b/doc/src/images/qt-embedded-linux-architecture.png index abf5bd8..b5e3b6c 100644 Binary files a/doc/src/images/qt-embedded-linux-architecture.png and b/doc/src/images/qt-embedded-linux-architecture.png differ -- cgit v0.12