diff options
Diffstat (limited to 'Mainpage.dox')
| -rw-r--r-- | Mainpage.dox | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Mainpage.dox b/Mainpage.dox index 1f69da9c2..0ee4ab5f3 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -1,35 +1,35 @@ /** -\mainpage Polkit-tqt-1 - TQt wrapper around polkit-1 +\mainpage Polkit-tqt - TQt wrapper around polkit-1 -\section polkittqt1_overview Overview +\section polkit-tqt_overview Overview -polkit-tqt-1 aims to make it easy for TQt developers to take advantage of +polkit-tqt aims to make it easy for TQt developers to take advantage of polkit API. It is a convenience wrapper around QAction and QAbstractButton that lets you integrate those two components easily with polkit. -polkit-tqt-1 is split in three libraries: polkit-tqt-core-1, polkit-tqt-gui-1 and polkit-tqt-agent-1 +polkit-tqt is split in three libraries: polkit-tqt-core, polkit-tqt-gui and polkit-tqt-agent -\b polkit-tqt-core-1 lets you control actions and authentication without a GUI, with some very +\b polkit-tqt-core lets you control actions and authentication without a GUI, with some very simple functions. It also lets you retrieve and control useful informations on the polkit authority. You will be mostly interested in the \c Authority class. -\b polkit-tqt-gui-1 lets you easily associate GUI items with polkit actions. Through some simple +\b polkit-tqt-gui lets you easily associate GUI items with polkit actions. Through some simple wrapper classes you are able to associate QAction and QAbstractButton to a polkit action, and get their properties changed accordingly to polkit's result. It includes the classes Action, ActionButton and ActionButtons -\b polkit-tqt-agent-1 lets you write your own polkit authentication agents in a very simple way. +\b polkit-tqt-agent lets you write your own polkit authentication agents in a very simple way. -\li A sample usage of polkit-tqt-1 can be found in \ref polkittqt1_example +\li A sample usage of polkit-tqt can be found in \ref polkittqt1_example \li <a href="classes.html">Alphabetical Class List</a> \li <a href="hierarchy.html">Class Hierarchy</a> -\page polkittqt1_example Polkit-tqt-1 usage example +\page polkittqt1_example Polkit-tqt usage example -You can find an example usage of Polkit-tqt-1 in the examples/ dir. You can +You can find an example usage of Polkit-tqt in the examples/ dir. You can build it by passing \c -DBUILD_EXAMPLES=TRUE to your cmake line. The structure consists of a .ui file and a main class, to demonstrate how easy it is to integrate polkit support in an existing application. Let's see some details about it: @@ -85,12 +85,12 @@ with even more ease, just by manually connecting the signal to ActionButton::act to understand why this connection doesn't happen automatically), and Action::authorized() signal notifies you when polkit has authorized you to perform the action. -As you can see, usage of polkit-tqt-1 is extremely simple. Have a look at the complete example +As you can see, usage of polkit-tqt is extremely simple. Have a look at the complete example and to the API Docs for more details. */ // DOXYGEN_PROJECTVERSION=0.96.1 -// DOXYGEN_PROJECTNAME=polkittqt-1 +// DOXYGEN_PROJECTNAME=polkittqt // DOXYGEN_ENABLE=YES |