Класс QDesignerFormWindowInterface

Класс QDesignerFormWindowInterface позволяет запрашивать и изменять окна форм, отображаемые в рабочем пространстве Qt Designer. Подробнее...

• Список всех членов, включая унаследованные

Общие типы

Общедоступные функции

Открытые слоты

Сигналы

Статические публичные члены

Подробное описание

QDesignerFormWindowInterface предоставляет информацию об ассоциированном окне формы, а также позволяет изменять его свойства. Интерфейс не предназначен для прямого создания, но для предоставления доступа к текущим окнам форм Qt Designer, управляемыми менеджером окон форм Qt Designer.

Если вам нужно найти окно формы, содержащее определённый виджет, вы можете использовать статическую функцию QDesignerFormWindowInterface::findFormWindow():

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

Но кроме того, вы можете получить доступ к любому из текущих окон форм через менеджер окон форм Qt Designer: Используйте функцию QDesignerFormEditorInterface::formWindowManager() для получения интерфейса к менеджеру. После этого вы можете получить доступ ко всем текущим окнам форм Qt Designer с помощью функции QDesignerFormWindowManagerInterface::formWindow(). Например:

    QList<QDesignerFormWindowInterface *> forms;
    QDesignerFormWindowInterface *formWindow;

    QDesignerFormWindowManagerInterface *manager = formEditor->formWindowManager();

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

Указатель на текущий объект QDesignerFormEditorInterface Qt Designer (formEditor в примере выше) предоставляется параметром функции QDesignerCustomWidgetInterface::initialize(). При реализации плагина пользовательского виджета вы должны унаследовать класс QDesignerCustomWidgetInterface, чтобы предоставить свой плагин Qt Designer.

После получения окна формы вы можете запросить его свойства. Например, обычный плагин пользовательского виджета управляется Qt Designer только на верхнем уровне, т. е. ни один из его дочерних виджетов не может быть изменён в рабочем пространстве Qt Designer. Но QDesignerFormWindowInterface предоставляет функции, которые позволяют управлять тем, должен ли виджет управляться Qt Designer или нет:

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

Полный список функций, связанных с управлением виджетами: isManaged(), manageWidget() и unmanageWidget(). Также существует несколько связанных сигналов: widgetManaged(), widgetRemoved(), оПланированномОтключенииУправленияВиджетом() и widgetUnmanaged().

Помимо управления виджетами, вы можете управлять текущим выделением в окне формы с помощью функций selectWidget(), очиститьВыбор() и emitSelectionChanged(), а также сигнала selectionChanged().

Вы также можете получить информацию о том, где хранится форма, используя absoluteDir(), её файлы включения с помощью includeHints(), и её функции макета и пикселей с помощью layoutDefault(), layoutFunction() и pixmapFunction(). Вы можете узнать, была ли форма изменена (но не сохранена), используя функцию isDirty(). Вы можете получить её автора, её содержимое, её имя файла, связанные комментарий() и exportMacro(), её mainContainer(), её особенности(), её сетку() и её файлы ресурсов().

Интерфейс предоставляет функции и слоты, позволяющие изменять большую часть этой информации. Исключением является директория, в которой хранится окно формы. Наконец, существует несколько сигналов, связанных с изменениями в упомянутой выше информации и окне формы в целом.

См. также QDesignerFormWindowCursorInterface, QDesignerFormEditorInterface и QDesignerFormWindowManagerInterface.

Документация по типам членов

перечисление QDesignerFormWindowInterface::Feature

Это перечисление описывает функции, доступные и управляемые интерфейсом окна формы. Эти значения используются при запросе окна формы для определения поддерживаемых им функций:

Тип Feature — это typedef для QFlags<FeatureFlag>. Он хранит логическое ИЛИ сочетание значений FeatureFlag.

См. также hasFeature() и features().

[since 5.0] перечисление QDesignerFormWindowInterface::ResourceFileSaveMode

Это перечисление описывает способ сохранения файлов ресурсов.

Это перечисление было введено или изменено в Qt 5.0.

Документация функций-членов

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

Создаёт интерфейс окна формы с заданным parent и указанными флагами окна flags.

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

Этот сигнал излучается всякий раз, когда виджет на форме собирается стать неуправляемым. Когда этот сигнал излучается, указанный widget всё ещё управляем, и за ним последует сигнал widgetUnmanaged(), указывающий момент, когда он перестаёт быть управляемым.

См. также unmanageWidget() и isManaged().

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

Активирует пути к файлам ресурсов (.qrc) paths, возвращая количество ошибок в errorCount и сообщение об ошибке в errorMessages. Qt Designer загружает ресурсы с помощью класса QResource, делая их доступными для редактирования формы.

В интеграциях с IDE может быть активирован список файлов ресурсов проекта (.qrc), делая их доступными для Qt Designer.

Эта функция была введена в Qt 5.0.

См. также activeResourceFilePaths() и QResource.

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

Этот сигнал излучается всякий раз, когда виджет активируется на форме. Активированный виджет указан параметром widget.

[signal] void QDesignerFormWindowInterface::changed()

Этот сигнал излучается всякий раз, когда форма изменяется.

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

Очищает текущий выбор в окне формы. Если update равно true, вызывается функция emitSelectionChanged(), излучая сигнал selectionChanged().

См. также selectWidget().

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

Этот сигнал излучается всякий раз, когда изменяется функция формы. Новая функция задаётся параметром feature.

См. также setFeatures().

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

Этот сигнал излучается всякий раз, когда имя файла формы изменяется. Новое имя файла задаётся параметром fileName.

См. также setFileName().

[signal] void QDesignerFormWindowInterface::geometryChanged()

Этот сигнал излучается всякий раз, когда изменяется геометрия формы.

[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.

[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 slot] bool QDesignerFormWindowInterface::setContents(const QString &contents)

Устанавливает содержимое формы с помощью данных, считанных из указанной строки contents, и возвращает, успешно ли прошла операция.

См. также contents().

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

Если dirty равно true, окно формы помечается как изменённое, что означает, что оно изменено, но не сохранено. Если dirty равно false, окно формы считается неизменённым.

См. также isDirty().

[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 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().

[virtual] QDesignerFormWindowInterface::~QDesignerFormWindowInterface()

Уничтожает интерфейс окна формы.

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

Возвращает абсолютный путь к каталогу, содержащему форму, отображаемую в окне формы.

[since 5.0] QStringList QDesignerFormWindowInterface::activeResourceFilePaths() const

Возвращает пути к активным ресурсам (.qrc), загруженным в настоящее время в Qt Designer.

Эта функция была добавлена в Qt 5.0.

См. также activateResourceFilePaths().

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

Добавляет файл ресурса по указанному пути path к используемым формой.

См. также resourceFiles() и resourceFilesChanged().

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

Возвращает данные об авторе или создателе формы, в настоящее время отображаемой в окне.

См. также setAuthor().

[pure virtual, since 5.0] QStringList QDesignerFormWindowInterface::checkContents() const

Проверяет текущую форму и возвращает список предупреждений richtext о потенциальных проблемах (например, верхние разделители на формах без раскладки).

Интеграции IDE могут вызывать эту функцию перед началом операции сохранения.

Эта функция была добавлена в Qt 5.0.

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

Возвращает комментарии к форме, которая в настоящее время отображается в окне.

См. также setComment().

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

Возвращает данные о содержимом формы, которая в настоящее время отображается в окне.

См. также setContents().

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

Возвращает указатель на текущий объект QDesignerFormEditorInterface Qt Designer.

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

Возвращает интерфейс курсора, используемый окном формы.

[pure virtual] void QDesignerFormWindowInterface::emitSelectionChanged()

Использует сигнал selectionChanged().

См. также selectWidget() и clearSelection().

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

Возвращает макрос экспорта, связанный с формой, отображаемой в текущем окне. Макрос экспорта используется при компиляции формы для создания плагина виджета.

См. также setExportMacro() и Создание пользовательских виджетов для Qt Designer.

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

Возвращает комбинацию функций, предоставляемых окном формы, связанным с интерфейсом. Возвращаемое значение можно проверить на соответствие значениям перечисления Feature, чтобы определить, какие функции поддерживаются окном.

См. также setFeatures() и hasFeature().

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

Возвращает имя файла UI, описывающего форму, которая в настоящее время отображается.

См. также setFileName().

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

Возвращает интерфейс окна формы для данного widget.

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

Возвращает интерфейс окна формы для данного object.

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

Возвращает форму, содержащую основной контейнерный виджет.

Эта функция была добавлена в Qt 5.0.

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

Возвращает интервал сетки, используемый окном формы.

См. также setGrid().

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

Возвращает true, если окно формы предлагает указанную функцию feature; в противном случае возвращает 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

Возвращает true, если указанный widget управляется окном формы; в противном случае возвращает false.

См. также 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().

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

Возвращает имя функции, используемой для загрузки растровых изображений в окно формы.

См. также 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().

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

Устанавливает данные об авторе или создателе формы в author, который указан.

См. также author().

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

Устанавливает информацию о форме в comment, указанную. Эта информация должна быть читаемым для человека комментарием о форме.

См. также comment().

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

Устанавливает содержимое формы, используя данные, полученные из заданного device, и возвращает, удалось ли загрузка. Если произошла ошибка, сообщение об ошибке возвращается в errorMessage.

Данные могут быть прочитаны из объектов QFile или любого другого подкласса QIODevice.

См. также contents().

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

Устанавливает макрос экспорта окна формы в exportMacro. Макрос экспорта используется при построении плагина виджета для экспорта интерфейса формы в другие компоненты.

См. также exportMacro().

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

Устанавливает заголовочные файлы, которые будут включены в связанный с окном формы файл пользовательского интерфейса, в указанные includeHints.

Заголовочные файлы могут быть локальными, т.е. относительными к каталогу проекта, "mywidget.h", или глобальными, т.е. частью Qt или стандартных библиотек компилятора: <QtGui/QWidget>.

См. также includeHints().

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

Устанавливает значения по умолчанию для margin и spacing макета формы.

См. также layoutDefault().

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

Устанавливает margin и spacing для макета формы.

Свойства макета по умолчанию будут заменены соответствующими функциями макета при uic генерации кода для формы, то есть если функции указаны. Это полезно, когда для одной и той же формы требуется различный макет в разных средах.

См. также layoutFunction().

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

Устанавливает основной виджет контейнера формы в указанный mainContainer.

См. также mainContainerChanged().

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

Устанавливает функцию для загрузки растровых изображений в окно формы в заданную pixmapFunction.

См. также pixmapFunction().

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

Устанавливает режим сохранения файла ресурсов behavior.

См. также resourceFileSaveMode().