Класс QDesignerFormWindowInterface

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

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

Открытые типы

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

• 214 открытые функции унаследованные от QWidget
• 32 открытые функции унаследованные от QObject
• 14 открытые функции унаследованные от QPaintDevice

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

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

Сигналы

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

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

• 5 static public members унаследовано от QWidget
• 11 static public members унаследовано от QObject

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

• 59 свойств унаследовано от QWidget
• 1 свойство унаследовано от QObject
• 35 protected функций унаследовано от QWidget
• 9 protected функций унаследовано от QObject
• 1 protected функция унаследовано от QPaintDevice
• 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(), файлы включений с помощью includeHints(), а также функции макета и пикселей с помощью layoutDefault(), layoutFunction() и pixmapFunction(). Вы можете узнать, была ли форма изменена (но не сохранена), используя функцию isDirty(). Вы можете получить доступ к автору author(), содержанию contents(), имени файла fileName(), связанному комментарию comment() и exportMacro(), главному контейнеру mainContainer(), функциям features(), сетке grid() и файлам ресурсов resourceFiles().

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

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

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

enum QDesignerFormWindowInterface::FeatureFlagflags QDesignerFormWindowInterface::Feature

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

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

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

enum QDesignerFormWindowInterface::ResourceFileSaveMode

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

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

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

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

Создает интерфейс окна формы с заданным 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

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

Интеграции 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(Feature feature)

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

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

[pure virtual] Функция QDesignerFormWindowInterface::features() const

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

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

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

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

См. также 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(Функция feature) const

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

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

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

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

Заголовочные файлы могут быть локальными, т.е. относительными к каталогу проекта, "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() 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 = Q_NULLPTR)

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

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