MailCommon::SnippetsManager Class Reference

#include <snippetsmanager.h>

Inheritance diagram for MailCommon::SnippetsManager:

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

Properties
QAction	addSnippetAction
QAction	addSnippetGroupAction
QAction	deleteSnippetAction
QAction	deleteSnippetGroupAction
QAction	editSnippetAction
QAction	editSnippetGroupAction
QAction	insertSnippetAction
QAbstractItemModel	model
QString	selectedName
QItemSelectionModel	selectionModel
bool	snippetGroupSelected

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

actionCollection	The action collection where the manager will register the snippet shortcuts at.
parent	The 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

editor	The editor object
insertSnippetMethod	The name of the method will be executed to insert a snippet into the editor. This method must provide a single QString parameter.
dropSignal	The 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