update the api docu to note the use of disabled actions to mean something is informational only
svn path=/trunk/KDE/kdebase/workspace/plasma/lib/; revision=638494
This commit is contained in:
parent
2bfbce6618
commit
7e79ae5347
12
runner.h
12
runner.h
@ -45,6 +45,8 @@ class KDE_EXPORT Runner : public QObject
|
|||||||
* default runner. Other runner's actions will be suggested in the
|
* default runner. Other runner's actions will be suggested in the
|
||||||
* interface. Non-exact matches should be offered via findMatches.
|
* interface. Non-exact matches should be offered via findMatches.
|
||||||
* The action will be activated if the user selects it.
|
* The action will be activated if the user selects it.
|
||||||
|
* If the action is informational only and should not be executed,
|
||||||
|
* disable the action with setEnabled( false ).
|
||||||
*/
|
*/
|
||||||
QAction* exactMatch( const QString& command );
|
QAction* exactMatch( const QString& command );
|
||||||
|
|
||||||
@ -63,10 +65,10 @@ class KDE_EXPORT Runner : public QObject
|
|||||||
|
|
||||||
KActionCollection* matches( const QString& term, int max, int offset );
|
KActionCollection* matches( const QString& term, int max, int offset );
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Static method is called to load and get a list available of Runners.
|
* Static method is called to load and get a list available of Runners.
|
||||||
*/
|
*/
|
||||||
static List loadRunners( QWidget* parent );
|
static List loadRunners( QWidget* parent );
|
||||||
|
|
||||||
signals:
|
signals:
|
||||||
/**
|
/**
|
||||||
@ -82,6 +84,8 @@ class KDE_EXPORT Runner : public QObject
|
|||||||
* This method is called when there is text input to match. The runner
|
* This method is called when there is text input to match. The runner
|
||||||
* should fill the matches action collection with one action per match
|
* should fill the matches action collection with one action per match
|
||||||
* to a maximium of max matches starting at offset in the data set
|
* to a maximium of max matches starting at offset in the data set
|
||||||
|
* If the action is informational only and should not be executed,
|
||||||
|
* disable the action with setEnabled( false ).
|
||||||
*/
|
*/
|
||||||
virtual void fillMatches( KActionCollection* matches,
|
virtual void fillMatches( KActionCollection* matches,
|
||||||
const QString& term,
|
const QString& term,
|
||||||
|
Loading…
Reference in New Issue
Block a user