QDesignerFormWindowInterface Class

QDesignerFormWindowInterface クラスを使用すると、Qt Widgets Designer のワークスペースに表示されるフォームウィンドウを照会および操作できます。詳細...

Header: #include <QDesignerFormWindowInterface>
CMake: find_package(Qt6 REQUIRED COMPONENTS Designer)
target_link_libraries(mytarget PRIVATE Qt6::Designer)
qmake: QT += designer
Inherits: QWidget

パブリック型

flags Feature
enum FeatureFlag { EditFeature, GridFeature, TabOrderFeature, DefaultFeature }
enum ResourceFileSaveMode { SaveAllResourceFiles, SaveOnlyUsedResourceFiles, DontSaveResourceFiles }

パブリック関数

QDesignerFormWindowInterface(QWidget *parent = nullptr, Qt::WindowFlags flags = {})
virtual ~QDesignerFormWindowInterface()
virtual QDir absoluteDir() const = 0
QStringList activeResourceFilePaths() const
virtual void addResourceFile(const QString &path) = 0
virtual QString author() const = 0
virtual QStringList checkContents() const = 0
virtual QString comment() const = 0
virtual QString contents() const = 0
virtual QDesignerFormEditorInterface *core() const
virtual QDesignerFormWindowCursorInterface *cursor() const = 0
virtual void emitSelectionChanged() = 0
virtual QString exportMacro() const = 0
virtual QDesignerFormWindowInterface::Feature features() const = 0
virtual QString fileName() const = 0
virtual QWidget *formContainer() const = 0
virtual QPoint grid() const = 0
virtual bool hasFeature(QDesignerFormWindowInterface::Feature feature) const = 0
virtual QStringList includeHints() const = 0
virtual bool isDirty() const = 0
virtual bool isManaged(QWidget *widget) const = 0
virtual void layoutDefault(int *margin, int *spacing) = 0
virtual void layoutFunction(QString *margin, QString *spacing) = 0
virtual QString pixmapFunction() const = 0
virtual void removeResourceFile(const QString &path) = 0
virtual QDesignerFormWindowInterface::ResourceFileSaveMode resourceFileSaveMode() const = 0
virtual QStringList resourceFiles() const = 0
virtual void setAuthor(const QString &author) = 0
virtual void setComment(const QString &comment) = 0
virtual bool setContents(QIODevice *device, QString *errorMessage = 0) = 0
virtual void setExportMacro(const QString &exportMacro) = 0
virtual void setIncludeHints(const QStringList &includeHints) = 0
virtual void setLayoutDefault(int margin, int spacing) = 0
virtual void setLayoutFunction(const QString &margin, const QString &spacing) = 0
virtual void setMainContainer(QWidget *mainContainer) = 0
virtual void setPixmapFunction(const QString &pixmapFunction) = 0
virtual void setResourceFileSaveMode(QDesignerFormWindowInterface::ResourceFileSaveMode behavior) = 0

パブリックスロット

void activateResourceFilePaths(const QStringList &paths, int *errorCount = nullptr, QString *errorMessages = nullptr)
virtual void clearSelection(bool update = true) = 0
virtual void manageWidget(QWidget *widget) = 0
virtual void selectWidget(QWidget *widget, bool select = true) = 0
virtual bool setContents(const QString &contents) = 0
virtual void setDirty(bool dirty) = 0
virtual void setFeatures(QDesignerFormWindowInterface::Feature features) = 0
virtual void setFileName(const QString &fileName) = 0
virtual void setGrid(const QPoint &grid) = 0
virtual void unmanageWidget(QWidget *widget) = 0

シグナル

void aboutToUnmanageWidget(QWidget *widget)
void activated(QWidget *widget)
void changed()
void featureChanged(QDesignerFormWindowInterface::Feature feature)
void fileNameChanged(const QString &fileName)
void geometryChanged()
void mainContainerChanged(QWidget *mainContainer)
void objectRemoved(QObject *object)
void resourceFilesChanged()
void selectionChanged()
void widgetManaged(QWidget *widget)
void widgetRemoved(QWidget *widget)
void widgetUnmanaged(QWidget *widget)

静的パブリック・メンバー

QDesignerFormWindowInterface *findFormWindow(QObject *object)
QDesignerFormWindowInterface *findFormWindow(QWidget *widget)

詳細説明

QDesignerFormWindowInterfaceは、関連するフォームウィンドウに関する情報を提供し、そのプロパティを変更できるようにします。このインターフェイスは直接インスタンス化することを意図しておらず、Qt Widgets Designerのform window manager によって制御されるQt Widgets Designerの現在のフォームウィンドウへのアクセスを提供します。

特定のウィジェットを含むフォーム・ウィンドウを探す場合は、静的なQDesignerFormWindowInterface::findFormWindow() 関数を使用できます:

    auto *formWindow = QDesignerFormWindowInterface::findFormWindow(myWidget);

また、Qt Widgets Designer のフォーム・ウィンドウ・マネージャを使用して、現在のフォーム・ウィンドウにアクセスすることもできます:QDesignerFormEditorInterface::formWindowManager() 関数を使用して、マネージャへのインターフェースを取得します。このインターフェイスを取得すると、QDesignerFormWindowManagerInterface::formWindow ()関数を通してQt Widgets Designerの現在のフォームウィンドウすべてにアクセスできるようになります。例えば

    QList<QDesignerFormWindowInterface *> forms;

    auto *manager = formEditor->formWindowManager();

    for (int i = 0; i < manager->formWindowCount(); ++i)
        forms.append(manager->formWindow(i));

Qt Widgets Designerの現在のQDesignerFormEditorInterface オブジェクト(上記の例ではformEditor )へのポインタは、QDesignerCustomWidgetInterface::initialize ()関数のパラメータによって提供されます。カスタムウィジェットプラグインを実装する場合、QDesignerCustomWidgetInterface クラスをサブクラス化し、Qt Widgets Designer にプラグインを公開する必要があります。

フォーム・ウィンドウを取得したら、そのプロパティを問い合わせることができます。例えば、プレーン・カスタム・ウィジェット・プラグインはQt Widgets Designerによってトップ・レベルでのみ管理されます。しかし、QDesignerFormWindowInterfaceには、ウィジェットをQt Widgets Designerで管理するかどうかを制御できる関数が用意されています:

        if (formWindow->isManaged(myWidget))
            formWindow->manageWidget(myWidget->childWidget);

ウィジェット管理に関する関数の完全なリストは、isManaged()、manageWidget()、unmanageWidget()です。また、関連するシグナルもいくつかあります:widgetManaged(),widgetRemoved(),aboutToUnmanageWidget(),widgetUnmanaged()。

ウィジェットの管理だけでなく、selectWidget()、clearSelection()、emitSelectionChanged()関数や、selectionChanged()シグナルを使用して、フォーム・ウィンドウの現在の選択を制御することもできます。

また、absoluteDir()を使ってフォームの保存場所、includeHints()を使ってインクルード・ファイル、layoutDefault()、layoutFunction()、pixmapFunction()を使ってレイアウトとピクセルマップ関数の情報を取得できます。フォーム・ウィンドウが変更されたかどうか(保存されていないかどうか)は、isDirty() 関数で調べることができます。author(),contents(),fileName(),comment(),exportMacro(), mainContainer(),features(),grid(),resourceFiles() を取得することができます。

インターフェイスには関数とスロットが用意されており、これらの情報のほとんどを変更することができます。例外は、フォーム・ウィンドウを格納するディレクトリです。最後に、上記の情報やフォーム・ウィンドウ全般の変更に関連するシグナルがいくつかあります。

QDesignerFormWindowCursorInterfaceQDesignerFormEditorInterfaceQDesignerFormWindowManagerInterfaceも参照のこと

メンバ型ドキュメント

enum QDesignerFormWindowInterface::FeatureFlag
flags QDesignerFormWindowInterface::Feature

この列挙型は、フォーム・ウィンドウ・インターフェースで使用可能で制御可能な機能を記述します。これらの値は、フォーム・ウィンドウがどの機能をサポートしているかを問い合わせるときに使用されます:

定数説明
QDesignerFormWindowInterface::EditFeature0x01フォーム編集
QDesignerFormWindowInterface::GridFeature0x02編集のためのグリッド表示とスナップ・ツー・グリッド機能
QDesignerFormWindowInterface::TabOrderFeature0x04タブの順序管理
QDesignerFormWindowInterface::DefaultFeatureEditFeature | GridFeatureデフォルト機能のサポート(フォーム編集とグリッド)

Feature型はQFlags<FeatureFlag>の型定義である。これは、FeatureFlag値のORの組み合わせを格納します。

hasFeature() およびfeatures()も参照してください

enum QDesignerFormWindowInterface::ResourceFileSaveMode

この列挙型は、リソース・ファイルの保存方法を記述します。

定数説明
QDesignerFormWindowInterface::SaveAllResourceFiles0すべてのリソースファイルを保存します。
QDesignerFormWindowInterface::SaveOnlyUsedResourceFiles1フォームが使用するリソースファイルを保存します。
QDesignerFormWindowInterface::DontSaveResourceFiles2リソースファイルを保存しない

メンバ関数 ドキュメント

[explicit] QDesignerFormWindowInterface::QDesignerFormWindowInterface(QWidget *parent = nullptr, Qt::WindowFlags flags = {})

与えられたparent と指定されたウィンドウflags でフォームウィンドウインターフェイスを構築します。

[virtual noexcept] QDesignerFormWindowInterface::~QDesignerFormWindowInterface()

フォーム・ウィンドウ・インターフェースを破棄します。

[signal] void QDesignerFormWindowInterface::aboutToUnmanageWidget(QWidget *widget)

このシグナルは、フォーム上のウィジェットがアンマネージされそうになるたびに 発せられます。このシグナルが発せられたとき、指定されたwidget はまだ管理されており、widgetUnmanaged() シグナルが続いて発せられ、管理されなくなったことを示します。

unmanageWidget() およびisManaged()も参照のこと

[pure virtual] QDir QDesignerFormWindowInterface::absoluteDir() const

フォーム・ウィンドウに表示されているフォームを含むディレクトリの絶対位置を返します。

[slot] void QDesignerFormWindowInterface::activateResourceFilePaths(const QStringList &paths, int *errorCount = nullptr, QString *errorMessages = nullptr)

リソース(.qrc)ファイルのパスpaths をアクティブにし、errorCount にエラーのカウントを、errorMessages にエラーメッセージを返します。Qt Widgets Designerは、QResource クラスを使用してリソースをロードし、フォームの編集に利用できるようにします。

IDE 統合では、プロジェクトのリソース (.qrc) ファイルのリストをアクティブにして、Qt Widgets Designer で利用できるようにすることができます。

activeResourceFilePaths() およびQResourceも参照してください

[signal] void QDesignerFormWindowInterface::activated(QWidget *widget)

このシグナルは、フォーム上でウィジェットがアクティブになるたびに発行されます。アクティブ化されたウィジェットはwidget で指定します。

QStringList QDesignerFormWindowInterface::activeResourceFilePaths() const

Qt Widgets Designer で現在ロードされているアクティブなリソース (.qrc) ファイルのパスを返します。

activateResourceFilePaths()も参照してください

[pure virtual] void QDesignerFormWindowInterface::addResourceFile(const QString &path)

指定されたpath にあるリソースファイルを、フォームで使用するリソースファイルに追加します。

resourceFiles() およびresourceFilesChanged() も参照して ください。

[pure virtual] QString QDesignerFormWindowInterface::author() const

現在ウィンドウに表示されているフォームの作者または作成者の詳細を返します。

setAuthor() も参照

[signal] void QDesignerFormWindowInterface::changed()

このシグナルは、フォームが変更されるたびに発行されます。

[pure virtual] QStringList QDesignerFormWindowInterface::checkContents() const

現在のフォームのチェックを行い、潜在的な問題 (たとえば、フォームのトップレベルのスペーサーなど) についてのリッチテキスト警告のリストを返します。

IDE 統合は、保存操作を開始する前にこれを呼び出すことができます。

[pure virtual slot] void QDesignerFormWindowInterface::clearSelection(bool update = true)

フォームウィンドウの現在の選択をクリアします。update が true の場合、emitSelectionChanged() 関数が呼び出され、selectionChanged() シグナルが出力されます。

selectWidget()も参照

[pure virtual] QString QDesignerFormWindowInterface::comment() const

現在ウィンドウに表示されているフォームに関するコメントを返します。

setComment() も参照

[pure virtual] QString QDesignerFormWindowInterface::contents() const

現在ウィンドウに表示されているフォームの内容の詳細を返します。

setContents() も参照 ください。

[virtual] QDesignerFormEditorInterface *QDesignerFormWindowInterface::core() const

Qt Widgets Designer の現在のQDesignerFormEditorInterface オブジェクトへのポインタを返します。

[pure virtual] QDesignerFormWindowCursorInterface *QDesignerFormWindowInterface::cursor() const

フォーム・ウィンドウで使用されているカーソル・インターフェースを返します。

[pure virtual] void QDesignerFormWindowInterface::emitSelectionChanged()

selectionChanged() シグナルを発行します。

selectWidget() およびclearSelection()も参照してください

[pure virtual] QString QDesignerFormWindowInterface::exportMacro() const

現在ウィンドウに表示されているフォームに関連付けられたエクスポート・マクロを返します。エクスポート・マクロは、ウィジェット・プラグインを作成するためにフォームがコンパイルされるときに使用されます。

setExportMacro() およびCreating Custom Widgets for Qt Widgets Designerも参照して ください。

[signal] void QDesignerFormWindowInterface::featureChanged(QDesignerFormWindowInterface::Feature feature)

このシグナルは、フォームの機能が変更されるたびに発行されます。新しい機能はfeature で指定します。

setFeatures()も参照して ください。

[pure virtual] QDesignerFormWindowInterface::Feature QDesignerFormWindowInterface::features() const

インターフェイスに関連付けられたフォームウィンドウが提供する機能の組み合わせを返します。返された値をFeature の列挙値と比較することで、どの機能がウィンドウでサポートされているかを判定することができます。

setFeatures() およびhasFeature()も参照

[pure virtual] QString QDesignerFormWindowInterface::fileName() const

現在表示されているフォームを記述する UI ファイルのファイル名を返します。

setFileName()も参照

[signal] void QDesignerFormWindowInterface::fileNameChanged(const QString &fileName)

このシグナルは、フォームのファイル名が変更されるたびに発行されます。新しいファイル名はfileName で指定される。

setFileName()も参照

[static] QDesignerFormWindowInterface *QDesignerFormWindowInterface::findFormWindow(QObject *object)

与えられたobject のフォーム・ウィンドウ・インターフェースを返す。

[static] QDesignerFormWindowInterface *QDesignerFormWindowInterface::findFormWindow(QWidget *widget)

指定されたwidget のフォーム・ウィンドウ・インターフェースを返します。

[pure virtual] QWidget *QDesignerFormWindowInterface::formContainer() const

メイン・コンテナ・ウィジェットを含むフォーム・ウィジェットを返します。

[signal] void QDesignerFormWindowInterface::geometryChanged()

このシグナルは、フォームのジオメトリが変更されるたびに発行されます。

[pure virtual] QPoint QDesignerFormWindowInterface::grid() const

フォーム・ウィンドウが使用するグリッド間隔を返します。

setGrid()も参照してください

[pure virtual] bool QDesignerFormWindowInterface::hasFeature(QDesignerFormWindowInterface::Feature feature) const

フォーム・ウィンドウが指定されたfeature を提供している場合は true を返し、そうでない場合は false を返します。

features() も参照

[pure virtual] QStringList QDesignerFormWindowInterface::includeHints() const

フォーム・ウィンドウの関連 UI ファイルに含まれるヘッダ・ファイルのリストを返します。

ヘッダーファイルは、ローカルなもの、つまりプロジェクトのディレクトリに相対的なもの、"mywidget.h" 、またはグローバルなもの、つまり Qt やコンパイラの標準ライブラリの一部、<QtGui/QWidget> のいずれかになります。

setIncludeHints()も参照してください

[pure virtual] bool QDesignerFormWindowInterface::isDirty() const

フォームウィンドウが "ダーティ"(変更されたが保存されていない)であればtrueを返し、そうでなければfalseを返します。

setDirty()も参照

[pure virtual] bool QDesignerFormWindowInterface::isManaged(QWidget *widget) const

指定されたwidget がフォーム・ウィンドウで管理されていれば真を返し、そうでなければ偽を返す。

manageWidget() も参照

[pure virtual] void QDesignerFormWindowInterface::layoutDefault(int *margin, int *spacing)

指定されたmargin およびspacing 変数に、フォームのデフォルト・レイアウトのマージンおよびスペーシングを記入します。

setLayoutDefault() も参照

[pure virtual] void QDesignerFormWindowInterface::layoutFunction(QString *margin, QString *spacing)

指定されたmargin 変数およびspacing 変数に、フォームのレイアウトの現在のマージンおよびスペーシングを記入します。

setLayoutFunction()も参照

[signal] void QDesignerFormWindowInterface::mainContainerChanged(QWidget *mainContainer)

このシグナルは、メイン・コンテナが変更されるたびに発せられます。新しいコンテナはmainContainer で指定される。

setMainContainer()も参照

[pure virtual slot] void QDesignerFormWindowInterface::manageWidget(QWidget *widget)

指定されたwidget を管理するようにフォーム・ウィンドウに指示します。

isManaged()、unmanageWidget()、widgetManaged()も参照

[signal] void QDesignerFormWindowInterface::objectRemoved(QObject *object)

このシグナルは、オブジェクト(アクションやQButtonGroup など)が フォームから削除されるたびに発せられる。削除されたオブジェクトはobject で指定します。

[pure virtual] QString QDesignerFormWindowInterface::pixmapFunction() const

pixmap 関数 pixmap をフォーム・ウィンドウにロードするために使用される関数の名前を返します。

setPixmapFunction()も参照して ください。

[pure virtual] void QDesignerFormWindowInterface::removeResourceFile(const QString &path)

指定されたpath にあるリソース・ファイルを、フォームが使用する リストの中から削除します。

resourceFiles() およびresourceFilesChanged() も参照

[pure virtual] QDesignerFormWindowInterface::ResourceFileSaveMode QDesignerFormWindowInterface::resourceFileSaveMode() const

リソース・ファイル保存モードの動作を返します。

setResourceFileSaveMode() も参照

[pure virtual] QStringList QDesignerFormWindowInterface::resourceFiles() const

リソース・ファイル・パス 現在フォーム・ウィンドウが使用しているリソース・ファイルのパスの一覧を返します。

addResourceFile() およびremoveResourceFile() も参照

[signal] void QDesignerFormWindowInterface::resourceFilesChanged()

このシグナルは、フォームが使用しているリソース・ファイルのリストが変更されるたびに発行されます。

resourceFiles() も参照

[pure virtual slot] void QDesignerFormWindowInterface::selectWidget(QWidget *widget, bool select = true)

select が true の場合、与えられたwidget が選択され、そうでない場合はwidget が選択解除される。

clearSelection() およびselectionChanged() も参照

[signal] void QDesignerFormWindowInterface::selectionChanged()

このシグナルは、フォームの選択が変更されるたびに発せられます。

selectWidget() およびclearSelection() も参照

[pure virtual] void QDesignerFormWindowInterface::setAuthor(const QString &author)

フォームの作成者または作成者の詳細を、指定されたauthor に設定します。

author() も参照

[pure virtual] void QDesignerFormWindowInterface::setComment(const QString &comment)

フォームに関する情報をcomment に設定します。この情報は、フォームに関する人間が読めるコメントでなければなりません。

comment() も参照

[pure virtual slot] bool QDesignerFormWindowInterface::setContents(const QString &contents)

指定されたcontents 文字列から読み込んだデータを使用してフォームの内容を設定し、 操作が成功したかどうかを返します。

contents() も参照

[pure virtual] bool QDesignerFormWindowInterface::setContents(QIODevice *device, QString *errorMessage = 0)

指定されたdevice から取得したデータを使用してフォームの内容を設定し、 読み込みが成功したかどうかを返します。失敗した場合は、エラー・メッセージがerrorMessage に返されます。

データはQFile オブジェクトまたはQIODevice の他のサブクラスから読み込むことができます。

[pure virtual slot] void QDesignerFormWindowInterface::setDirty(bool dirty)

dirty がtrueの場合、フォーム・ウィンドウはダーティとマークされ、 変更はされるが保存はされない。dirty が偽の場合、フォーム・ウィンドウは変更されていないとみなされます。

isDirty()も参照してください

[pure virtual] void QDesignerFormWindowInterface::setExportMacro(const QString &exportMacro)

フォームウィンドウのエクスポートマクロをexportMacro に設定します。 エクスポートマクロは、フォームのインターフェイスを他のコンポーネントにエクスポートするために、 ウィジェットプラグインをビルドするときに使用されます。

exportMacro()も参照

[pure virtual slot] void QDesignerFormWindowInterface::setFeatures(QDesignerFormWindowInterface::Feature features)

フォーム・ウィンドウの指定されたfeatures を有効にします。

features() およびfeatureChanged() も参照

[pure virtual slot] void QDesignerFormWindowInterface::setFileName(const QString &fileName)

フォームのファイル名を指定されたfileName に設定します。

fileName() およびfileNameChanged()も参照

[pure virtual slot] void QDesignerFormWindowInterface::setGrid(const QPoint &grid)

フォーム・ウィンドウのグリッド・サイズをgrid で指定された点に設定します。この関数では、QPoint の座標を使ってグリッド内の矩形の寸法を指定します。

grid()も参照

[pure virtual] void QDesignerFormWindowInterface::setIncludeHints(const QStringList &includeHints)

フォーム・ウィンドウの関連 UI ファイルに含まれるヘッダー・ファイルを、指定されたincludeHints に設定します。

ヘッダーファイルは、ローカルなもの、つまりプロジェクトのディレクトリに相対的なもの、"mywidget.h" 、またはグローバルなもの、つまり Qt やコンパイラの標準ライブラリの一部、<QtGui/QWidget> のいずれかになります。

includeHints()も参照してください

[pure virtual] void QDesignerFormWindowInterface::setLayoutDefault(int margin, int spacing)

フォームのレイアウトにデフォルトのmarginspacing を設定します。

layoutDefault() も参照して ください。

[pure virtual] void QDesignerFormWindowInterface::setLayoutFunction(const QString &margin, const QString &spacing)

フォームのレイアウトにmarginspacing を設定します。

デフォルトのレイアウト・プロパティは、uic がフォームのコードを生成するとき、つまり関数が指定されたときに、対応するレイアウト関数に置き換えられます。これは、異なる環境で同じフォームに異なるレイアウトが要求される場合に便利です。

layoutFunction()も参照してください

[pure virtual] void QDesignerFormWindowInterface::setMainContainer(QWidget *mainContainer)

フォームのメイン・コンテナ・ウィジェットを、指定されたmainContainer に設定します。

mainContainerChanged() も参照

[pure virtual] void QDesignerFormWindowInterface::setPixmapFunction(const QString &pixmapFunction)

フォーム・ウィンドウに pixmap を読み込む関数を、指定されたpixmapFunction に設定します。

pixmapFunction() も参照して ください。

[pure virtual] void QDesignerFormWindowInterface::setResourceFileSaveMode(QDesignerFormWindowInterface::ResourceFileSaveMode behavior)

リソース・ファイルの保存モードを設定しますbehavior

resourceFileSaveMode() も参照

[pure virtual slot] void QDesignerFormWindowInterface::unmanageWidget(QWidget *widget)

指定されたwidget を管理しないようにフォーム・ウィンドウに指示します。

aboutToUnmanageWidget() およびwidgetUnmanaged() も参照

[signal] void QDesignerFormWindowInterface::widgetManaged(QWidget *widget)

このシグナルは、フォーム上のウィジェットが管理されるようになるたびに発せられます。新しく管理されるウィジェットはwidget で指定されます。

manageWidget()も参照

[signal] void QDesignerFormWindowInterface::widgetRemoved(QWidget *widget)

このシグナルは、フォームからウィジェットが削除されるたびに発せられます。削除されたウィジェットはwidget で指定される。

[signal] void QDesignerFormWindowInterface::widgetUnmanaged(QWidget *widget)

このシグナルは、フォーム上のウィジェットがアンマネージドになるたびに発せられます。新しく解放されたウィジェットはwidget で指定されます。

unmanageWidget() とaboutToUnmanageWidget()も参照してください

©2024 The Qt Company Ltd. 本書に含まれるドキュメントのコントリビューションの著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。