Constructor, destructor and setting of 'active' flag
Detailed Description
The functions in this section are used for general administration of this CRYPTPLUG wrapper class and for maintaining a separate
active
flag for environments using more than one CRYPTPLUG library simultaneously.
Function Documentation
CryptPlugWrapper::CryptPlugWrapper |
( |
const QString & |
name = QString::null , |
|
|
const QString & |
libName = QString::null , |
|
|
const QString & |
update = QString::null , |
|
|
bool |
active = false |
|
) |
[inherited] |
|
|
Constructor of CRYPTPLUG wrapper class.
This constructor does not call the initialize() method but just stores some information for later use.
- Note:
- Since more than one crypto plug-in might be specified (using multiple instances of the warpper class) it is necessary to set
active at least one them. Only wrappers that have been activated may be initialized or configured or used to perform crypto actions.
- Parameters:
-
| parent | The parent widget to be used for displaying dialogs. If this parameter is NULL the desktop is used as the dialogs' parent widget. |
| name | The external name that is visible in lists, messages, etc. |
| libName | Complete path+name of CRYPTPLUG library that is to be used by this instance of CryptPlugWrapper. |
| update | the URL from where updates can be downloaded |
| active | Specify whether the relative library is to be used or not. |
- See also:
- ~CryptPlugWrapper, setActive, active, initialize, deinitialize
initStatus
Definition at line 769 of file cryptplugwrapper.cpp. |
void CryptPlugWrapper::setActive |
( |
bool |
active |
) |
[inherited] |
|
|
Set this CRYPTPLUG wrapper's internal active flag.
Since more than one crypto plug-in might be specified (using multiple instances of the warpper class) it is necessary to set active at least one them. Only wrappers that have been activated may be initialized or configured or used to perform crypto actions.
This flag may be set in the constructor or by calling setActive().
- Note:
- Deactivating does not mean resetting the internal structures - if just prevents the normal functions from being called erroneously. When deactivated only the following functions are operational: constructor , destructor , setActive , active, setLibName , libName , initStatus; calling other functions will be ignored and their return values will be undefined.
- Parameters:
-
| active | Specify whether the relative library is to be used or not. |
- See also:
- active, CryptPlugWrapper(), ~CryptPlugWrapper
deinitialize, initialize, initStatus
Definition at line 794 of file cryptplugwrapper.cpp. |
bool CryptPlugWrapper::active |
( |
|
) |
const [inherited] |
|
|
Returns this CRYPTPLUG wrapper's internal active flag.
- Returns:
- whether the relative library is to be used or not.
- See also:
- setActive
Definition at line 800 of file cryptplugwrapper.cpp. |
bool CryptPlugWrapper::setLibName |
( |
const QString & |
libName |
) |
[inherited] |
|
|
Set the CRYPTPLUG library name.
Complete path+name of CRYPTPLUG library that is to be used by this instance of CryptPlugWrapper.
This name may be set in the constructor or by calling setLibName().
- Note:
- Setting/changing the library name may only be done when the initStatus() is not
InitStatus_Ok . If you want to change the name of the library after successfully having called initialize() please make sure to unload it by calling the deinitialize() function.
- Parameters:
-
| libName | libName Complete path+name of CRYPTPLUG library that is to be used by this CryptPlugWrapper. |
- Returns:
- whether the library name could be changed; library name can only be changed when library is not initialized - see above 'note'.
- See also:
- libName, CryptPlugWrapper(), ~CryptPlugWrapper
deinitialize, initialize, initStatus
Definition at line 807 of file cryptplugwrapper.cpp. |
QString CryptPlugWrapper::libName |
( |
|
) |
const [inherited] |
|
|
Returns the CRYPTPLUG library name.
- Returns:
- the complete path+name of CRYPTPLUG library that is to be used by this instance of CryptPlugWrapper.
- See also:
- setLibName
Definition at line 815 of file cryptplugwrapper.cpp. |
void CryptPlugWrapper::setDisplayName |
( |
const QString & |
name |
) |
[inherited] |
|
|
Specifies the external name that is visible in lists, messages, etc.
Definition at line 829 of file cryptplugwrapper.cpp. |
QString CryptPlugWrapper::displayName |
( |
|
) |
const [inherited] |
|
|
Returns the external name.
- Returns:
- the external name used for display purposes
Definition at line 835 of file cryptplugwrapper.cpp. |
QString CryptPlugWrapper::libVersion |
( |
|
) |
const [inherited] |
|
|
Returns the version string of the CRYPTPLUG library specified in the constructor.
- Returns:
- the version string of the CRYPTPLUG library specified in the constructor
Definition at line 694 of file cryptplugwrapper.cpp. |
QString CryptPlugWrapper::updateURL |
( |
|
) |
const [inherited] |
|
void CryptPlugWrapper::setUpdateURL |
( |
const QString & |
url |
) |
[inherited] |
|
This file is part of the documentation for certmanager Library Version 3.3.0.