kpimidentities
#include <signatureconfigurator.h>
Inherits QWidget.
Public Types | |
enum | ViewMode { ShowCode , ShowHtml } |
Public Member Functions | |
SignatureConfigurator (QWidget *parent=0) | |
virtual | ~SignatureConfigurator () |
QString | commandURL () const |
QString | fileURL () const |
QString | inlineText () const |
bool | isSignatureEnabled () const |
void | setCommandURL (const QString &url) |
void | setFileURL (const QString &url) |
void | setImageLocation (const Identity &identity) |
void | setImageLocation (const QString &path) |
void | setInlineText (const QString &text) |
void | setSignature (const Signature &sig) |
void | setSignatureEnabled (bool enable) |
void | setSignatureType (Signature::Type type) |
Signature | signature () const |
Signature::Type | signatureType () const |
Protected Slots | |
void | slotEdit () |
void | slotEnableEditButton (const QString &) |
void | slotSetHtml () |
Protected Attributes | |
KLineEdit * | mCommandEdit |
QPushButton * | mEditButton |
KToolBar * | mEditToolBar |
QCheckBox * | mEnableCheck |
KUrlRequester * | mFileRequester |
KToolBar * | mFormatToolBar |
QCheckBox * | mHtmlCheck |
KComboBox * | mSourceCombo |
KRichTextWidget * | mTextEdit |
Detailed Description
This widget gives an interface so users can edit their signature.
You can set a signature via setSignature(), let the user edit the signature and when done, read the signature back.
Definition at line 48 of file signatureconfigurator.h.
Member Enumeration Documentation
◆ ViewMode
Enum for the different viemodes.
Definition at line 65 of file signatureconfigurator.h.
Constructor & Destructor Documentation
◆ SignatureConfigurator()
|
explicit |
Constructor.
Definition at line 273 of file signatureconfigurator.cpp.
◆ ~SignatureConfigurator()
|
virtual |
destructor
Definition at line 279 of file signatureconfigurator.cpp.
Member Function Documentation
◆ commandURL()
QString KPIMIdentities::SignatureConfigurator::commandURL | ( | ) | const |
Returns the url of the command which the users wants to use as signature.
Definition at line 339 of file signatureconfigurator.cpp.
◆ fileURL()
QString KPIMIdentities::SignatureConfigurator::fileURL | ( | ) | const |
Returns the file url which the user wants to use as a signature.
Definition at line 322 of file signatureconfigurator.cpp.
◆ inlineText()
QString KPIMIdentities::SignatureConfigurator::inlineText | ( | ) | const |
Returns the inline text, only useful when this is the appropriate Signature::Type.
◆ isSignatureEnabled()
bool KPIMIdentities::SignatureConfigurator::isSignatureEnabled | ( | ) | const |
Indicated if the user wants a signature.
Definition at line 284 of file signatureconfigurator.cpp.
◆ setCommandURL()
void KPIMIdentities::SignatureConfigurator::setCommandURL | ( | const QString & | url | ) |
Sets url
as the command to execute.
Definition at line 344 of file signatureconfigurator.cpp.
◆ setFileURL()
void KPIMIdentities::SignatureConfigurator::setFileURL | ( | const QString & | url | ) |
Set url
for the file url part of the widget.
Definition at line 334 of file signatureconfigurator.cpp.
◆ setImageLocation() [1/2]
void KPIMIdentities::SignatureConfigurator::setImageLocation | ( | const Identity & | identity | ) |
Sets the image location to the image location of a given identity, which is emailidentities/<identity-id>/.
- Parameters
-
identity The identity whose unique ID will be used to determine the image location.
- Since
- 4.4
Definition at line 474 of file signatureconfigurator.cpp.
◆ setImageLocation() [2/2]
void KPIMIdentities::SignatureConfigurator::setImageLocation | ( | const QString & | path | ) |
Sets the directory where the images used in the HTML signature will be stored.
Needs to be called before calling setSignature(), as each signature should use a different location. The directory needs to exist, it will not be created.
- Parameters
-
path the image location to set
- Since
- 4.4
- See also
- Signature::setImageLocation
Definition at line 469 of file signatureconfigurator.cpp.
◆ setInlineText()
void KPIMIdentities::SignatureConfigurator::setInlineText | ( | const QString & | text | ) |
Make text
the text for the signature.
Definition at line 317 of file signatureconfigurator.cpp.
◆ setSignature()
void KPIMIdentities::SignatureConfigurator::setSignature | ( | const Signature & | sig | ) |
Convenience method.
Sets the widgets according to sig
- Parameters
-
sig the signature to configure
Definition at line 383 of file signatureconfigurator.cpp.
◆ setSignatureEnabled()
void KPIMIdentities::SignatureConfigurator::setSignatureEnabled | ( | bool | enable | ) |
Use this to activate the signature.
Definition at line 289 of file signatureconfigurator.cpp.
◆ setSignatureType()
void KPIMIdentities::SignatureConfigurator::setSignatureType | ( | Signature::Type | type | ) |
Set the signature type to type
.
Definition at line 304 of file signatureconfigurator.cpp.
◆ signature()
Signature KPIMIdentities::SignatureConfigurator::signature | ( | ) | const |
Conveniece method.
- Returns
- a Signature object representing the state of the widgets.
Definition at line 350 of file signatureconfigurator.cpp.
◆ signatureType()
Signature::Type KPIMIdentities::SignatureConfigurator::signatureType | ( | ) | const |
This returns the type of the signature, so that can be Disabled, Inline, fromFile, etc.
Definition at line 294 of file signatureconfigurator.cpp.
◆ slotEdit
|
protectedslot |
Definition at line 418 of file signatureconfigurator.cpp.
◆ slotEnableEditButton
|
protectedslot |
Definition at line 413 of file signatureconfigurator.cpp.
◆ slotSetHtml
|
protectedslot |
Definition at line 443 of file signatureconfigurator.cpp.
Member Data Documentation
◆ mCommandEdit
|
protected |
Definition at line 177 of file signatureconfigurator.h.
◆ mEditButton
|
protected |
Definition at line 176 of file signatureconfigurator.h.
◆ mEditToolBar
|
protected |
Definition at line 178 of file signatureconfigurator.h.
◆ mEnableCheck
|
protected |
Definition at line 172 of file signatureconfigurator.h.
◆ mFileRequester
|
protected |
Definition at line 175 of file signatureconfigurator.h.
◆ mFormatToolBar
|
protected |
Definition at line 179 of file signatureconfigurator.h.
◆ mHtmlCheck
|
protected |
Definition at line 173 of file signatureconfigurator.h.
◆ mSourceCombo
|
protected |
Definition at line 174 of file signatureconfigurator.h.
◆ mTextEdit
|
protected |
Definition at line 180 of file signatureconfigurator.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.