Qt Delegate Classes

比眉伴天荒 2022-10-16 07:17 91阅读 0赞

**目录**

概念

使用现有代理

一个简单的代理

提供编辑

向模型提交数据

更新编辑器的几何体

编辑提示

--------------------

### 概念 ###

与模型-视图-控制器模式不同，模型/视图设计不包括用于管理与用户交互的完全独立的组件。通常，视图负责向用户表示模型数据，并处理用户输入。为了在获得输入的方式上允许一些灵活性，交互由代理执行。这些组件提供输入功能，还负责在某些视图中呈现单个项。控制委托的标准接口在QAbstractItemDelegate类中定义。  
委托应该能够通过实现paint（）和sizeHint（）函数来呈现自己的内容。但是，简单的基于小部件的委托可以子类化QItemDelegate而不是QAbstractItemDelegate，并利用这些函数的默认实现。  
代理编辑器可以通过使用小部件管理编辑过程或直接处理事件来实现。第一种方法将在本节后面介绍，它也将在数字调整框代理示例中显示。  
Pixelator示例演示如何创建一个自定义委托，为表视图执行专门的呈现。

### 使用现有代理 ###

Qt提供的标准视图使用QItemDelegate实例提供编辑功能。委托接口的这个默认实现以每个标准视图的常规样式呈现项：QListView、QTableView和QTreeView。  
所有标准角色都由标准视图使用的默认委托处理。QItemDelegate文档中描述了这些的解释方式。  
视图使用的委托由itemdegate（）函数返回。 setItemDelegate()函数的作用是：为标准视图安装自定义委托，在为自定义视图设置委托时必须使用此函数。

### **一个简单的代理** ###

这里实现的委托使用QSpinBox提供编辑功能，主要用于显示整数的模型。尽管我们为此设置了一个自定义的基于整数的表模型，但是我们可以很容易地使用qstandarditemodel来代替它，因为自定义委托控制数据输入。我们构造一个表视图来显示模型的内容，这将使用自定义委托进行编辑。

![20210527200940488.png][]

我们将委托从QStyledItemDelegate子类化，因为我们不想编写自定义显示函数。但是，我们仍然必须提供管理编辑器小部件的功能：

class SpinBoxDelegate : public QStyledItemDelegate
      {
          Q_OBJECT
    
      public:
          SpinBoxDelegate(QObject *parent = 0);
    
          QWidget *createEditor(QWidget *parent, const QStyleOptionViewItem &option,
                                const QModelIndex &index) const override;
    
          void setEditorData(QWidget *editor, const QModelIndex &index) const override;
          void setModelData(QWidget *editor, QAbstractItemModel *model,
                            const QModelIndex &index) const override;
    
          void updateEditorGeometry(QWidget *editor,
              const QStyleOptionViewItem &option, const QModelIndex &index) const override;
      };

请注意，在构造委托时没有设置编辑器小部件。我们只在需要时构造编辑器小部件。

### **提供编辑** ###

在本例中，当表视图需要提供编辑器时，它会要求代理提供一个适用于所修改项的编辑器小部件。createEditor（）函数提供了委托设置适当小部件所需的一切：

QWidget *SpinBoxDelegate::createEditor(QWidget *parent,
          const QStyleOptionViewItem &/* option */,
          const QModelIndex &/* index */) const
      {
          QSpinBox *editor = new QSpinBox(parent);
          editor->setFrame(false);
          editor->setMinimum(0);
          editor->setMaximum(100);
    
          return editor;
      }

请注意，我们不需要保留指向编辑器小部件的指针，因为视图负责在不再需要它时销毁它。  
我们在编辑器上安装代理的默认事件过滤器，以确保它提供用户期望的标准编辑快捷方式。额外的快捷方式可以添加到编辑器，以允许更复杂的行为；在编辑提示一节中讨论了这些问题。  
该视图通过调用我们稍后为这些目的定义的函数来确保编辑器的数据和几何体设置正确。我们可以根据视图提供的模型索引创建不同的编辑器。例如，如果我们有一列整数和一列字符串，我们可以返回QSpinBox或QLineEdit，这取决于正在编辑的列。  
委托必须提供将模型数据复制到编辑器中的函数。在本例中，我们读取存储在display角色中的数据，并相应地在数字调整框中设置值。

void SpinBoxDelegate::setEditorData(QWidget *editor,
                                          const QModelIndex &index) const
      {
          int value = index.model()->data(index, Qt::EditRole).toInt();
    
          QSpinBox *spinBox = static_cast<QSpinBox*>(editor);
          spinBox->setValue(value);
      }

在本例中，我们知道编辑器小部件是一个数字调整框，但是我们可以为模型中不同类型的数据提供不同的编辑器，在这种情况下，我们需要在访问其成员函数之前将小部件转换为适当的类型。

### **向模型提交数据** ###

当用户编辑完数字调整框中的值后，视图要求代理通过调用setModelData（）函数将编辑的值存储在模型中。

void SpinBoxDelegate::setModelData(QWidget *editor, QAbstractItemModel *model,
                                         const QModelIndex &index) const
      {
          QSpinBox *spinBox = static_cast<QSpinBox*>(editor);
          spinBox->interpretText();
          int value = spinBox->value();
    
          model->setData(index, value, Qt::EditRole);
      }

因为视图管理委托的编辑器小部件，所以我们只需要用提供的编辑器的内容更新模型。在本例中，我们确保数字调整框是最新的，并使用指定的索引用它包含的值更新模型。  
标准的QItemDelegate类通过发出closeEditor（）信号通知视图完成编辑。视图确保编辑器小部件被关闭和销毁。在这个例子中，我们只提供简单的编辑工具，所以我们不需要发出这个信号。  
所有对数据的操作都是通过qabstractemmodel提供的接口执行的。这使得委托基本上独立于它所处理的数据类型，但是为了使用某些类型的编辑器小部件，必须做出一些假设。在本例中，我们假设模型始终包含整数值，但我们仍然可以将此委托用于不同类型的模型，因为QVariant为意外数据提供了合理的默认值。

###    **更新编辑器的几何体** ###

代理负责管理编辑器的几何图形。创建编辑器时，以及更改视图中项目的大小或位置时，必须设置几何图形。幸运的是，视图在视图选项对象中提供了所有必要的几何体信息。

void SpinBoxDelegate::updateEditorGeometry(QWidget *editor,
          const QStyleOptionViewItem &option, const QModelIndex &/* index */) const
      {
          editor->setGeometry(option.rect);
      }

在本例中，我们只使用项目矩形中的view选项提供的几何体信息。呈现具有多个元素的项的委托不会直接使用项矩形。它将相对于项中的其他元素定位编辑器。

### **编辑提示** ###

编辑后，学员应向其他组件提供有关编辑过程结果的提示，并提供有助于任何后续编辑操作的提示。这是通过发出带有适当提示的closeEditor（）信号来实现的。这是由默认的QItemDelegate事件过滤器处理的，我们在构建时将其安装在数字调整框上。  
可以调整数字调整框的行为，使其更易于使用。在QItemDelegate提供的默认事件过滤器中，如果用户点击Return以确认他们在数字调整框中的选择，那么委托将值提交给模型并关闭数字调整框。我们可以通过在数字调整框上安装我们自己的事件过滤器来改变这种行为，并提供适合我们需要的编辑提示；例如，我们可能会发出带有EditNextItem提示的closeEditor（），以自动开始编辑视图中的下一项。  
另一种不需要使用事件过滤器的方法是提供我们自己的编辑器小部件，可能是为了方便而将QSpinBox子类化。这种替代方法可以让我们以编写额外代码为代价，更好地控制编辑器小部件的行为。如果需要自定义标准Qt编辑器小部件的行为，那么在委托中安装事件过滤器通常更容易。  
委托不必发出这些提示，但是那些不发出提示的委托将更少地集成到应用程序中，并且比那些发出提示以支持常见编辑操作的委托更不可用。

[20210527200940488.png]: /images/20221014/0a072eede858410cb93c4292ef0e2e65.png