• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

mailcommon

  • MailCommon
  • SnippetsManager
Public Member Functions | Properties | List of all members
MailCommon::SnippetsManager Class Reference

#include <snippetsmanager.h>

Inheritance diagram for MailCommon::SnippetsManager:
Inheritance graph
[legend]

Public Member Functions

 SnippetsManager (KActionCollection *actionCollection, QObject *parent=0, QWidget *widget=0)
 
 ~SnippetsManager ()
 
QAction * addSnippetAction () const
 
QAction * addSnippetGroupAction () const
 
QAction * deleteSnippetAction () const
 
QAction * deleteSnippetGroupAction () const
 
QAction * editSnippetAction () const
 
QAction * editSnippetGroupAction () const
 
QAction * insertSnippetAction () const
 
QAbstractItemModel * model () const
 
QString selectedName () const
 
QItemSelectionModel * selectionModel () const
 
void setEditor (QObject *editor, const char *insertSnippetMethod, const char *dropSignal)
 
bool snippetGroupSelected () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Properties

QAction addSnippetAction
 
QAction addSnippetGroupAction
 
QAction deleteSnippetAction
 
QAction deleteSnippetGroupAction
 
QAction editSnippetAction
 
QAction editSnippetGroupAction
 
QAction insertSnippetAction
 
QAbstractItemModel model
 
QString selectedName
 
QItemSelectionModel selectionModel
 
bool snippetGroupSelected
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 

Detailed Description

Definition at line 36 of file snippetsmanager.h.

Constructor & Destructor Documentation

SnippetsManager::SnippetsManager ( KActionCollection *  actionCollection,
QObject *  parent = 0,
QWidget *  widget = 0 
)
explicit

Creates a new snippets manager.

Parameters
actionCollectionThe action collection where the manager will register the snippet shortcuts at.
parentThe parent object.

Definition at line 643 of file snippetsmanager.cpp.

SnippetsManager::~SnippetsManager ( )

Destroys the snippets manager.

Definition at line 684 of file snippetsmanager.cpp.

Member Function Documentation

QAction* MailCommon::SnippetsManager::addSnippetAction ( ) const

Returns the action that handles adding new snippets.

QAction* MailCommon::SnippetsManager::addSnippetGroupAction ( ) const

Returns the action that handles adding new snippet groups.

QAction* MailCommon::SnippetsManager::deleteSnippetAction ( ) const

Returns the action that handles deleting the currently selected snippet.

QAction* MailCommon::SnippetsManager::deleteSnippetGroupAction ( ) const

Returns the action that handles deleting the currently selected snippet group.

QAction* MailCommon::SnippetsManager::editSnippetAction ( ) const

Returns the action that handles editing the currently selected snippet.

QAction* MailCommon::SnippetsManager::editSnippetGroupAction ( ) const

Returns the action that handles editing the currently selected snippet group.

QAction* MailCommon::SnippetsManager::insertSnippetAction ( ) const

Returns the action that handles inserting a snippet into the editor.

QAbstractItemModel* MailCommon::SnippetsManager::model ( ) const

Returns the model that represents the snippets.

QString MailCommon::SnippetsManager::selectedName ( ) const

Returns the name of the currently selected snippet or snippet group.

QItemSelectionModel* MailCommon::SnippetsManager::selectionModel ( ) const

Returns the selection model that is used by the manager to select the snippet or snippet group to work on.

void SnippetsManager::setEditor ( QObject *  editor,
const char *  insertSnippetMethod,
const char *  dropSignal 
)

Sets the editor object the snippet manager will act on.

Parameters
editorThe editor object
insertSnippetMethodThe name of the method will be executed to insert a snippet into the editor. This method must provide a single QString parameter.
dropSignalThe signature of the signal that is emitted by the editor object when a snippet has been dropped on it.

Example usage:

KMComposerEditor *editor = ...
snippetsManager->setEditor( editor, "insertPlainText", SIGNAL( insertSnippet() ) );

Definition at line 690 of file snippetsmanager.cpp.

bool MailCommon::SnippetsManager::snippetGroupSelected ( ) const

Returns whether the currently selected item is a snippet group.

Property Documentation

QAction * SnippetsManager::addSnippetAction
read

Definition at line 42 of file snippetsmanager.h.

QAction * SnippetsManager::addSnippetGroupAction
read

Definition at line 45 of file snippetsmanager.h.

QAction * SnippetsManager::deleteSnippetAction
read

Definition at line 44 of file snippetsmanager.h.

QAction * SnippetsManager::deleteSnippetGroupAction
read

Definition at line 47 of file snippetsmanager.h.

QAction * SnippetsManager::editSnippetAction
read

Definition at line 43 of file snippetsmanager.h.

QAction * SnippetsManager::editSnippetGroupAction
read

Definition at line 46 of file snippetsmanager.h.

QAction * SnippetsManager::insertSnippetAction
read

Definition at line 48 of file snippetsmanager.h.

QAbstractItemModel * SnippetsManager::model
read

Definition at line 40 of file snippetsmanager.h.

QString SnippetsManager::selectedName
read

Definition at line 51 of file snippetsmanager.h.

QItemSelectionModel * SnippetsManager::selectionModel
read

Definition at line 41 of file snippetsmanager.h.

bool SnippetsManager::snippetGroupSelected
read

Definition at line 50 of file snippetsmanager.h.


The documentation for this class was generated from the following files:
  • snippetsmanager.h
  • snippetsmanager.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:31:41 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

mailcommon

Skip menu "mailcommon"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer
  • pimprint

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal