summaryrefslogtreecommitdiffstats
path: root/Mainpage.dox
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2021-10-31 00:13:21 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2021-10-31 00:14:22 +0900
commite8933e99b4600d91e9eab7d1ad3a2d35813028a9 (patch)
treeb2899fd1ef651a1bff56918ace94625a4bc14aa0 /Mainpage.dox
parente8494e60efeb94c67c813d1c1c038031915e8c17 (diff)
downloadpolkit-tqt-e8933e99b4600d91e9eab7d1ad3a2d35813028a9.tar.gz
polkit-tqt-e8933e99b4600d91e9eab7d1ad3a2d35813028a9.zip
More Qt->TQt conversion and some clean up.
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'Mainpage.dox')
-rw-r--r--Mainpage.dox52
1 files changed, 21 insertions, 31 deletions
diff --git a/Mainpage.dox b/Mainpage.dox
index 90b34e08b..1fceaafdd 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -1,67 +1,59 @@
/**
-\mainpage Polkit-qt-1 - Qt wrapper around polkit-1
+\mainpage Polkit-tqt-1 - TQt wrapper around polkit-1
-\section polkitqt1_overview Overview
+\section polkittqt1_overview Overview
-\note Please note that if you're developing an application on the KDE Development
- Platform and not just with Qt, you might want to use KAuth (kdelibs/core/auth)
-
-polkit-qt-1 aims to make it easy for Qt developers to take advantage of
+polkit-tqt-1 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-qt-1 is not a direct replacement of polkit-qt: it is based on polkit-1, which is not
-backwards compatible in any way with Policykit <= 0.9, which was the backend of polkit-qt.
-You are encouraged to port polkit-qt applications to polkit-qt or KAuth, if based on the KDE
-Development Platform, since PolicyKit <= 0.9 is no longer maintained.
-
-polkit-qt-1 is split in three libraries: polkit-qt-core-1, polkit-qt-gui-1 and polkit-qt-agent-1
+polkit-tqt-1 is split in three libraries: polkit-tqt-core-1, polkit-tqt-gui-1 and polkit-tqt-agent-1
-\b polkit-qt-core-1 lets you control actions and authentication without a GUI, with some very
+\b polkit-tqt-core-1 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-qt-gui-1 lets you easily associate GUI items with polkit actions. Through some simple
+\b polkit-tqt-gui-1 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-qt-agent-1 lets you write your own polkit authentication agents in a very simple way.
+\b polkit-tqt-agent-1 lets you write your own polkit authentication agents in a very simple way.
-\li A sample usage of polkit-qt-1 can be found in \ref polkitqt1_example
+\li A sample usage of polkit-tqt-1 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 polkitqt1_example Polkit-qt-1 usage example
+\page polkittqt1_example Polkit-tqt-1 usage example
-You can find an example usage of Polkit-qt-1 in the examples/ dir. You can
+You can find an example usage of Polkit-tqt-1 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:
\code
-bt = new ActionButton(kickPB, "org.qt.policykit.examples.kick", this);
+bt = new ActionButton(kickPB, "org.tqt.policykit.examples.kick", this);
bt->setText("Kick... (long)");
// here we set the behavior of PolKitResul = No
bt->setVisible(true, Action::No);
bt->setEnabled(true, Action::No);
bt->setText("Kick (long)", Action::No);
-bt->setIcon(QPixmap(":/Icons/custom-no.png"), Action::No);
+bt->setIcon(TQPixmap(":/Icons/custom-no.png"), Action::No);
bt->setToolTip("If your admin wasn't annoying, you could do this", Action::No);
// here we set the behavior of PolKitResul = Auth
bt->setVisible(true, Action::Auth);
bt->setEnabled(true, Action::Auth);
bt->setText("Kick... (long)", Action::Auth);
-bt->setIcon(QPixmap(":/Icons/action-locked-default.png"), Action::Auth);
+bt->setIcon(TQPixmap(":/Icons/action-locked-default.png"), Action::Auth);
bt->setToolTip("Only card carrying tweakers can do this!", Action::Auth);
// here we set the behavior of PolKitResul = Yes
bt->setVisible(true, Action::Yes);
bt->setEnabled(true, Action::Yes);
bt->setText("Kick! (long)", Action::Yes);
-bt->setIcon(QPixmap(":/Icons/custom-yes.png"), Action::Yes);
+bt->setIcon(TQPixmap(":/Icons/custom-yes.png"), Action::Yes);
bt->setToolTip("Go ahead, kick kick kick!", Action::Yes);
\endcode
@@ -70,10 +62,10 @@ UI file, \c kickPB . As you can see, you can set custom properties on your butto
on the action status/result. The code is mostly self-explainatory
\code
-bt = new ActionButtons(QList<QAbstractButton*>() << listenPB << listenCB,
- "org.qt.policykit.examples.listen", this);
-bt->setIcon(QPixmap(":/Icons/action-locked.png"));
-bt->setIcon(QPixmap(":/Icons/action-unlocked.png"), Action::Yes);
+bt = new ActionButtons(TQList<TQAbstractButton*>() << listenPB << listenCB,
+ "org.tqt.policykit.examples.listen", this);
+bt->setIcon(TQPixmap(":/Icons/action-locked.png"));
+bt->setIcon(TQPixmap(":/Icons/action-unlocked.png"), Action::Yes);
bt->setText("Click to make changes...");
\endcode
@@ -83,7 +75,7 @@ are kept in sync with the action.
\code
connect(bt, SIGNAL(triggered(bool)), this, SLOT(activateAction()));
-connect(bt, SIGNAL(clicked(QAbstractButton*,bool)), bt, SLOT(activate()));
+connect(bt, SIGNAL(clicked(TQAbstractButton*,bool)), bt, SLOT(activate()));
connect(bt, SIGNAL(authorized()), this, SLOT(actionActivated()));
\endcode
@@ -93,14 +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-qt-1 is extremely simple. Have a look at the complete example
+As you can see, usage of polkit-tqt-1 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=PolkitQt-1
+// DOXYGEN_PROJECTNAME=polkittqt-1
// DOXYGEN_ENABLE=YES
-
-// vim:ts=4:sw=4:expandtab:filetype=doxygen