Default KTutorial customization for KDE. More...

#include <DefaultKdeCustomization.h>

Inheritance diagram for ktutorial::customization::DefaultKdeCustomization:

Collaboration diagram for ktutorial::customization::DefaultKdeCustomization:

Public Slots
virtual void	showTutorialUI (Tutorial *tutorial)
	Shows the tutorial UI.
Public Member Functions
	DefaultKdeCustomization (KXmlGuiWindow *window)
	Creates a new DefaultKdeCustomization for the given window.
virtual void	setup (TutorialManager *tutorialManager)
	Sets up the KTutorial user interface.
virtual QWidget *	mainApplicationWindow ()
	Returns the main window of the application.

Detailed Description

Default KTutorial customization for KDE.

The default customization adds a "Tutorials" menu entry in the "Help" menu that shows a TutorialManagerDialog; the tutorial UI shown is a StepWidget. It also registers the default tutorial, "Using KTutorial".

Note that the default customization can be used only with XMLGUI applications (applications where the main window is a KXmlGuiWindow). In order to add the menu entry in the proper place in the menu a change must be done in your "applicationnameui.rc". Please refer to KTutorial manual for further information.

Definition at line 41 of file DefaultKdeCustomization.h.

Constructor & Destructor Documentation

ktutorial::customization::DefaultKdeCustomization::DefaultKdeCustomization ( KXmlGuiWindow * window ) [explicit]

Creates a new DefaultKdeCustomization for the given window.

Parameters:

window The main window of the application.

Definition at line 54 of file DefaultKdeCustomization.cpp.

Member Function Documentation

QWidget * ktutorial::customization::DefaultKdeCustomization::mainApplicationWindow ( ) [virtual]

Returns the main window of the application.

Returns:: The main window of the application.

Implements ktutorial::KTutorialCustomization.

Definition at line 80 of file DefaultKdeCustomization.cpp.

void ktutorial::customization::DefaultKdeCustomization::setup ( TutorialManager * tutorialManager ) [virtual]

Sets up the KTutorial user interface.

It adds the Tutorials action and the menu entry for it in Help menu, and prepares the TutorialManagerDialog and the StepWidget to be shown when needed.

Besides setting up the user interface, the default "Using KTutorial" tutorial is registered.

Parameters:

tutorialManager The TutorialManager used by KTutorial.

Implements ktutorial::KTutorialCustomization.

Definition at line 58 of file DefaultKdeCustomization.cpp.

References ktutorial::TutorialManager::registerTutorial(), and showTutorialUI().

void ktutorial::customization::DefaultKdeCustomization::showTutorialUI ( Tutorial * tutorial ) [virtual, slot]

Shows the tutorial UI.

A StepWidget is used.

Parameters:

tutorial The tutorial to show its StepWidget.

Implements ktutorial::KTutorialCustomization.