ModuleView Class Reference

Provides a convienent way to display modules. More...

#include <ModuleView.h>

Inheritance diagram for ModuleView:

[legend]

List of all members.

Public Slots
void	keyPressEvent (QKeyEvent *event)
void	loadModule (MenuItem *menuItem)
void	moduleDefaults ()
void	moduleHelp ()
void	moduleLoad ()
bool	moduleSave ()
Signals
void	closeRequest ()
void	moduleChanged (bool state)
Public Member Functions
	ModuleView (QWidget *parent=0)
	~ModuleView ()
const KAboutData *	aboutData () const
KCModuleInfo *	activeModule () const
void	closeModules ()
bool	resolveChanges ()

---

Detailed Description

Provides a convienent way to display modules.

Provides a standardised interface for displaying multiple modules simultaneously and provides facilities to access the current module, and to load its help, restore default settings, save new settings and revert changes to settings

It also provides checking for when a module has changed its configuration, and will prompt if the user tries to change module or view if BaseMode is reimplemented correctly

It also provides signals for active module changes, configuration changes and for when it has been requested to close by button press

Author:

Mathias Soeken <msoeken@informatik.uni-bremen.de>

Ben Cooksley <ben@eclipse.endoftheinternet.org>

Definition at line 49 of file ModuleView.h.

---

Constructor & Destructor Documentation

ModuleView::ModuleView

(

QWidget *

parent = 0

)

[explicit]

Constructs a ModuleView, with the parent specified.

Definition at line 61 of file ModuleView.cpp.

ModuleView::~ModuleView

(

)

Destroys the module view, along with all modules loaded, and any changes present in them.

Warning:

The user will not be prompted to save changes if any exist.

Definition at line 97 of file ModuleView.cpp.

---

Member Function Documentation

const KAboutData * ModuleView::aboutData

(

)

const

Provides the about data of the active module, used for the about dialog.

Definition at line 107 of file ModuleView.cpp.

KCModuleInfo * ModuleView::activeModule

(

)

const

Provides the module information, which is used to set the caption of the window when either the active module or configuration changes.

Definition at line 102 of file ModuleView.cpp.

void ModuleView::closeModules

(

)

Closes all active modules, after checking there are no active changes.

Warning:

This forces all modules to be destroyed regardless of if changes exist or not If possible, always check with resolveChanges() first.

Definition at line 241 of file ModuleView.cpp.

void ModuleView::closeRequest

(

)

[signal]

Emitted when the ModuleView is asked to close.

void ModuleView::keyPressEvent

(

QKeyEvent *

event

)

[slot]

Reimplemented for internal reasons.

Reimplemented from QWidget.

Definition at line 340 of file ModuleView.cpp.

void ModuleView::loadModule

(

MenuItem *

menuItem

)

[slot]

Loads the module specified by menuItem.

If the module has children, they will all be loaded instead of the module.

Parameters:

menuItem

the MenuItem that you want to load.

Definition at line 121 of file ModuleView.cpp.

void ModuleView::moduleChanged

(

bool

state

)

[signal]

Emitted when the currently active module is changed.

This occurs whenever the active module or its configuration changes. This causes the window caption to update.

void ModuleView::moduleDefaults

(

)

[slot]

Causes the active module to revert all changes to the configuration, and return to defaults.

Definition at line 279 of file ModuleView.cpp.

void ModuleView::moduleHelp

(

)

[slot]

Will open KHelpCenter, and load the help for the active module.

Definition at line 287 of file ModuleView.cpp.

void ModuleView::moduleLoad

(

)

[slot]

Causes the active module to reload its configuration, reverting all changes.

Definition at line 271 of file ModuleView.cpp.

bool ModuleView::moduleSave

(

)

[slot]

Causes the active module to save its configuration, applying all changes.

Definition at line 255 of file ModuleView.cpp.

bool ModuleView::resolveChanges

(

)

Resolves any changes in the currently active module by prompting the user if they exist.

Returns:

true if the user saved or discarded changes, or there were no changes at all.

false if the user canceled the module change.

Definition at line 200 of file ModuleView.cpp.

---

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

• ModuleView.h
• ModuleView.cpp