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

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

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

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

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

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

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

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

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

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

enum QDesignerFormWindowInterface::ResourceFileSaveMode

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

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

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

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

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

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

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

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

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

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

[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

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

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

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

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