Класс QDesignerFormWindowInterface

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

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

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

Открытые функции

• 216 открытые функции унаследованные от QWidget

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

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

Сигналы

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

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

• 5 статических публичных членов унаследовано от QWidget

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

• 59 свойств унаследовано от QWidget
• 35 защищённых функций унаследовано от QWidget
• 1 защищённый слот унаследовано от 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() и отключитьУправлениеВиджетом(). Также существуют несколько связанных сигналов: widgetManaged(), widgetRemoved(), передОтключениемУправленияВиджетом() и widgetUnmanaged().

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

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

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

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

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

перечисление QDesignerFormWindowInterface::FeatureFlagфлаги QDesignerFormWindowInterface::Feature

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

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

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

перечисление 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, соответственно.

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

Эта функция была введена в 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 = ...)

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