QDesignerTaskMenuExtension Class

詳細な説明

QDesignerTaskMenuExtension は、カスタムタスクメニュー拡張機能を作成するためのインターフェースを提供します。これは通常、Qt Widgets Designer 内のプラグイン固有のタスクメニュー項目を作成するために使用されます。

Qt Widgets Designer Qt Widgets Designer は、QDesignerTaskMenuExtensionを使用してタスクメニューを構成します。タスクメニューが要求されるたびに、 は選択されたウィジェットのタスクメニュー拡張機能を照会します。

Qt Widgets Designerのコンテキストメニューにある、カスタム「状態の編集...」アクションのスクリーンショット。" src="images/taskmenuextension-example.webp" title="Qt Widgets Designerのコンテキストメニューにある、カスタム「状態の編集...」アクションのスクリーンショット。"/>

タスクメニュー拡張機能は、QAction の集合体です。指定された拡張機能を持つプラグインが選択されると、これらのアクションがタスクメニューのエントリとして表示されます。上の画像は、Qt Widgets Designer のデフォルトのタスクメニューエントリ（「切り取り」、「コピー」、「貼り付け」など）に加えて表示される、カスタムアクション「状態の編集...」を示しています。

カスタムタスクメニュー拡張機能を作成するには、拡張クラスがQObject と QDesignerTaskMenuExtension の両方を継承する必要があります。例えば：

class MyTaskMenuExtension : public QObject,
        public QDesignerTaskMenuExtension
{
    Q_OBJECT
    Q_INTERFACES(QDesignerTaskMenuExtension)

public:
    MyTaskMenuExtension(MyCustomWidget *widget, QObject *parent);

    QAction *preferredEditAction() const;
    QList<QAction *> taskActions() const;

private slots:
    void mySlot();

private:
    MyCustomWidget *widget;
    QAction *myAction;
};

インターフェースを実装しているため、Q_INTERFACES() マクロを使用して、そのインターフェースがメタオブジェクトシステムに認識されるようにする必要があります。これにより、Qt Widgets Designer はqobject_cast()関数を使用して、QObject ポインタのみを用いてサポートされているインターフェースを照会できるようになります。

また、taskActions() 関数を再実装し、Qt Widgets Designer のタスクメニューに含まれるアクションのリストを返すようにする必要があります。 オプションとして、preferredEditAction() 関数を再実装して、プラグインを選択してF2 キーを押したときに呼び出されるアクションを設定することもできます。優先される編集アクションは、taskActions() によって返されるアクションのいずれかでなければなりません。定義されていない場合、F2キーの押下は単に無視されます。

Qt Widgets Designer では、拡張機能は必要とされるまで作成されません。たとえば、タスクメニュー拡張機能は、Qt Widgets Designer のワークスペース内のウィジェット上でマウスの右ボタンをクリックしたときに作成されます。そのため、QExtensionFactory またはそのサブクラスを使用して拡張機能ファクトリを構築し、Qt Widgets Designer のextension manager を使用して登録する必要があります。

タスクメニュー拡張が必要になると、Qt Widgets Designer のextension manager は、登録されているすべてのファクトリを順に処理し、各ファクトリに対してQExtensionFactory::createExtension()を呼び出し、選択されたウィジェット用のタスクメニュー拡張を作成できるファクトリが見つかるまで続けます。その後、そのファクトリが拡張のインスタンスを作成します。

Qt Widgets Designer では、QDesignerContainerExtension 、QDesignerMemberSheetExtension 、QDesignerPropertySheetExtension 、および QDesignerTaskMenuExtension の4種類の拡張機能が利用可能です。Qt Widgets Designer の動作は、要求された拡張機能がコンテナ、メンバーシート、プロパティシート、またはタスクメニューのいずれに関連付けられているかに関わらず同じです。

QExtensionFactory クラスは標準の拡張機能ファクトリを提供しており、カスタム拡張機能ファクトリのインターフェースとしても使用できます。新しいQExtensionFactory を作成し、QExtensionFactory::createExtension()関数を再実装することもできます。例：

QObject *ANewExtensionFactory::createExtension(QObject *object,
        const QString &iid, QObject *parent) const
{
    if (iid != Q_TYPEID(QDesignerTaskMenuExtension))
        return 0;

    if (MyCustomWidget *widget = qobject_cast<MyCustomWidget*>(object))
        return new MyTaskMenuExtension(widget, parent);

    return 0;
}

あるいは、既存のファクトリを使用し、QExtensionFactory::createExtension() 関数を拡張して、そのファクトリがタスクメニュー拡張も作成できるようにすることもできます。例えば：

QObject *AGeneralExtensionFactory::createExtension(QObject *object,
        const QString &iid, QObject *parent) const
{
    MyCustomWidget *widget = qobject_cast<MyCustomWidget*>(object);

    if (widget && (iid == Q_TYPEID(QDesignerContainerExtension))) {
        return new MyContainerExtension(widget, parent);

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

    } else {
        return 0;
    }
}

QDesignerTaskMenuExtension クラスを使用した完全な例については、「タスクメニュー拡張機能」の例を参照してください。この例では、Qt Widgets Designer 用のカスタムウィジェットプラグインの作成方法と、QDesignerTaskMenuExtension クラスを使用してQt Widgets Designer のタスクメニューにカスタム項目を追加する方法を示しています。