Класс QDataWidgetMapper

Класс QDataWidgetMapper обеспечивает сопоставление части модели данных с виджетами. Подробнее...

Этот класс был представлен в Qt 4.2.

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

Общие типы

Свойства

• currentIndex : int
• orientation : Qt::Orientation
• submitPolicy : SubmitPolicy

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

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

Сигналы

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

QDataWidgetMapper может использоваться для создания виджетов, учитывающих данные, сопоставив их с разделами модели элементов. Раздел — это столбец модели, если ориентация горизонтальная (по умолчанию), в противном случае — строка.

Каждый раз, когда изменяется текущий индекс, каждый виджет обновляется данными из модели через свойство, указанное при его сопоставлении. Если пользователь изменяет содержимое виджета, изменения считываются с помощью того же свойства и записываются обратно в модель. По умолчанию используется пользовательское свойство каждого виджета для передачи данных между моделью и виджетом. С Qt 4.3 дополнительная функция addMapping() позволяет использовать именованное свойство вместо свойства по умолчанию.

Можно задать делегата элементов для поддержки пользовательских виджетов. По умолчанию используется QItemDelegate для синхронизации модели с виджетами.

Предположим, что у нас есть модель элементов под названием model со следующим содержимым:

Следующий код сопоставит столбцы модели с виджетами под названием mySpinBox, myLineEdit и myCountryChooser:

QDataWidgetMapper *mapper = new QDataWidgetMapper;
mapper->setModel(model);
mapper->addMapping(mySpinBox, 0);
mapper->addMapping(myLineEdit, 1);
mapper->addMapping(myCountryChooser, 2);
mapper->toFirst();

После вызова toFirst(), mySpinBox отображает значение 1, myLineEdit отображает Qt Norway и myCountryChooser отображает Oslo. Для навигации в модели и обновления виджетов содержимым из модели можно использовать навигационные функции toFirst(), toNext(), toPrevious(), toLast() и setCurrentIndex().

Функция setRootIndex() позволяет указать конкретный элемент в модели в качестве корневого индекса — потомки этого элемента будут сопоставлены с соответствующими виджетами в пользовательском интерфейсе.

QDataWidgetMapper поддерживает две политики отправки, AutoSubmit и ManualSubmit. AutoSubmit обновит модель, как только текущий виджет потеряет фокус, ManualSubmit не обновит модель, пока не будет вызван submit(). ManualSubmit полезно при отображении диалогового окна, позволяющего пользователю отменить все изменения. Кроме того, другие представления, отображающие модель, не обновятся, пока пользователь не завершит все свои изменения и не отправит их.

Обратите внимание, что QDataWidgetMapper отслеживает внешние изменения. Если содержимое модели обновляется в другом модуле приложения, виджеты также обновляются.

См. также QAbstractItemModel и QAbstractItemDelegate.

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

перечисление QDataWidgetMapper::SubmitPolicy

Это перечисление описывает возможные политики отправки, которые поддерживает QDataWidgetMapper.

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

QDataWidgetMapper::QDataWidgetMapper(QObject *parent = nullptr)

Создает новый QDataWidgetMapper с родительским объектом parent. По умолчанию ориентация горизонтальная, а политика отправки — AutoSubmit.

См. также setOrientation() и setSubmitPolicy().

[signal] void QDataWidgetMapper::currentIndexChanged(int index)

Этот сигнал генерируется после изменения текущего индекса и заполнения всех виджетов новыми данными. index — новый текущий индекс.

Примечание: Сигнал уведомления для свойства currentIndex.

См. также currentIndex() и setCurrentIndex().

[slot] void QDataWidgetMapper::revert()

Заполняет все виджеты текущими данными модели. Все неотправленные изменения будут потеряны.

См. также submit() и setSubmitPolicy().

[slot] void QDataWidgetMapper::setCurrentModelIndex(const QModelIndex &index)

Устанавливает текущий индекс в строку index, если ориентация горизонтальная (по умолчанию), иначе в столбец index.

Внутренне вызывает setCurrentIndex(). Этот удобный слот можно подключить к сигналу currentRowChanged() или currentColumnChanged() модели выбора другого представления selection model.

Следующий пример иллюстрирует, как обновить все виджеты новыми данными всякий раз, когда изменяется выбор QTableView с именем myTableView:

QDataWidgetMapper *mapper = new QDataWidgetMapper;
connect(myTableView->selectionModel(), &QItemSelectionModel::currentRowChanged,
        mapper, &QDataWidgetMapper::setCurrentModelIndex);

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

[slot] bool QDataWidgetMapper::submit()

Отправляет все изменения от сопоставленных виджетов в модель.

Для каждого сопоставленного раздела делегат элемента считывает текущее значение из виджета и устанавливает его в модели. Наконец, вызывается метод submit() модели.

Возвращает true , если все значения были отправлены, в противном случае false.

Примечание: Для баз данных, QSqlQueryModel::lastError() может использоваться для получения последней ошибки.

См. также revert() и setSubmitPolicy().

[slot] void QDataWidgetMapper::toFirst()

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

Эквивалентно вызову setCurrentIndex(0).

См. также toLast() и setCurrentIndex().

[slot] void QDataWidgetMapper::toLast()

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

Внутренне вызывает setCurrentIndex().

См. также toFirst() и setCurrentIndex().

[slot] void QDataWidgetMapper::toNext()

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

Внутренне вызывает setCurrentIndex(). Ничего не делает, если нет следующей строки в модели.

См. также toPrevious() и setCurrentIndex().

[slot] void QDataWidgetMapper::toPrevious()

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

Внутренне вызывает setCurrentIndex(). Ничего не делает, если нет предыдущей строки в модели.

См. также toNext() и setCurrentIndex().

[virtual] QDataWidgetMapper::~QDataWidgetMapper()

Уничтожает объект.

void QDataWidgetMapper::addMapping(QWidget *widget, int section)

Добавляет сопоставление между widget и section из модели. section — столбец в модели, если ориентация горизонтальная (по умолчанию), иначе — строка.

В следующем примере предполагается модель myModel, которая имеет два столбца: первый столбец содержит имена людей в группе, а второй — их возраст. Первый столбец сопоставлен с QLineEdit nameLineEdit, а второй — с QSpinBox ageSpinBox:

QDataWidgetMapper *mapper = new QDataWidgetMapper;
mapper->setModel(myModel);
mapper->addMapping(nameLineEdit, 0);
mapper->addMapping(ageSpinBox, 1);

Примечания:

• Если widget уже сопоставлен с разделом, старое сопоставление будет заменено новым.
• Разрешены только взаимно-однозначные сопоставления между разделами и виджетами. Невозможно сопоставить один раздел с несколькими виджетами или один виджет с несколькими разделами.

См. также removeMapping(), mappedSection() и clearMapping().

void QDataWidgetMapper::addMapping(QWidget *widget, int section, const QByteArray &propertyName)

По существу то же самое, что и addMapping(), но добавляет возможность указать свойство для использования, указав propertyName.

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

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

void QDataWidgetMapper::clearMapping()

Очищает все сопоставления.

См. также addMapping() и removeMapping().

QAbstractItemDelegate *QDataWidgetMapper::itemDelegate() const

Возвращает текущего делегата элементов.

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

QByteArray QDataWidgetMapper::mappedPropertyName(QWidget *widget) const

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

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

См. также mappedSection(), addMapping() и removeMapping().

int QDataWidgetMapper::mappedSection(QWidget *widget) const

Возвращает раздел, к которому сопоставлен widget, или -1, если виджет не сопоставлен.

См. также addMapping() и removeMapping().

QWidget *QDataWidgetMapper::mappedWidgetAt(int section) const

Возвращает виджет, сопоставленный с разделом section, или 0, если ни один виджет не сопоставлен с этим разделом.

См. также addMapping() и removeMapping().

QAbstractItemModel *QDataWidgetMapper::model() const

Возвращает текущую модель.

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

void QDataWidgetMapper::removeMapping(QWidget *widget)

Удаляет сопоставление для заданного widget.

См. также addMapping() и clearMapping().

QModelIndex QDataWidgetMapper::rootIndex() const

Возвращает текущий корневой индекс.

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

void QDataWidgetMapper::setItemDelegate(QAbstractItemDelegate *delegate)

Устанавливает делегат элементов в delegate. Делегат будет использоваться для записи данных из модели в виджет и из виджета в модель, используя QAbstractItemDelegate::setEditorData() и QAbstractItemDelegate::setModelData().

Делегат также определяет, когда применять данные и когда изменять редактор, используя QAbstractItemDelegate::commitData() и QAbstractItemDelegate::closeEditor().

Предупреждение: Не следует использовать один и тот же экземпляр делегата между виджет-мапперами или представлениями. Это может привести к неправильному или неинтуитивному поведению редактирования, поскольку каждое представление, связанное с данным делегатом, может получить сигнал closeEditor() и попытаться получить доступ к, изменить или закрыть редактор, который уже был закрыт.

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

void QDataWidgetMapper::setModel(QAbstractItemModel *model)

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

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

void QDataWidgetMapper::setRootIndex(const QModelIndex &index)

Устанавливает корневой элемент в index. Это может быть использовано для отображения ветви дерева. Передайте недействительный индекс модели, чтобы отобразить самую верхнюю ветвь.

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