MessageComposer::RecipientLineNG Class
The RecipientLineNG class. More...
| Header: | #include <MessageComposer/RecipientLine> |
| CMake: | find_package(KPim6MessageComposer REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::MessageComposer) |
Public Functions
| RecipientLineNG(QWidget *parent) | |
| virtual | ~RecipientLineNG() override |
| bool | enableAkonadiSearch() const |
| bool | enableIndexSearch() const |
| QString | rawData() const |
| QSharedPointer<MessageComposer::Recipient> | recipient() const |
| MessageComposer::Recipient::Type | recipientType() const |
| int | recipientsCount() const |
| void | setEnableAkonadiSearch(bool enableAkonadiSearch) |
| void | setEnableIndexSearch(bool enableIndexSearch) |
| void | setIcon(const QIcon &icon, const QString &tooltip = QString()) |
| void | setRecipientType(MessageComposer::Recipient::Type) |
Reimplemented Public Functions
| virtual void | activate() override |
| virtual bool | canDeleteLineEdit() const override |
| virtual void | clear() override |
| virtual void | clearModified() override |
| virtual KPIM::MultiplyingLineData::Ptr | data() const override |
| virtual void | fixTabOrder(QWidget *previous) override |
| virtual bool | isActive() const override |
| virtual bool | isEmpty() const override |
| virtual bool | isModified() const override |
| virtual int | setColumnWidth(int w) override |
| virtual void | setCompletionMode(KCompletion::CompletionMode mode) override |
| virtual void | setData(const KPIM::MultiplyingLineData::Ptr &data) override |
| virtual QWidget * | tabOut() const override |
Signals
| void | activeChanged() |
| void | addRecipient(MessageComposer::RecipientLineNG *, const QString &) |
| void | countChanged() |
| void | iconClicked() |
| void | typeModified(MessageComposer::RecipientLineNG *) |
Reimplemented Protected Functions
| virtual bool | eventFilter(QObject *watched, QEvent *event) override |
Protected Slots
| void | analyzeLine(const QString &) |
| void | slotEditingFinished() |
| void | slotTypeModified() |
Detailed Description
Member Function Documentation
[explicit] RecipientLineNG::RecipientLineNG(QWidget *parent)
Constructs a RecipientLineNG widget. parent The parent widget.
[override virtual noexcept default] RecipientLineNG::~RecipientLineNG()
Destroys the RecipientLineNG.
[override virtual] void RecipientLineNG::activate()
Activates the recipient line for input.
[signal] void RecipientLineNG::activeChanged()
Emitted when the active state changes.
[signal] void RecipientLineNG::addRecipient(MessageComposer::RecipientLineNG *, const QString &)
Emitted when a recipient should be added. line The recipient line. recipient The recipient address to add.
[protected slot] void RecipientLineNG::analyzeLine(const QString &)
Analyzes the recipient line content and updates the data. text The text content to analyze.
[override virtual] bool RecipientLineNG::canDeleteLineEdit() const
Returns whether this line can be deleted.
[override virtual] void RecipientLineNG::clear()
Clears the contents of the recipient line.
[override virtual] void RecipientLineNG::clearModified()
Clears the modified flag.
[signal] void RecipientLineNG::countChanged()
Emitted when the recipient count changes.
[override virtual] KPIM::MultiplyingLineData::Ptr RecipientLineNG::data() const
Returns the recipient data for this line.
See also setData().
bool RecipientLineNG::enableAkonadiSearch() const
Returns whether Akonadi search is enabled.
See also setEnableAkonadiSearch().
bool RecipientLineNG::enableIndexSearch() const
Returns whether index search is enabled.
See also setEnableIndexSearch().
[override virtual protected] bool RecipientLineNG::eventFilter(QObject *watched, QEvent *event)
Filters events for the recipient line widgets. watched The object that the event is coming from. event The event to process. Returns True if the event was handled, false otherwise.
[override virtual] void RecipientLineNG::fixTabOrder(QWidget *previous)
Sets up the tab order for recipient input. previous The previous widget in the tab order.
[signal] void RecipientLineNG::iconClicked()
Emitted when the icon is clicked.
[override virtual] bool RecipientLineNG::isActive() const
Returns whether the recipient line is currently active.
[override virtual] bool RecipientLineNG::isEmpty() const
Returns whether the recipient line is empty.
[override virtual] bool RecipientLineNG::isModified() const
Returns whether the recipient line content has been modified.
QString RecipientLineNG::rawData() const
Returns the raw recipient data as a string.
QSharedPointer<MessageComposer::Recipient> RecipientLineNG::recipient() const
Returns the recipient data object.
MessageComposer::Recipient::Type RecipientLineNG::recipientType() const
Returns the type of recipients in this line.
See also setRecipientType().
int RecipientLineNG::recipientsCount() const
Returns the number of recipients in this line.
[override virtual] int RecipientLineNG::setColumnWidth(int w)
Sets the column width for the recipient line. w The desired width in pixels. Returns The actual width set.
[override virtual] void RecipientLineNG::setCompletionMode(KCompletion::CompletionMode mode)
Sets the completion mode for recipient address completion. mode The completion mode to use.
[override virtual] void RecipientLineNG::setData(const KPIM::MultiplyingLineData::Ptr &data)
Sets the recipient data for this line. data The recipient data pointer.
See also data().
void RecipientLineNG::setEnableAkonadiSearch(bool enableAkonadiSearch)
Enables or disables Akonadi search for recipient lookup. enableAkonadiSearch True to enable Akonadi search, false otherwise.
See also enableAkonadiSearch().
void RecipientLineNG::setEnableIndexSearch(bool enableIndexSearch)
Enables or disables index search for recipient lookup. enableIndexSearch True to enable index search, false otherwise.
See also enableIndexSearch().
void RecipientLineNG::setIcon(const QIcon &icon, const QString &tooltip = QString())
Sets the icon displayed for this recipient line. icon The icon to display. tooltip Optional tooltip text for the icon.
void RecipientLineNG::setRecipientType(MessageComposer::Recipient::Type)
Sets the type of recipients (To, Cc, Bcc). type The recipient type.
See also recipientType().
[protected slot] void RecipientLineNG::slotEditingFinished()
Called when editing of the recipient line is finished.
[protected slot] void RecipientLineNG::slotTypeModified()
Called when the recipient type has been modified.
[override virtual] QWidget *RecipientLineNG::tabOut() const
Returns the widget to tab out to next.
[signal] void RecipientLineNG::typeModified(MessageComposer::RecipientLineNG *)
Emitted when the recipient type is modified. line The recipient line that was modified.