Contents

• Public Functions
• Detailed Description

Detailed Description

TheQDesignerMemberSheetExtension class allows you to manipulate a widget's member functions which is displayed when configuring connections using Qt Designer's mode for editing signals and slots.

QDesignerMemberSheetExtension is a collection of functions that is typically used to query a widget's member functions, and to manipulate the member functions' appearance inQt Designer's signals and slots editing mode. For example:

QDesignerMemberSheetExtension*memberSheet=0;QExtensionManager manager= formEditor->extensionManager();memberSheet= qt_extension<QDesignerMemberSheetExtension*>(manager, widget);int index= memberSheet->indexOf(setEchoMode);memberSheet->setVisible(index,false);delete memberSheet;

When implementing a custom widget plugin, a pointer toQt Designer's currentQDesignerFormEditorInterface object (formEditor in the example above) is provided by theQDesignerCustomWidgetInterface::initialize() function's parameter.

The member sheet (and any other extension), can be retrieved by queryingQt Designer's extension manager using theqt_extension() function. When you want to release the extension, you only need to delete the pointer.

All widgets have a default member sheet used inQt Designer's signals and slots editing mode with the widget's member functions. ButQDesignerMemberSheetExtension also provides an interface for creating custom member sheet extensions.

Warning:Qt Designer uses theQDesignerMemberSheetExtension to facilitate the signal and slot editing mode. Whenever a connection between two widgets is requested,Qt Designer will query for the widgets' member sheet extensions. If a widget has an implemented member sheet extension, this extension will override the default member sheet.

To create a member sheet extension, your extension class must inherit from bothQObject andQDesignerMemberSheetExtension. Then, since we are implementing an interface, we must ensure that it's made known to the meta object system using theQ_INTERFACES() macro:

class MyMemberSheetExtension :publicQObject,publicQDesignerMemberSheetExtension{    Q_OBJECT    Q_INTERFACES(QDesignerMemberSheetExtension)public:...}

This enablesQt Designer to useqobject_cast() to query for supported interfaces using nothing but aQObject pointer.

InQt Designer the extensions are not created until they are required. For that reason, when implementing a member sheet extension, you must also create aQExtensionFactory, i.e a class that is able to make an instance of your extension, and register it usingQt Designer'sextension manager.

When a widget's member sheet extension is required,Qt Designer'sextension manager will run through all its registered factories callingQExtensionFactory::createExtension() for each until the first one that is able to create a member sheet extension for that widget, is found. This factory will then make an instance of the extension. If no such factory is found,Qt Designer will use the default member sheet.

There are four available types of extensions inQt Designer:QDesignerContainerExtension,QDesignerMemberSheetExtension,QDesignerPropertySheetExtension andQDesignerTaskMenuExtension.Qt Designer's behavior is the same whether the requested extension is associated with a multi page container, a member sheet, a property sheet or a task menu.

TheQExtensionFactory class provides a standard extension factory, and can also be used as an interface for custom extension factories. You can either create a newQExtensionFactory and reimplement theQExtensionFactory::createExtension() function. For example:

QObject*ANewExtensionFactory::createExtension(QObject*object,constQString&iid,QObject*parent)const{if (iid!= Q_TYPEID(QDesignerMemberSheetExtension))return0;if (MyCustomWidget*widget= qobject_cast<MyCustomWidget*>           (object))returnnew MyMemberSheetExtension(widget, parent);return0;}

Or you can use an existing factory, expanding theQExtensionFactory::createExtension() function to make the factory able to create a member sheet extension as well. For example:

QObject*AGeneralExtensionFactory::createExtension(QObject*object,constQString&iid,QObject*parent)const{    MyCustomWidget*widget= qobject_cast<MyCustomWidget*>(object);if (widget&& (iid== Q_TYPEID(QDesignerTaskMenuExtension))) {returnnew MyTaskMenuExtension(widget, parent);    }elseif (widget&& (iid== Q_TYPEID(QDesignerMemberSheetExtension))) {returnnew MyMemberSheetExtension(widget, parent);    }else {return0;    }}

For a complete example using an extension class, seeTask Menu Extension example. The example shows how to create a custom widget plugin for Qt Designer, and how to to use theQDesignerTaskMenuExtension class to add custom items toQt Designer's task menu.

Member Function Documentation

[virtual]QDesignerMemberSheetExtension::~QDesignerMemberSheetExtension()

Destroys the member sheet extension.

[pure virtual]int QDesignerMemberSheetExtension::count() const

Returns the extension's number of member functions.

[pure virtual]QString QDesignerMemberSheetExtension::declaredInClass(int index) const

Returns the name of the class in which the member function with the givenindex is declared.

See alsoindexOf().

[pure virtual]int QDesignerMemberSheetExtension::indexOf(constQString & name) const

Returns the index of the member function specified by the givenname.

See alsomemberName().

[pure virtual]bool QDesignerMemberSheetExtension::inheritedFromWidget(int index) const

Returns true if the member function with the givenindex is inherited fromQWidget, otherwise false.

See alsoindexOf().

[pure virtual]bool QDesignerMemberSheetExtension::isSignal(int index) const

Returns true if the member function with the givenindex is a signal, otherwise false.

See alsoindexOf().

[pure virtual]bool QDesignerMemberSheetExtension::isSlot(int index) const

Returns true if the member function with the givenindex is a slot, otherwise false.

See alsoindexOf().

[pure virtual]bool QDesignerMemberSheetExtension::isVisible(int index) const

Returns true if the member function with the givenindex is visible inQt Designer's signal and slot editor, otherwise false.

See alsoindexOf() andsetVisible().

[pure virtual]QString QDesignerMemberSheetExtension::memberGroup(int index) const

Returns the name of the member group specified for the function with the givenindex.

See alsoindexOf() andsetMemberGroup().

[pure virtual]QString QDesignerMemberSheetExtension::memberName(int index) const

Returns the name of the member function with the givenindex.

See alsoindexOf().

[pure virtual]QList<QByteArray> QDesignerMemberSheetExtension::parameterNames(int index) const

Returns the parameter names of the member function with the givenindex, as aQByteArray list.

See alsoindexOf() andparameterTypes().

[pure virtual]QList<QByteArray> QDesignerMemberSheetExtension::parameterTypes(int index) const

Returns the parameter types of the member function with the givenindex, as aQByteArray list.

See alsoindexOf() andparameterNames().

[pure virtual]void QDesignerMemberSheetExtension::setMemberGroup(int index, constQString & group)

Sets the member group of the member function with the givenindex, togroup.

See alsoindexOf() andmemberGroup().

[pure virtual]void QDesignerMemberSheetExtension::setVisible(int index,bool visible)

Ifvisible is true, the member function with the givenindex is visible inQt Designer's signals and slots editing mode; otherwise the member function is hidden.

See alsoindexOf() andisVisible().

[pure virtual]QString QDesignerMemberSheetExtension::signature(int index) const

Returns the signature of the member function with the givenindex.

See alsoindexOf().