aboutsummaryrefslogtreecommitdiff
path: root/libqmenumodel/src/qstateaction.cpp
diff options
context:
space:
mode:
authorRenato Araujo Oliveira Filho <renato.filho@canonical.com>2012-11-22 17:58:56 -0300
committerRenato Araujo Oliveira Filho <renato.filho@canonical.com>2012-11-22 17:58:56 -0300
commit41f6ce552a513644a90793a8bba15ef5761821cc (patch)
treea91e345e6cbc29b30ff08cb6055ccad33d9c80af /libqmenumodel/src/qstateaction.cpp
parenta745160b7a3460f25fa52f9902e306e071949346 (diff)
downloadqmenumodel-41f6ce552a513644a90793a8bba15ef5761821cc.tar.gz
qmenumodel-41f6ce552a513644a90793a8bba15ef5761821cc.tar.bz2
qmenumodel-41f6ce552a513644a90793a8bba15ef5761821cc.zip
Added docs on new functions.
Diffstat (limited to 'libqmenumodel/src/qstateaction.cpp')
-rw-r--r--libqmenumodel/src/qstateaction.cpp19
1 files changed, 14 insertions, 5 deletions
diff --git a/libqmenumodel/src/qstateaction.cpp b/libqmenumodel/src/qstateaction.cpp
index 18c3c81..1861aea 100644
--- a/libqmenumodel/src/qstateaction.cpp
+++ b/libqmenumodel/src/qstateaction.cpp
@@ -88,22 +88,31 @@ bool QStateAction::isValid() const
return m_valid;
}
-QString QStateAction::name() const
-{
- return m_name;
-}
-
+/*!
+ Request for the state of action to be changed to \a paramenter.
+ This call merely requests a change. The action may refuse to change its state or may change its state to something other than \a paramenter.
+*/
void QStateAction::updateState(const QVariant &parameter)
{
m_group->updateActionState(m_name, parameter);
}
+/*!
+ Activates the action passing \a parameter.
+ \a parameter must be the correct type of parameter for the action
+*/
void QStateAction::activate(const QVariant &parameter)
{
m_group->activateAction(m_name, parameter);
}
/*! \internal */
+QString QStateAction::name() const
+{
+ return m_name;
+}
+
+/*! \internal */
void QStateAction::setValid(bool valid)
{
if (m_valid != valid) {