<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QDesignerMemberSheetExtension Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QDesignerMemberSheetExtension Class Reference<br /><sup><sup>[<a href="qtdesigner.html">QtDesigner</a> module]</sup></sup></h1><p>The QDesignerMemberSheetExtension 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.
<a href="#details">More...</a></p>
<p>Inherited by <a href="qpydesignermembersheetextension.html">QPyDesignerMemberSheetExtension</a>.</p><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qdesignermembersheetextension.html#QDesignerMemberSheetExtension">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qdesignermembersheetextension.html#QDesignerMemberSheetExtension-2">__init__</a></b> (<i>self</i>, QDesignerMemberSheetExtension)</li><li><div class="fn" />int <b><a href="qdesignermembersheetextension.html#count">count</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qdesignermembersheetextension.html#declaredInClass">declaredInClass</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />int <b><a href="qdesignermembersheetextension.html#indexOf">indexOf</a></b> (<i>self</i>, QString <i>name</i>)</li><li><div class="fn" />bool <b><a href="qdesignermembersheetextension.html#inheritedFromWidget">inheritedFromWidget</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />bool <b><a href="qdesignermembersheetextension.html#isSignal">isSignal</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />bool <b><a href="qdesignermembersheetextension.html#isSlot">isSlot</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />bool <b><a href="qdesignermembersheetextension.html#isVisible">isVisible</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />QString <b><a href="qdesignermembersheetextension.html#memberGroup">memberGroup</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />QString <b><a href="qdesignermembersheetextension.html#memberName">memberName</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />list-of-QByteArray <b><a href="qdesignermembersheetextension.html#parameterNames">parameterNames</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" />list-of-QByteArray <b><a href="qdesignermembersheetextension.html#parameterTypes">parameterTypes</a></b> (<i>self</i>, int <i>index</i>)</li><li><div class="fn" /><b><a href="qdesignermembersheetextension.html#setMemberGroup">setMemberGroup</a></b> (<i>self</i>, int <i>index</i>, QString <i>group</i>)</li><li><div class="fn" /><b><a href="qdesignermembersheetextension.html#setVisible">setVisible</a></b> (<i>self</i>, int <i>index</i>, bool <i>b</i>)</li><li><div class="fn" />QString <b><a href="qdesignermembersheetextension.html#signature">signature</a></b> (<i>self</i>, int <i>index</i>)</li></ul><h3>Special Methods</h3><ul><li><div class="fn" /> <b><a href="qdesignermembersheetextension.html#__len__">__len__</a></b> (<i>self</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QDesignerMemberSheetExtension 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>QDesignerMemberSheetExtension 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 class="highlightedCode brush: cpp">
QDesignerMemberSheetExtension *memberSheet = 0;
QExtensionManager manager = formEditor->extensionManager();
memberSheet = qt_extension<QDesignerMemberSheetExtension*>(manager, widget);
int index = memberSheet->indexOf(setEchoMode);
memberSheet->setVisible(index, false);
delete memberSheet;
</pre>
<p>When implementing a custom widget plugin, a pointer to <i>Qt
Designer</i>'s current <a href="qdesignerformeditorinterface.html">QDesignerFormEditorInterface</a>
object (<tt>formEditor</tt> in the example above) is provided by
the <a href="qdesignercustomwidgetinterface.html#initialize">QDesignerCustomWidgetInterface.initialize</a>()
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 <a href="qextensionmanager.html#qt_extension">qt_extension</a>() 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 QDesignerMemberSheetExtension also provides
an interface for creating custom member sheet extensions.</p>
<p><b>Warning:</b> <i>Qt Designer</i> uses the
QDesignerMemberSheetExtension 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="qobject.html">QObject</a> and
QDesignerMemberSheetExtension. Then, since we are implementing an
interface, we must ensure that it's made known to the meta object
system using the <a href="qobject.html#Q_INTERFACES">Q_INTERFACES</a>() macro:</p>
<pre class="highlightedCode brush: cpp">
class MyMemberSheetExtension : public QObject,
public QDesignerMemberSheetExtension
{
Q_OBJECT
Q_INTERFACES(QDesignerMemberSheetExtension)
public:
...
}
</pre>
<p>This enables <i>Qt Designer</i> to use <a href="qobject.html#qobject_cast">qobject_cast</a>() to query for
supported interfaces using nothing but a <a href="qobject.html">QObject</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 <a href="qextensionfactory.html">QExtensionFactory</a>, i.e a class that is
able to make an instance of your extension, and register it using
<i>Qt Designer</i>'s <a href="qextensionmanager.html">extension
manager</a>.</p>
<p>When a widget's member sheet extension is required, <i>Qt
Designer</i>'s <a href="qextensionmanager.html">extension
manager</a> will run through all its registered factories calling
<a href="qextensionfactory.html#createExtension">QExtensionFactory.createExtension</a>()
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>: <a href="qdesignercontainerextension.html">QDesignerContainerExtension</a>,
QDesignerMemberSheetExtension, <a href="qdesignerpropertysheetextension.html">QDesignerPropertySheetExtension</a>
and <a href="qdesignertaskmenuextension.html">QDesignerTaskMenuExtension</a>.
<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 <a href="qextensionfactory.html">QExtensionFactory</a> class
provides a standard extension factory, and can also be used as an
interface for custom extension factories. You can either create a
new <a href="qextensionfactory.html">QExtensionFactory</a> and
reimplement the <a href="qextensionfactory.html#createExtension">QExtensionFactory.createExtension</a>()
function. For example:</p>
<pre class="highlightedCode brush: cpp">
QObject *ANewExtensionFactory.createExtension(QObject *object,
const QString &iid, QObject *parent) const
{
if (iid != Q_TYPEID(QDesignerMemberSheetExtension))
return 0;
if (MyCustomWidget *widget = qobject_cast<MyCustomWidget*>
(object))
return new MyMemberSheetExtension(widget, parent);
return 0;
}
</pre>
<p>Or you can use an existing factory, expanding the <a href="qextensionfactory.html#createExtension">QExtensionFactory.createExtension</a>()
function to make the factory able to create a member sheet
extension as well. For example:</p>
<pre class="highlightedCode brush: cpp">
QObject *AGeneralExtensionFactory.createExtension(QObject *object,
const QString &iid, QObject *parent) const
{
MyCustomWidget *widget = qobject_cast<MyCustomWidget*>(object);
if (widget && (iid == Q_TYPEID(QDesignerTaskMenuExtension))) {
return new MyTaskMenuExtension(widget, parent);
} else if (widget && (iid == Q_TYPEID(QDesignerMemberSheetExtension))) {
return new MyMemberSheetExtension(widget, parent);
} else {
return 0;
}
}
</pre>
<p>For a complete example using an extension class, see <a href="designer-taskmenuextension.html">Task Menu Extension example</a>.
The example shows how to create a custom widget plugin for Qt
Designer, and how to to use the <a href="qdesignertaskmenuextension.html">QDesignerTaskMenuExtension</a>
class to add custom items to <i>Qt Designer</i>'s task menu.</p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QDesignerMemberSheetExtension" />QDesignerMemberSheetExtension.__init__ (<i>self</i>)</h3><h3 class="fn"><a name="QDesignerMemberSheetExtension-2" />QDesignerMemberSheetExtension.__init__ (<i>self</i>, <a href="qdesignermembersheetextension.html">QDesignerMemberSheetExtension</a>)</h3><h3 class="fn"><a name="count" />int QDesignerMemberSheetExtension.count (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the extension's number of member functions.</p>
<h3 class="fn"><a name="declaredInClass" />QString QDesignerMemberSheetExtension.declaredInClass (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the name of the class in which the member function with
the given <i>index</i> is declared.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>().</p>
<h3 class="fn"><a name="indexOf" />int QDesignerMemberSheetExtension.indexOf (<i>self</i>, QString <i>name</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the index of the member function specified by the given
<i>name</i>.</p>
<p>See also <a href="qdesignermembersheetextension.html#memberName">memberName</a>().</p>
<h3 class="fn"><a name="inheritedFromWidget" />bool QDesignerMemberSheetExtension.inheritedFromWidget (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns true if the member function with the given <i>index</i>
is inherited from <a href="qwidget.html">QWidget</a>, otherwise
false.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>().</p>
<h3 class="fn"><a name="isSignal" />bool QDesignerMemberSheetExtension.isSignal (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns true if the member function with the given <i>index</i>
is a signal, otherwise false.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>().</p>
<h3 class="fn"><a name="isSlot" />bool QDesignerMemberSheetExtension.isSlot (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns true if the member function with the given <i>index</i>
is a slot, otherwise false.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>().</p>
<h3 class="fn"><a name="isVisible" />bool QDesignerMemberSheetExtension.isVisible (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns true if the member function with the given <i>index</i>
is visible in <i>Qt Designer</i>'s signal and slot editor,
otherwise false.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>() and
<a href="qdesignermembersheetextension.html#setVisible">setVisible</a>().</p>
<h3 class="fn"><a name="memberGroup" />QString QDesignerMemberSheetExtension.memberGroup (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the name of the member group specified for the function
with the given <i>index</i>.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>() and
<a href="qdesignermembersheetextension.html#setMemberGroup">setMemberGroup</a>().</p>
<h3 class="fn"><a name="memberName" />QString QDesignerMemberSheetExtension.memberName (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the name of the member function with the given
<i>index</i>.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>().</p>
<h3 class="fn"><a name="parameterNames" />list-of-QByteArray QDesignerMemberSheetExtension.parameterNames (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the parameter names of the member function with the
given <i>index</i>, as a <a href="qbytearray.html">QByteArray</a>
list.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>() and
<a href="qdesignermembersheetextension.html#parameterTypes">parameterTypes</a>().</p>
<h3 class="fn"><a name="parameterTypes" />list-of-QByteArray QDesignerMemberSheetExtension.parameterTypes (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the parameter types of the member function with the
given <i>index</i>, as a <a href="qbytearray.html">QByteArray</a>
list.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>() and
<a href="qdesignermembersheetextension.html#parameterNames">parameterNames</a>().</p>
<h3 class="fn"><a name="setMemberGroup" />QDesignerMemberSheetExtension.setMemberGroup (<i>self</i>, int <i>index</i>, QString <i>group</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Sets the member group of the member function with the given
<i>index</i>, to <i>group</i>.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>() and
<a href="qdesignermembersheetextension.html#memberGroup">memberGroup</a>().</p>
<h3 class="fn"><a name="setVisible" />QDesignerMemberSheetExtension.setVisible (<i>self</i>, int <i>index</i>, bool <i>b</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>If <i>visible</i> is true, the member function with the given
<i>index</i> is visible in <i>Qt Designer</i>'s signals and slots
editing mode; otherwise the member function is hidden.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>() and
<a href="qdesignermembersheetextension.html#isVisible">isVisible</a>().</p>
<h3 class="fn"><a name="signature" />QString QDesignerMemberSheetExtension.signature (<i>self</i>, int <i>index</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Returns the signature of the member function with the given
<i>index</i>.</p>
<p>See also <a href="qdesignermembersheetextension.html#indexOf">indexOf</a>().</p>
<h3 class="fn"><a name="__len__" /> QDesignerMemberSheetExtension.__len__ (<i>self</i>)</h3><address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.8.3 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2011</td><td align="right" width="25%">Qt 4.7.1</td></tr></table></div></address></body></html>
