Sailfish Crypto
API DocumentationPromptText Class
(Sailfish::Crypto::InteractionParameters::PromptText)Encapsulates a collection of labels which will be shown to the user when requesting input. More...
| Header: | #include <Crypto/interactionparameters.h> |
| Instantiated By: | PromptText |
Properties
|
|
Public Functions
| PromptText() = default | |
| PromptText(const PromptText &) = default | |
| PromptText(std::initializer_list<std::pair<InteractionParameters::Prompt, QString> > list) | |
| ~PromptText() = default | |
| QString | accept() const |
| QString | cancel() const |
| QString | instruction() const |
| QString | message() const |
| QString | newInstruction() const |
| QString | repeatInstruction() const |
| void | setAccept(const QString &label) |
| void | setCancel(const QString &label) |
| void | setInstruction(const QString &instruction) |
| void | setMessage(const QString &message) |
| void | setNewInstruction(const QString &instruction) |
| void | setRepeatInstruction(const QString &instruction) |
| bool | operator!=(const PromptText &promptText) const |
| PromptText & | operator=(const PromptText &promptText) |
| bool | operator==(const PromptText &promptText) const |
Detailed Description
Encapsulates a collection of labels which will be shown to the user when requesting input.
These strings allow overriding the default display strings in user prompts. A message explaining the reason for the prompt is typically required but others may also be specified to better suit the context of the message.
Property Documentation
accept : QString
This property holds a label for the prompt accept action.
Access functions:
| QString | accept() const |
| void | setAccept(const QString &label) |
cancel : QString
This property holds a label for the prompt cancel action.
Access functions:
| QString | cancel() const |
| void | setCancel(const QString &label) |
instruction : QString
This property holds an instruction asking the user to enter a passphrase.
Access functions:
| QString | instruction() const |
| void | setInstruction(const QString &instruction) |
message : QString
This property holds a message describing the reason for the prompt.
Access functions:
| QString | message() const |
| void | setMessage(const QString &message) |
newInstruction : QString
This property holds an instruction asking the user to enter a new passphrase.
Access functions:
| QString | newInstruction() const |
| void | setNewInstruction(const QString &instruction) |
repeatInstruction : QString
This property holds an instruction asking the user to repeat a new passphrase.
Access functions:
| QString | repeatInstruction() const |
| void | setRepeatInstruction(const QString &instruction) |
Member Function Documentation
[default] PromptText::PromptText()
Default constructs an instance of PromptText.
[default] PromptText::PromptText(const PromptText &)
Copy constructor.
PromptText::PromptText(std::initializer_list<std::pair<InteractionParameters::Prompt, QString> > list)
Default constructs an instance of PromptText.
[default] PromptText::~PromptText()
Destroys the instance of PromptText.
bool PromptText::operator!=(const PromptText &promptText) const
PromptText &PromptText::operator=(const PromptText &promptText)
Copy-assignment operator.