summaryrefslogtreecommitdiff
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiesecurity/multiauthpassword.cpp11
-rw-r--r--libopie2/opiesecurity/multiauthpassword.h4
2 files changed, 7 insertions, 8 deletions
diff --git a/libopie2/opiesecurity/multiauthpassword.cpp b/libopie2/opiesecurity/multiauthpassword.cpp
index b793717..42341f7 100644
--- a/libopie2/opiesecurity/multiauthpassword.cpp
+++ b/libopie2/opiesecurity/multiauthpassword.cpp
@@ -69,22 +69,21 @@ bool MultiauthPassword::needToAuthenticate(bool at_poweron)
69 return false; 69 return false;
70} 70}
71 71
72 72
73/** 73/**
74 * \brief Require user authentication to unlock and continue 74 * \brief Require user authentication to unlock and continue
75 * 75 *
76 * This method will check if you require authentication 76 * This method will check if you require authentication
77 * and then will lock the screen and require a succesfull 77 * and then will lock the screen and ask for a successful
78 * authentication. 78 * authentication (explaining what it does or not, depending
79 * Authenticate may enter the event loop and only returns 79 * on your local configuration).
80 * if the user sucesfully authenticated to the system. 80 * It may go into an event loop, but anyhow it will only end
81 * 81 * when the user has successfully authenticated to the system.
82 * @return only if succesfully authenticated
83 */ 82 */
84void MultiauthPassword::authenticate(bool at_poweron) 83void MultiauthPassword::authenticate(bool at_poweron)
85{ 84{
86 if ( ! needToAuthenticate(at_poweron) ) 85 if ( ! needToAuthenticate(at_poweron) )
87 return; 86 return;
88 87
89 /* Constructs the main window, which displays messages and blocks 88 /* Constructs the main window, which displays messages and blocks
90 * access to the desktop 89 * access to the desktop
diff --git a/libopie2/opiesecurity/multiauthpassword.h b/libopie2/opiesecurity/multiauthpassword.h
index f43934d..fe276da 100644
--- a/libopie2/opiesecurity/multiauthpassword.h
+++ b/libopie2/opiesecurity/multiauthpassword.h
@@ -34,21 +34,21 @@
34 34
35#ifndef OPIE_SEC_MULTIAUTHPASSWORD_H 35#ifndef OPIE_SEC_MULTIAUTHPASSWORD_H
36#define OPIE_SEC_MULTIAUTHPASSWORD_H 36#define OPIE_SEC_MULTIAUTHPASSWORD_H
37 37
38namespace Opie { 38namespace Opie {
39namespace Security { 39namespace Security {
40 40
41/** 41/**
42 * This is the dropin replacement for libqpes Password class. 42 * This is the dropin replacement for the libqpe Password class.
43 * If you call authenticate() a widget will cover the whole screen 43 * If you call authenticate() a widget will cover the whole screen
44 * and only return if the user is able to authenticate with any of the 44 * and only return if the user is able to authenticate with any of the
45 * configured Authentication Plugins. 45 * configured Authentication Plugins.
46 * This uses the \sa Opie::Security::MultiauthMainWindow internally. 46 * It uses the Opie::Security::MultiauthMainWindow QDialog internally.
47 * 47 *
48 * @author Clement Séveillac, Holger Freyther 48 * @author Clement Séveillac, Holger Freyther
49 */ 49 */
50class MultiauthPassword { 50class MultiauthPassword {
51public: 51public:
52 static bool needToAuthenticate( bool atpoweron = false ); 52 static bool needToAuthenticate( bool atpoweron = false );
53 static void authenticate(bool atpoweron = false); 53 static void authenticate(bool atpoweron = false);
54}; 54};