OptionQWidgetWrapper< OptionWidget > Class Template Reference
[Plug-In Shells]

This templated class provides a way to implement both the Option interface and provide a QWidget by writing a single class instead of two. More...

#include <OptionQWidgetWrapper.h>

Inheritance diagram for OptionQWidgetWrapper< OptionWidget >:

List of all members.

Public Member Functions
	OptionQWidgetWrapper ()
	~OptionQWidgetWrapper ()
void	applyChanges ()
Protected Member Functions
QWidget *	createOptionsWidget ()

---

Detailed Description

template<typename OptionWidget>
class OptionQWidgetWrapper< OptionWidget >

This templated class provides a way to implement both the Option interface and provide a QWidget by writing a single class instead of two.

This templated class is used by writing a QWidget subclass and then doing the following to register the plug-in:

    //assume SampleOption is a subclass of QWidget and
    //the plug-in belongs to a module that was registered
    //using REGISTER_MODULE(SampleModule);
    REGISTER_PLUGIN(SampleModule, SampleOption, OptionQWidgetWrapper<SampleOption>());

The templated argument must meet the following requirements:

• Provide a default constructor.
• Subclass QWidget.
• Provide a static getName() method.

  See also:

  PlugIn::getName()

• Provide a static getOptionName() method.

  See also:

  Option::getOptionName()

• Provide a static getDescription() method.

  See also:

  PlugIn::getDescription()

• Provide a static getVersion() method.

  See also:

  PlugIn::getVersion()

• Provide a static getCreator() method.

  See also:

  PlugIn::getCreator()

• Provide a static getCopyright() method.

  See also:

  PlugIn::getCopyright()

• Provide a static getShortDescription() method.

  See also:

  PlugIn::getShortDescription()

• Provide a static isProduction() method.

  See also:

  PlugIn::isProduction()

• Provide an applyChanges() method.

  See also:

  Option::applyChanges()

Definition at line 49 of file OptionQWidgetWrapper.h.

---

Constructor & Destructor Documentation

template<typename OptionWidget>

OptionQWidgetWrapper< OptionWidget >::OptionQWidgetWrapper

(

)

Instantiates this option plug-in by querying the templated class using it's provided static methods.

Definition at line 57 of file OptionQWidgetWrapper.h.

template<typename OptionWidget>

OptionQWidgetWrapper< OptionWidget >::~OptionQWidgetWrapper

(

)

Destroys this option plug-in.

Definition at line 73 of file OptionQWidgetWrapper.h.

---

Member Function Documentation

template<typename OptionWidget>

void OptionQWidgetWrapper< OptionWidget >::applyChanges

(

)

[virtual]

Applies the changes by calling applyChanges() on the templated class.

Implements Option.

Definition at line 81 of file OptionQWidgetWrapper.h.

template<typename OptionWidget>

QWidget* OptionQWidgetWrapper< OptionWidget >::createOptionsWidget

(

)

[protected, virtual]

Creates the option widget by instantiating the templated class which must be a subclass of QWidget.

Implements OptionShell.

Definition at line 96 of file OptionQWidgetWrapper.h.