<class name="QDesignerMemberSheetExtensionInterface" doc="/** <p>The <a href="QDesignerMemberSheetExtension.html"><tt>QDesignerMemberSheetExtension</tt></a> 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.</p> <p><a href="QDesignerMemberSheetExtension.html"><tt>QDesignerMemberSheetExtension</tt></a> is a collection of functions that is typically used to query a widget's member functions, and to manipulate the member functions' appearance in <i>Qt Designer</i>'s signals and slots editing mode. For example:</p> <pre> QDesignerMemberSheetExtension *memberSheet = 0; QExtensionManager manager = formEditor-&gt;extensionManager(); memberSheet = qt_extension&lt;QDesignerMemberSheetExtension*&gt;(manager, widget); int index = memberSheet-&gt;indexOf(setEchoMode); memberSheet-&gt;setVisible(index, false); delete memberSheet;</pre> <p>When implementing a custom widget plugin, a pointer to <i>Qt Designer</i>'s current QDesignerFormEditorInterface object (<tt>formEditor</tt> in the example above) is provided by the QDesignerCustomWidgetInterface::initialize() function's parameter.</p> <p>The member sheet (and any other extension), can be retrieved by querying <i>Qt Designer</i>'s extension manager using the qt_extension() function. When you want to release the extension, you only need to delete the pointer.</p> <p>All widgets have a default member sheet used in <i>Qt Designer</i>'s signals and slots editing mode with the widget's member functions. But <a href="QDesignerMemberSheetExtension.html"><tt>QDesignerMemberSheetExtension</tt></a> also provides an interface for creating custom member sheet extensions.</p> <p><b>Warning:</b> <i>Qt Designer</i> uses the <a href="QDesignerMemberSheetExtension.html"><tt>QDesignerMemberSheetExtension</tt></a> to facilitate the signal and slot editing mode. Whenever a connection between two widgets is requested, <i>Qt Designer</i> 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.</p> <p>To create a member sheet extension, your extension class must inherit from both <a href="%2E%2E/%2E%2E/qt/core/QObject.html"><tt>QObject</tt></a> and <a href="QDesignerMemberSheetExtension.html"><tt>QDesignerMemberSheetExtension</tt></a>. Then, since we are implementing an interface, we must ensure that it's made known to the meta object system using the Q_INTERFACES() macro:</p> <pre> class MyMemberSheetExtension : public QObject, public QDesignerMemberSheetExtension { Q_OBJECT Q_INTERFACES(QDesignerMemberSheetExtension) public: ... }</pre> <p>This enables <i>Qt Designer</i> to use qobject_cast() to query for supported interfaces using nothing but a <a href="%2E%2E/%2E%2E/qt/core/QObject.html"><tt>QObject</tt></a> pointer.</p> <p>In <i>Qt Designer</i> the extensions are not created until they are required. For that reason, when implementing a member sheet extension, you must also create a QExtensionFactory, i.e a class that is able to make an instance of your extension, and register it using <i>Qt Designer</i>'s extension manager</tt>.</p> <p>When a widget's member sheet extension is required, <i>Qt Designer</i>'s extension manager</tt> will run through all its registered factories calling QExtensionFactory::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, <i>Qt Designer</i> will use the default member sheet.</p> <p>There are four available types of extensions in <i>Qt Designer</i>: QDesignerContainerExtension, <a href="QDesignerMemberSheetExtension.html"><tt>QDesignerMemberSheetExtension</tt></a>, <a href="QDesignerPropertySheetExtension.html"><tt>QDesignerPropertySheetExtension</tt></a> and QDesignerTaskMenuExtension. <i>Qt Designer</i>'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.</p> <p>The QExtensionFactory class provides a standard extension factory, and can also be used as an interface for custom extension factories. You can either create a new QExtensionFactory and reimplement the QExtensionFactory::createExtension() function. For example:</p> <pre> QObject *ANewExtensionFactory::createExtension(QObject *object, const QString &amp;iid, QObject *parent) const { if (iid != Q_TYPEID(QDesignerMemberSheetExtension)) return 0; if (MyCustomWidget *widget = qobject_cast&lt;MyCustomWidget*&gt; (object)) return new MyMemberSheetExtension(widget, parent); return 0; }</pre> <p>Or you can use an existing factory, expanding the QExtensionFactory::createExtension() function to make the factory able to create a member sheet extension as well. For example:</p> <pre> QObject *AGeneralExtensionFactory::createExtension(QObject *object, const QString &amp;iid, QObject *parent) const { MyCustomWidget *widget = qobject_cast&lt;MyCustomWidget*&gt;(object); if (widget &amp;&amp; (iid == Q_TYPEID(QDesignerTaskMenuExtension))) { return new MyTaskMenuExtension(widget, parent); } else if (widget &amp;&amp; (iid == Q_TYPEID(QDesignerMemberSheetExtension))) { return new MyMemberSheetExtension(widget, parent); } else { return 0; } }</pre> <p>For a complete example using an extension class, see Task Menu Extension example</tt>. The example shows how to create a custom widget plugin for Qt Designer, and how to to use the QDesignerTaskMenuExtension class to add custom items to <i>Qt Designer</i>'s task menu.</p> @see <tt>QExtensionFactory</tt> @see <tt>QExtensionManager</tt> @see <a href="%2E%2E/%2E%2E/qt/designer-creating-custom-widgets-extensions.html">Creating Custom Widget Extensions</tt></a> */"> <method name="public int count()" doc="/** <p>Returns the extension's number of member functions.</p> */"/> <method name="public java.lang.String declaredInClass(int index)" doc="/** <p>Returns the name of the class in which the member function with the given <tt>index</tt> is declared.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> */"/> <method name="public int indexOf(java.lang.String name)" doc="/** <p>Returns the index of the member function specified by the given <tt>name</tt>.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#memberName(int)"><tt>memberName</tt></a> */"/> <method name="public boolean inheritedFromWidget(int index)" doc="/** <p>Returns true if the member function with the given <tt>index</tt> is inherited from <a href="%2E%2E/%2E%2E/qt/gui/QWidget.html"><tt>QWidget</tt></a>, otherwise false.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> */"/> <method name="public boolean isSignal(int index)" doc="/** <p>Returns true if the member function with the given <tt>index</tt> is a signal, otherwise false.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> */"/> <method name="public boolean isSlot(int index)" doc="/** <p>Returns true if the member function with the given <tt>index</tt> is a slot, otherwise false.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> */"/> <method name="public boolean isVisible(int index)" doc="/** <p>Returns true if the member function with the given <tt>index</tt> is visible in <i>Qt Designer</i>'s signal and slot editor, otherwise false.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> @see <a href="QDesignerMemberSheetExtensionInterface.html#setVisible(int, boolean)"><tt>setVisible</tt></a> */"/> <method name="public java.lang.String memberGroup(int index)" doc="/** <p>Returns the name of the member group specified for the function with the given <tt>index</tt>.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> @see <a href="QDesignerMemberSheetExtensionInterface.html#setMemberGroup(int, java.lang.String)"><tt>setMemberGroup</tt></a> */"/> <method name="public java.lang.String memberName(int index)" doc="/** <p>Returns the name of the member function with the given <tt>index</tt>.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> */"/> <method name="public java.util.List<com.trolltech.qt.core.QByteArray> parameterNames(int index)" doc="/** <p>Returns the parameter names of the member function with the given <tt>index</tt>, as a <a href="%2E%2E/%2E%2E/qt/core/QByteArray.html"><tt>QByteArray</tt></a> list.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> @see <a href="QDesignerMemberSheetExtensionInterface.html#parameterTypes(int)"><tt>parameterTypes</tt></a> */"/> <method name="public java.util.List<com.trolltech.qt.core.QByteArray> parameterTypes(int index)" doc="/** <p>Returns the parameter types of the member function with the given <tt>index</tt>, as a <a href="%2E%2E/%2E%2E/qt/core/QByteArray.html"><tt>QByteArray</tt></a> list.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> @see <a href="QDesignerMemberSheetExtensionInterface.html#parameterNames(int)"><tt>parameterNames</tt></a> */"/> <method name="public void setMemberGroup(int index, java.lang.String group)" doc="/** <p>Sets the member group of the member function with the given <tt>index</tt>, to <tt>group</tt>.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> @see <a href="QDesignerMemberSheetExtensionInterface.html#memberGroup(int)"><tt>memberGroup</tt></a> */"/> <method name="public void setVisible(int index, boolean b)" doc="/** <p>If <tt>b</tt> is true, the member function with the given <tt>index</tt> is visible in <i>Qt Designer</i>'s signals and slots editing mode; otherwise the member function is hidden.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> @see <a href="QDesignerMemberSheetExtensionInterface.html#isVisible(int)"><tt>isVisible</tt></a> */"/> <method name="public java.lang.String signature(int index)" doc="/** <p>Returns the signature of the member function with the given <tt>index</tt>.</p> @see <a href="QDesignerMemberSheetExtensionInterface.html#indexOf(java.lang.String)"><tt>indexOf</tt></a> */"/> </class>