Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 1968

qtjambi-doc-4.3.3-3mdv2008.1.i586.rpm

<class name="QDesignerMemberSheetExtension" doc="/**
&lt;p&gt;The &lt;a href=&quot;QDesignerMemberSheetExtension.html#QDesignerMemberSheetExtension()&quot;&gt;&lt;tt&gt;QDesignerMemberSheetExtension&lt;/tt&gt;&lt;/a&gt; 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.&lt;/p&gt;
&lt;p&gt;&lt;a href=&quot;QDesignerMemberSheetExtension.html#QDesignerMemberSheetExtension()&quot;&gt;&lt;tt&gt;QDesignerMemberSheetExtension&lt;/tt&gt;&lt;/a&gt; is a collection of functions that is typically used to query a widget's member functions, and to manipulate the member functions' appearance in &lt;i&gt;Qt Designer&lt;/i&gt;'s signals and slots editing mode. For example:&lt;/p&gt;
&lt;pre&gt;    QDesignerMemberSheetExtension *memberSheet  = 0;
    QExtensionManager manager = formEditor-&amp;gt;extensionManager();

    memberSheet = qt_extension&amp;lt;QDesignerMemberSheetExtension*&amp;gt;(manager, widget);
    int index = memberSheet-&amp;gt;indexOf(setEchoMode);
    memberSheet-&amp;gt;setVisible(index, false);

    delete memberSheet;&lt;/pre&gt;
&lt;p&gt;When implementing a custom widget plugin, a pointer to &lt;i&gt;Qt Designer&lt;/i&gt;'s current QDesignerFormEditorInterface object (&lt;tt&gt;formEditor&lt;/tt&gt; in the example above) is provided by the QDesignerCustomWidgetInterface::initialize() function's parameter.&lt;/p&gt;
&lt;p&gt;The member sheet (and any other extension), can be retrieved by querying &lt;i&gt;Qt Designer&lt;/i&gt;'s extension manager using the qt_extension() function. When you want to release the extension, you only need to delete the pointer.&lt;/p&gt;
&lt;p&gt;All widgets have a default member sheet used in &lt;i&gt;Qt Designer&lt;/i&gt;'s signals and slots editing mode with the widget's member functions. But &lt;a href=&quot;QDesignerMemberSheetExtension.html#QDesignerMemberSheetExtension()&quot;&gt;&lt;tt&gt;QDesignerMemberSheetExtension&lt;/tt&gt;&lt;/a&gt; also provides an interface for creating custom member sheet extensions.&lt;/p&gt;
&lt;p&gt;&lt;b&gt;Warning:&lt;/b&gt; &lt;i&gt;Qt Designer&lt;/i&gt; uses the &lt;a href=&quot;QDesignerMemberSheetExtension.html#QDesignerMemberSheetExtension()&quot;&gt;&lt;tt&gt;QDesignerMemberSheetExtension&lt;/tt&gt;&lt;/a&gt; to facilitate the signal and slot editing mode. Whenever a connection between two widgets is requested, &lt;i&gt;Qt Designer&lt;/i&gt; 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.&lt;/p&gt;
&lt;p&gt;To create a member sheet extension, your extension class must inherit from both &lt;a href=&quot;%2E%2E/%2E%2E/qt/core/QObject.html&quot;&gt;&lt;tt&gt;QObject&lt;/tt&gt;&lt;/a&gt; and &lt;a href=&quot;QDesignerMemberSheetExtension.html#QDesignerMemberSheetExtension()&quot;&gt;&lt;tt&gt;QDesignerMemberSheetExtension&lt;/tt&gt;&lt;/a&gt;. 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:&lt;/p&gt;
&lt;pre&gt;    class MyMemberSheetExtension : public QObject,
            public QDesignerMemberSheetExtension
    {
        Q_OBJECT
        Q_INTERFACES(QDesignerMemberSheetExtension)

    public:
        ...
    }&lt;/pre&gt;
&lt;p&gt;This enables &lt;i&gt;Qt Designer&lt;/i&gt; to use qobject_cast() to query for supported interfaces using nothing but a &lt;a href=&quot;%2E%2E/%2E%2E/qt/core/QObject.html&quot;&gt;&lt;tt&gt;QObject&lt;/tt&gt;&lt;/a&gt; pointer.&lt;/p&gt;
&lt;p&gt;In &lt;i&gt;Qt Designer&lt;/i&gt; 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 &lt;i&gt;Qt Designer&lt;/i&gt;'s extension manager&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;When a widget's member sheet extension is required, &lt;i&gt;Qt Designer&lt;/i&gt;'s extension manager&lt;/tt&gt; 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, &lt;i&gt;Qt Designer&lt;/i&gt; will use the default member sheet.&lt;/p&gt;
&lt;p&gt;There are four available types of extensions in &lt;i&gt;Qt Designer&lt;/i&gt;: QDesignerContainerExtension, &lt;a href=&quot;QDesignerMemberSheetExtension.html#QDesignerMemberSheetExtension()&quot;&gt;&lt;tt&gt;QDesignerMemberSheetExtension&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QDesignerPropertySheetExtension.html&quot;&gt;&lt;tt&gt;QDesignerPropertySheetExtension&lt;/tt&gt;&lt;/a&gt; and QDesignerTaskMenuExtension. &lt;i&gt;Qt Designer&lt;/i&gt;'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.&lt;/p&gt;
&lt;p&gt;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:&lt;/p&gt;
&lt;pre&gt;     QObject *ANewExtensionFactory::createExtension(QObject *object,
             const QString &amp;amp;iid, QObject *parent) const
     {
         if (iid != Q_TYPEID(QDesignerMemberSheetExtension))
             return 0;

         if (MyCustomWidget *widget = qobject_cast&amp;lt;MyCustomWidget*&amp;gt;
                (object))
             return new MyMemberSheetExtension(widget, parent);

         return 0;
     }&lt;/pre&gt;
&lt;p&gt;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:&lt;/p&gt;
&lt;pre&gt;     QObject *AGeneralExtensionFactory::createExtension(QObject *object,
             const QString &amp;amp;iid, QObject *parent) const
     {
         MyCustomWidget *widget = qobject_cast&amp;lt;MyCustomWidget*&amp;gt;(object);

         if (widget &amp;amp;&amp;amp; (iid == Q_TYPEID(QDesignerTaskMenuExtension))) {
             return new MyTaskMenuExtension(widget, parent);

         } else if (widget &amp;amp;&amp;amp; (iid == Q_TYPEID(QDesignerMemberSheetExtension))) {
             return new MyMemberSheetExtension(widget, parent);

         } else {
             return 0;
         }
     }&lt;/pre&gt;
&lt;p&gt;For a complete example using an extension class, see Task Menu Extension example&lt;/tt&gt;. 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 &lt;i&gt;Qt Designer&lt;/i&gt;'s task menu.&lt;/p&gt;

@see &lt;tt&gt;QExtensionFactory&lt;/tt&gt;
@see &lt;tt&gt;QExtensionManager&lt;/tt&gt;
@see &lt;a href=&quot;%2E%2E/%2E%2E/qt/designer-creating-custom-widgets-extensions.html&quot;&gt;Creating Custom Widget Extensions&lt;/tt&gt;&lt;/a&gt; */">
    <method name="public QDesignerMemberSheetExtension()"/>
    <method name="public abstract int count()" doc="/**
&lt;p&gt;Returns the extension's number of member functions.&lt;/p&gt;
 */"/>
    <method name="public abstract java.lang.String declaredInClass(int index)" doc="/**
&lt;p&gt;Returns the name of the class in which the member function with the given &lt;tt&gt;index&lt;/tt&gt; is declared.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract int indexOf(java.lang.String name)" doc="/**
&lt;p&gt;Returns the index of the member function specified by the given &lt;tt&gt;name&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#memberName(int)&quot;&gt;&lt;tt&gt;memberName&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract boolean inheritedFromWidget(int index)" doc="/**
&lt;p&gt;Returns true if the member function with the given &lt;tt&gt;index&lt;/tt&gt; is inherited from &lt;a href=&quot;%2E%2E/%2E%2E/qt/gui/QWidget.html&quot;&gt;&lt;tt&gt;QWidget&lt;/tt&gt;&lt;/a&gt;, otherwise false.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract boolean isSignal(int index)" doc="/**
&lt;p&gt;Returns true if the member function with the given &lt;tt&gt;index&lt;/tt&gt; is a signal, otherwise false.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract boolean isSlot(int index)" doc="/**
&lt;p&gt;Returns true if the member function with the given &lt;tt&gt;index&lt;/tt&gt; is a slot, otherwise false.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract boolean isVisible(int index)" doc="/**
&lt;p&gt;Returns true if the member function with the given &lt;tt&gt;index&lt;/tt&gt; is visible in &lt;i&gt;Qt Designer&lt;/i&gt;'s signal and slot editor, otherwise false.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#setVisible(int, boolean)&quot;&gt;&lt;tt&gt;setVisible&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract java.lang.String memberGroup(int index)" doc="/**
&lt;p&gt;Returns the name of the member group specified for the function with the given &lt;tt&gt;index&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#setMemberGroup(int, java.lang.String)&quot;&gt;&lt;tt&gt;setMemberGroup&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract java.lang.String memberName(int index)" doc="/**
&lt;p&gt;Returns the name of the member function with the given &lt;tt&gt;index&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract java.util.List&lt;com.trolltech.qt.core.QByteArray&gt; parameterNames(int index)" doc="/**
&lt;p&gt;Returns the parameter names of the member function with the given &lt;tt&gt;index&lt;/tt&gt;, as a &lt;a href=&quot;%2E%2E/%2E%2E/qt/core/QByteArray.html&quot;&gt;&lt;tt&gt;QByteArray&lt;/tt&gt;&lt;/a&gt; list.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#parameterTypes(int)&quot;&gt;&lt;tt&gt;parameterTypes&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract java.util.List&lt;com.trolltech.qt.core.QByteArray&gt; parameterTypes(int index)" doc="/**
&lt;p&gt;Returns the parameter types of the member function with the given &lt;tt&gt;index&lt;/tt&gt;, as a &lt;a href=&quot;%2E%2E/%2E%2E/qt/core/QByteArray.html&quot;&gt;&lt;tt&gt;QByteArray&lt;/tt&gt;&lt;/a&gt; list.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#parameterNames(int)&quot;&gt;&lt;tt&gt;parameterNames&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract void setMemberGroup(int index, java.lang.String group)" doc="/**
&lt;p&gt;Sets the member group of the member function with the given &lt;tt&gt;index&lt;/tt&gt;, to &lt;tt&gt;group&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#memberGroup(int)&quot;&gt;&lt;tt&gt;memberGroup&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract void setVisible(int index, boolean b)" doc="/**
&lt;p&gt;If &lt;tt&gt;b&lt;/tt&gt; is true, the member function with the given &lt;tt&gt;index&lt;/tt&gt; is visible in &lt;i&gt;Qt Designer&lt;/i&gt;'s signals and slots editing mode; otherwise the member function is hidden.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#isVisible(int)&quot;&gt;&lt;tt&gt;isVisible&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public abstract java.lang.String signature(int index)" doc="/**
&lt;p&gt;Returns the signature of the member function with the given &lt;tt&gt;index&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QDesignerMemberSheetExtension.html#indexOf(java.lang.String)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt; */"/>
</class>