DOM::Editor Class Reference

#include <editor.h>

Inheritance diagram for DOM::Editor:

Public Types
enum	TriState { FalseTriState, TrueTriState, MixedTriState }

Public Member Functions
void	appliedEditing (khtml::EditCommandImpl *)
void	applyStyle (DOM::CSSStyleDeclarationImpl *)
bool	canPaste () const
bool	canRedo () const
bool	canUndo () const
void	clearTypingStyle ()
void	closeTyping ()
void	copy ()
void	cut ()
bool	execCommand (const DOMString &command, bool userInterface, const DOMString &value)
bool	execCommand (EditorCommand, bool userInterface, const DOMString &value)
void	indent ()
WTF::PassRefPtr< khtml::EditCommandImpl >	lastEditCommand () const
void	outdent ()
void	paste ()
void	print ()
bool	queryCommandEnabled (const DOMString &command)
bool	queryCommandEnabled (EditorCommand)
bool	queryCommandIndeterm (const DOMString &command)
bool	queryCommandIndeterm (EditorCommand)
bool	queryCommandState (const DOMString &command)
bool	queryCommandState (EditorCommand)
bool	queryCommandSupported (const DOMString &command)
bool	queryCommandSupported (EditorCommand)
DOMString	queryCommandValue (const DOMString &command)
DOMString	queryCommandValue (EditorCommand)
void	reappliedEditing (khtml::EditCommandImpl *)
void	redo ()
DOM::CSSStyleDeclarationImpl *	selectionComputedStyle (DOM::NodeImpl *&nodeToRemove) const
TriState	selectionHasStyle (DOM::CSSStyleDeclarationImpl *) const
bool	selectionStartHasStyle (DOM::CSSStyleDeclarationImpl *) const
DOM::DOMString	selectionStartStylePropertyValue (int stylePropertyID) const
void	setTypingStyle (DOM::CSSStyleDeclarationImpl *)
DOM::CSSStyleDeclarationImpl *	typingStyle () const
void	unappliedEditing (khtml::EditCommandImpl *)
void	undo ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

This class resembles the editing API when the associated khtml document is editable (in design mode), or contains editable elements.

FIXME: document this thoroughly

API to Wysiwyg Markup-Editor.

Author

Leo Savernik

Definition at line 63 of file editor.h.

Member Enumeration Documentation

TriState

enum DOM::Editor::TriState

Tri-state boolean.

Definition at line 74 of file editor.h.

Member Function Documentation

appliedEditing()

void Editor::appliedEditing

(

khtml::EditCommandImpl *

cmd

)

Called when editing has been applied.

Definition at line 424 of file editor.cpp.

applyStyle()

void Editor::applyStyle

(

DOM::CSSStyleDeclarationImpl *

style

)

applies the given style to the current selection

Definition at line 243 of file editor.cpp.

canPaste()

bool Editor::canPaste

(

)

const

returns whether clipboard contains data to be pasted

Definition at line 209 of file editor.cpp.

canRedo()

bool Editor::canRedo

(

)

const

returns whether any actions can be redone

Definition at line 233 of file editor.cpp.

canUndo()

bool Editor::canUndo

(

)

const

returns whether any actions can be undone

Definition at line 238 of file editor.cpp.

clearTypingStyle()

void Editor::clearTypingStyle

(

)

Clears the typing style for the document.

Definition at line 501 of file editor.cpp.

copy()

void Editor::copy

(

)

copy selection to clipboard

Definition at line 186 of file editor.cpp.

cut()

void Editor::cut

(

)

cut selection and insert into clipboard

Definition at line 191 of file editor.cpp.

execCommand() [1/2]

bool Editor::execCommand	(	const DOMString &	command,
		bool	userInterface,
		const DOMString &	value
	)

Executes the given editor command.

Parameters

command	name of command
userInterface	whether a user interface should be used to input data. This is command dependent.
value	value for command. Its semantic depends on the command.

Definition at line 114 of file editor.cpp.

execCommand() [2/2]

bool Editor::execCommand	(	EditorCommand	command,
		bool	userInterface,
		const DOMString &	value
	)

Executes the given built-in editor command.

Parameters

EditorCommand	index of command
userInterface	whether a user interface should be used to input data. This is command dependent.
value	value for command. Its semantic depends on the command.

Definition at line 150 of file editor.cpp.

indent()

void Editor::indent

(

)

indent/outdent current selection

Definition at line 514 of file editor.cpp.

lastEditCommand()

PassRefPtr< EditCommandImpl > Editor::lastEditCommand

(

)

const

Returns the most recent edit command applied.

Definition at line 419 of file editor.cpp.

paste()

void Editor::paste

(

)

paste into current selection from clipboard

Definition at line 197 of file editor.cpp.

print()

void Editor::print

(

)

prints the current document

Definition at line 204 of file editor.cpp.

queryCommandEnabled() [1/2]

bool Editor::queryCommandEnabled

(

const DOMString &

command

)

Checks whether the given command is enabled.

Definition at line 120 of file editor.cpp.

queryCommandEnabled() [2/2]

bool Editor::queryCommandEnabled

(

EditorCommand

command

)

Checks whether the given command is enabled.

Definition at line 156 of file editor.cpp.

queryCommandIndeterm() [1/2]

bool Editor::queryCommandIndeterm

(

const DOMString &

command

)

Checks whether the given command's style is indeterminate.

Definition at line 126 of file editor.cpp.

queryCommandIndeterm() [2/2]

bool Editor::queryCommandIndeterm

(

EditorCommand

command

)

Checks whether the given command's style is indeterminate.

Definition at line 162 of file editor.cpp.

queryCommandState() [1/2]

bool Editor::queryCommandState

(

const DOMString &

command

)

Checks whether the given command's style is state.

Definition at line 132 of file editor.cpp.

queryCommandState() [2/2]

bool Editor::queryCommandState

(

EditorCommand

command

)

Checks whether the given command's style is state.

Definition at line 168 of file editor.cpp.

queryCommandSupported() [1/2]

bool Editor::queryCommandSupported

(

const DOMString &

command

)

Checks whether the given command is supported in the current context.

Definition at line 138 of file editor.cpp.

queryCommandSupported() [2/2]

bool Editor::queryCommandSupported

(

EditorCommand

command

)

Checks whether the given command is supported in the current context.

Definition at line 174 of file editor.cpp.

queryCommandValue() [1/2]

DOMString Editor::queryCommandValue

(

const DOMString &

command

)

Returns the given command's value.

Definition at line 144 of file editor.cpp.

queryCommandValue() [2/2]

DOMString Editor::queryCommandValue

(

EditorCommand

command

)

Returns the given command's value.

Definition at line 180 of file editor.cpp.

reappliedEditing()

void Editor::reappliedEditing

(

khtml::EditCommandImpl *

cmd

)

Called when editing has been reapplied.

Definition at line 467 of file editor.cpp.

redo()

void Editor::redo

(

)

redo last undone action

Definition at line 215 of file editor.cpp.

selectionComputedStyle()

CSSStyleDeclarationImpl * Editor::selectionComputedStyle

(

DOM::NodeImpl *&

nodeToRemove

)

const

computed style of current selection

Definition at line 379 of file editor.cpp.

selectionHasStyle()

Editor::TriState Editor::selectionHasStyle

(

DOM::CSSStyleDeclarationImpl *

style

)

const

returns whether the selection has got applied the given style

Definition at line 284 of file editor.cpp.

selectionStartHasStyle()

bool Editor::selectionStartHasStyle

(

DOM::CSSStyleDeclarationImpl *

style

)

const

returns whether the selection has got applied the given style

Definition at line 324 of file editor.cpp.

selectionStartStylePropertyValue()

DOMString Editor::selectionStartStylePropertyValue

(

int

stylePropertyID

)

const

?

Definition at line 358 of file editor.cpp.

setTypingStyle()

void Editor::setTypingStyle

(

DOM::CSSStyleDeclarationImpl *

style

)

Sets the typing style for the document.

Definition at line 489 of file editor.cpp.

typingStyle()

CSSStyleDeclarationImpl * Editor::typingStyle

(

)

const

Returns the typing style for the document.

Definition at line 484 of file editor.cpp.

unappliedEditing()

void Editor::unappliedEditing

(

khtml::EditCommandImpl *

cmd

)

Called when editing has been unapplied.

Definition at line 449 of file editor.cpp.

undo()

void Editor::undo

(

)

undo last action

Definition at line 224 of file editor.cpp.

---

The documentation for this class was generated from the following files:

• editor.h
• editor.cpp