QGIS/python/gui/qgspasswordlineedit.sip
Larry Shaffer 921a0c75e3 Updates to QgsPasswordLineEdit
- Add public func to set password visibility (instead of exposing slot)
- Add initial password visibility param; default to obfuscated (false)
- Fix bug where initial visibility was true, but show/hide was opposite
- Add generic tool tips to show/hide action
2017-03-17 16:33:40 -06:00

33 lines
809 B
Plaintext

/** \class QgsPasswordLineEdit
* \ingroup gui
* QLineEdit subclass with built in support for showing/hiding
* entered password.
* @note added in QGIS 3.0
**/
class QgsPasswordLineEdit : QLineEdit
{
%TypeHeaderCode
#include <qgspasswordlineedit.h>
%End
public:
/** Constructor for QgsPasswordLineEdit.
* @param parent parent widget
*/
QgsPasswordLineEdit( QWidget *parent = nullptr );
/** Define if a lock icon shall be shown on the left of the widget
* @param visible set to false to hide the lock icon
*/
void setShowLockIcon( bool visible );
/** Returns if a lock icon shall be shown on the left of the widget
*/
bool showLockIcon() const;
/** Set state of the password's visibility
*/
void setPasswordVisibility( bool visible );
};