Adaptor to expose an EditorSupport through DBus. More...

#include <EditorSupportAdaptor.h>

Public Slots
int	mainWindowObjectId () const
	Returns the object id of the application main window.
int	findObject (const QString &name)
	Returns the id of the object with the given name.
void	highlight (int objectId)
	Starts the highlighting animation for the widget associated to the given id.
void	stopHighlighting (int objectId)
	Stops the highlighting animation for the widget associated to the given id.
void	enableEventSpy ()
	Enables the EventSpy.
void	disableEventSpy ()
	Disables the EventSpy.
void	testScriptedTutorial (const QString &filename, const QString &stepId=QString())
	Starts the scripted tutorial stored in the given filename.
Public Member Functions
	EditorSupportAdaptor (EditorSupport *editorSupport)
	Creates a new EditorSupportAdaptor for the given EditorSupport.

Detailed Description

Adaptor to expose an EditorSupport through DBus.

See also:: EditorSupport

Definition at line 40 of file EditorSupportAdaptor.h.

Constructor & Destructor Documentation

ktutorial::editorsupport::EditorSupportAdaptor::EditorSupportAdaptor ( EditorSupport * editorSupport ) [explicit]

Creates a new EditorSupportAdaptor for the given EditorSupport.

Parameters:

editorSupport The EditorSupport to adapt.

Definition at line 32 of file EditorSupportAdaptor.cpp.

Member Function Documentation

int ktutorial::editorsupport::EditorSupportAdaptor::findObject ( const QString & name ) [slot]

Returns the id of the object with the given name.

The name can include ancestor names.

Parameters:

name	The name of the object to find.

Returns:: The id of the object with the given name, or 0 if there is none.

Definition at line 43 of file EditorSupportAdaptor.cpp.

References ktutorial::editorsupport::EditorSupport::findObject().

void ktutorial::editorsupport::EditorSupportAdaptor::highlight ( int objectId ) [slot]

Starts the highlighting animation for the widget associated to the given id.

Parameters:

objectId The id of the widget to highlight.

Definition at line 47 of file EditorSupportAdaptor.cpp.

References ktutorial::editorsupport::EditorSupport::highlight().

int ktutorial::editorsupport::EditorSupportAdaptor::mainWindowObjectId ( ) const [slot]

Returns the object id of the application main window.

Returns:: The object id of the application main window.

Definition at line 39 of file EditorSupportAdaptor.cpp.

References ktutorial::editorsupport::EditorSupport::mainWindowObjectId().

void ktutorial::editorsupport::EditorSupportAdaptor::stopHighlighting ( int objectId ) [slot]

Stops the highlighting animation for the widget associated to the given id.

Parameters:

objectId The id of the widget to stop highlighting.

Definition at line 51 of file EditorSupportAdaptor.cpp.

References ktutorial::editorsupport::EditorSupport::stopHighlighting().

void ktutorial::editorsupport::EditorSupportAdaptor::testScriptedTutorial	(	const QString &	filename,
		const QString &	stepId = `QString()`
	)		`[slot]`

Starts the scripted tutorial stored in the given filename.

If a step id is given, the tutorial is changed to that step after starting.

Parameters:

filename	The name of the file to read the scripted tutorial from.
stepId	The id of the step to change to, if any.

Definition at line 63 of file EditorSupportAdaptor.cpp.

References ktutorial::editorsupport::EditorSupport::testScriptedTutorial().

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

Public Slots

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation