qt5base-lts/examples/widgets/doc/twowaybutton.qdoc
Gabriel de Dietrich 806dda08d6 Moving .qdoc files under examples/widgets/doc
Updated those .qdoc files to refer to the new relative examples
emplacement. Images and snippets to be moved later.

Also grouped all widgets related examples under widgets.

Change-Id: Ib29696e2d8948524537f53e8dda88f9ee26a597f
Reviewed-by: J-P Nurmi <j-p.nurmi@nokia.com>
2012-08-20 12:20:55 +02:00

69 lines
2.2 KiB
Plaintext

/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\example statemachine/twowaybutton
\title Two-way Button Example
The Two-way button example shows how to use \l{The State Machine
Framework} to implement a simple state machine that toggles the current
state when a button is clicked.
\snippet statemachine/twowaybutton/main.cpp 0
The application's main() function begins by constructing the application
object, a button and a state machine.
\snippet statemachine/twowaybutton/main.cpp 1
The state machine has two states; \c on and \c off. When either state is
entered, the text of the button will be set accordingly.
\snippet statemachine/twowaybutton/main.cpp 2
When the state machine is in the \c off state and the button is clicked,
it will transition to the \c on state; when the state machine is in the \c
on state and the button is clicked, it will transition to the \c off
state.
\snippet statemachine/twowaybutton/main.cpp 3
The states are added to the state machine; they become top-level (sibling)
states.
\snippet statemachine/twowaybutton/main.cpp 4
The initial state is \c off; this is the state the state machine will
immediately transition to once the state machine is started.
\snippet statemachine/twowaybutton/main.cpp 5
Finally, the button is resized and made visible, and the application event
loop is entered.
*/