Класс QDesignerFormWindowInterface

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

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

Типы

Публичные функции

• 219 публичных функций, унаследованных от QWidget

Публичные слоты

• 19 public slots унаследовано от QWidget

Сигналы

• 3 signals унаследовано от QWidget

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

• 7 static public members унаследовано от QWidget

Дополнительные унаследованные члены

• 59 свойств унаследовано от QWidget
• 1 public variable унаследовано от QWidget
• 35 protected функций унаследовано от QWidget
• 1 protected slot унаследовано от QWidget

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

Класс 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().

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

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

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

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

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

enum QDesignerFormWindowInterface::FeatureFlagфлаги QDesignerFormWindowInterface::Feature

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

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

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

enum QDesignerFormWindowInterface::ResourceFileSaveMode

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

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

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

QDesignerFormWindowInterface::QDesignerFormWindowInterface(QWidget *parent = Q_NULLPTR, Qt::WindowFlags flags = ...)

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

[virtual] 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 = Q_NULLPTR, QString *errorMessages = Q_NULLPTR)

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

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

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

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

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

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

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

[signal] void QDesignerFormWindowInterface::changed()

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

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

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

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

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

[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

Возвращает указатель на текущий объект 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.

[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(QWidget *widget)

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

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

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

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

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

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

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

[signal] void QDesignerFormWindowInterface::geometryChanged()

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

[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) макета формы в переменные margin и spacing.

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

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

Заполняет текущие значения отступов (margin) и интервалов (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.

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

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

[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] bool QDesignerFormWindowInterface::setContents(QIODevice *device, QString *errorMessage = ...)

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

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

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

[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] 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)

Устанавливает заголовочные файлы, которые будут включены в связанный с окном формы файл пользовательского интерфейса, в указанные 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().

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