kpimidentities
KPIMIdentities::SignatureConfigurator Class Reference
This widget gives an interface so users can edit their signature. More...
#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 QString &path) |
void | setImageLocation (const Identity &identity) |
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
Enum for the different viemodes.
Definition at line 65 of file signatureconfigurator.h.
Constructor & Destructor Documentation
KPIMIdentities::SignatureConfigurator::SignatureConfigurator | ( | QWidget * | parent = 0 |
) | [explicit] |
Constructor.
Definition at line 261 of file signatureconfigurator.cpp.
KPIMIdentities::SignatureConfigurator::~SignatureConfigurator | ( | ) | [virtual] |
destructor
Definition at line 267 of file signatureconfigurator.cpp.
Member Function Documentation
QString KPIMIdentities::SignatureConfigurator::commandURL | ( | ) | const |
Returns the url of the command which the users wants to use as signature.
Definition at line 331 of file signatureconfigurator.cpp.
QString KPIMIdentities::SignatureConfigurator::fileURL | ( | ) | const |
Returns the file url which the user wants to use as a signature.
Definition at line 314 of file signatureconfigurator.cpp.
QString KPIMIdentities::SignatureConfigurator::inlineText | ( | ) | const |
Returns the inline text, only useful when this is the appropriate Signature::Type.
bool KPIMIdentities::SignatureConfigurator::isSignatureEnabled | ( | ) | const |
Indicated if the user wants a signature.
Definition at line 272 of file signatureconfigurator.cpp.
void KPIMIdentities::SignatureConfigurator::setCommandURL | ( | const QString & | url | ) |
Sets url
as the command to execute.
Definition at line 336 of file signatureconfigurator.cpp.
void KPIMIdentities::SignatureConfigurator::setFileURL | ( | const QString & | url | ) |
Set url
for the file url part of the widget.
Definition at line 326 of file signatureconfigurator.cpp.
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.
- Since:
- 4.4
- See also:
- Signature::setImageLocation
Definition at line 452 of file signatureconfigurator.cpp.
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 457 of file signatureconfigurator.cpp.
void KPIMIdentities::SignatureConfigurator::setInlineText | ( | const QString & | text | ) |
Make text
the text for the signature.
Definition at line 309 of file signatureconfigurator.cpp.
void KPIMIdentities::SignatureConfigurator::setSignature | ( | const Signature & | sig | ) |
Convenience method.
Sets the widgets according to sig
Definition at line 374 of file signatureconfigurator.cpp.
void KPIMIdentities::SignatureConfigurator::setSignatureEnabled | ( | bool | enable | ) |
Use this to activate the signature.
Definition at line 277 of file signatureconfigurator.cpp.
void KPIMIdentities::SignatureConfigurator::setSignatureType | ( | Signature::Type | type | ) |
Set the signature type to type
.
Definition at line 294 of file signatureconfigurator.cpp.
Signature KPIMIdentities::SignatureConfigurator::signature | ( | ) | const |
Conveniece method.
- Returns:
- a Signature object representing the state of the widgets.
Definition at line 342 of file signatureconfigurator.cpp.
Signature::Type KPIMIdentities::SignatureConfigurator::signatureType | ( | ) | const |
This returns the type of the signature, so that can be Disabled, Inline, fromFile, etc.
Definition at line 282 of file signatureconfigurator.cpp.
The documentation for this class was generated from the following files: