标签输入控件. 更多...

类 Dtk::Widget::DCrumbEdit 继承关系图:

Dtk::Widget::DCrumbEdit 的协作图:

Public 类型
enum	CrumbType { black = Qt::black , white = Qt::white , darkGray = Qt::darkGray , gray = Qt::gray , lightGray = Qt::lightGray , red = Qt::red , green = Qt::green , blue = Qt::blue , cyan = Qt::cyan , magenta = Qt::magenta , yellow = Qt::yellow , darkRed = Qt::darkRed , darkGreen = Qt::darkGreen , darkBlue = Qt::darkBlue , darkCyan = Qt::darkCyan , darkMagenta = Qt::darkMagenta , darkYellow = Qt::darkYellow }

Public 槽
void	setCrumbReadOnly (bool crumbReadOnly)
	设置或取消设置标签编辑控件的只读状态更多...

void	setCrumbRadius (int crumbRadius)
	设置控件圆角角度更多...

void	setSplitter (const QString &splitter)
	设置分割符更多...

void	setDualClickMakeCrumb (bool flag) Q_DECL_NOEXCEPT

信号
void	crumbAdded (const QString &text)

void	crumbRemoved (const QString &text)

void	crumbListChanged ()

Public 成员函数
	DCrumbEdit (QWidget *parent=0)

bool	insertCrumb (const DCrumbTextFormat &format, int pos=-1)
	像标签编辑控件中插入新的标签更多...

bool	insertCrumb (const QString &text, int pos=-1)
	像标签编辑控件中插入新的标签更多...

bool	appendCrumb (const DCrumbTextFormat &format)
	像标签编辑控件中追加新的标签更多...

bool	appendCrumb (const QString &text)
	像标签编辑控件中追加新的标签更多...

bool	containCrumb (const QString &text) const
	检查当前控件是否已经包含了 text 标签 text 待检查的标签文字名称更多...

QStringList	crumbList () const
	Get a list of crumb/tags inside the crumb edit widget. 更多...

DCrumbTextFormat	crumbTextFormat (const QString &text) const
	Get the DCrumbTextFormat matched the given tag text name. 更多...

DCrumbTextFormat	makeTextFormat () const
	创建一个直接可用的 DCrumbTextFormat 对象. 更多...

DCrumbTextFormat	makeTextFormat (CrumbType type) const
	根据所给的标签类型（颜色）创建一个直接可用的 DCrumbTextFormat 对象. 更多...

bool	dualClickMakeCrumb () const Q_DECL_NOEXCEPT

bool	crumbReadOnly () const

int	crumbRadius () const

QString	splitter () const

Protected 成员函数
bool	event (QEvent *e) override

void	paintEvent (QPaintEvent *event) override

void	keyPressEvent (QKeyEvent *event) override

void	mouseDoubleClickEvent (QMouseEvent *event) override

void	focusOutEvent (QFocusEvent *event) override

QMimeData *	createMimeDataFromSelection () const override

bool	canInsertFromMimeData (const QMimeData *source) const override

void	insertFromMimeData (const QMimeData *source) override

属性
bool	crumbReadOnly

int	crumbRadius

QString	splitter

bool	dualClickMakeCrumb

详细描述

标签输入控件.

\inmodule dtkwidget

Tag Edit Widget.

DCrumbEdit provide a edit widget as a container for user entered Tags (or say, Crumbs), and allow user edit the existed tags inside this widget. Tags comes with different text, each of the tags inside the same DCrumbEdit should have different text.

The tag, or say crumb, use its text as an identifier, and it comes with other properties like tag color and etc.

DCrumbEdit allowed user add a tag by providing a simple QString or provide a custom DCrumbTextFormat object. Refer to appendCrumb() and insertCrumb() to see the usage. To get a list of tags/crumbs, see crumbList()

DCrumbEdit 提供了一个编辑框，编辑框内可包含若干个标签，并允许通过用户输入来编辑这些标签。编辑框所包含的标签可通过标签的文字内容确定唯一的标签，即编辑框所包含的标签内容（字符串值）均不重复。

编辑框中包含的标签的主体为字符串，除文字外，每个标签可以对应其不同的颜色等样式，对于可供使用的样式请参见 DCrumbTextFormat 。 DCrumbEdit 允许通过给定字符串的形式便捷的向其中添加一个默认样式的标签，也可以通过自行构建标签文字样式。请参见 insertCrumb() 和 appendCrumb() 的不同重载。可以通过 crumbList() 获得当前标签输入控件中包含的标签列表。

参见: DCrumbTextFormat

成员函数说明

◆ appendCrumb() [1/2]

bool Dtk::Widget::DCrumbEdit::appendCrumb ( const DCrumbTextFormat & format )

像标签编辑控件中追加新的标签

Append new tag/crumb to the crumb edit widget.

format 一个 DCrumbTextFormat 对象. format a DCrumbTextFormat.

通过给定的 DCrumbTextFormat 对象所描述的属性创建新的标签并追加到标签编辑控件中。若要创建一个直接可供使用的 DCrumbTextFormat 对象，可以考虑使用 makeTextFormat() 。 Append new tag/crumb with the provided DCrumbTextFormat. To create a ready-to-use DCrumbTextFormat object, call makeTextFormat().

返回: 插入标签成功时返回 true，否则返回 false.; true if we appended a new tag into the crumb edit widget.

参见: makeTextFormat(), insertCrumb()

◆ appendCrumb() [2/2]

bool Dtk::Widget::DCrumbEdit::appendCrumb ( const QString & text )

像标签编辑控件中追加新的标签

Append new tag/crumb to the crumb edit widget.

text 标签的文字内容. text of the tag/crumb.

通过给定的文字创建新的标签并追加到标签编辑控件中。 Append new tag/crumb with the provided text.

返回: 插入标签成功时返回 true，否则返回 false.; true if we appended a new tag into the crumb edit widget.

参见: insertCrumb()

◆ canInsertFromMimeData()

bool Dtk::Widget::DCrumbEdit::canInsertFromMimeData ( const QMimeData * source ) const

overrideprotected

\reimp

◆ containCrumb()

bool Dtk::Widget::DCrumbEdit::containCrumb ( const QString & text ) const

检查当前控件是否已经包含了 text 标签 text 待检查的标签文字名称

返回: 如果包含，返回 true

◆ createMimeDataFromSelection()

QMimeData * Dtk::Widget::DCrumbEdit::createMimeDataFromSelection ( ) const

overrideprotected

\reimp

◆ crumbList()

QStringList Dtk::Widget::DCrumbEdit::crumbList ( ) const

Get a list of crumb/tags inside the crumb edit widget.

取得标签输入控件内已包含的标签列表

◆ crumbTextFormat()

DCrumbTextFormat Dtk::Widget::DCrumbEdit::crumbTextFormat ( const QString & text ) const

Get the DCrumbTextFormat matched the given tag text name.

根据标签名称取得对应的标签样式属性 DCrumbTextFormat 对象

◆ focusOutEvent()

void Dtk::Widget::DCrumbEdit::focusOutEvent ( QFocusEvent * event )

overrideprotected

\reimp

◆ insertCrumb() [1/2]

bool Dtk::Widget::DCrumbEdit::insertCrumb	(	const DCrumbTextFormat &	format,
		int	pos = `-1`
	)

像标签编辑控件中插入新的标签

Insert new tag/crumb to the crumb edit widget at the given position.

format 一个 DCrumbTextFormat 对象. format a DCrumbTextFormat. pos 待插入的位置. pos position to be inserted.

通过给定的 DCrumbTextFormat 对象所描述的属性创建新的标签并追加到标签编辑控件中。若要创建一个直接可供使用的 DCrumbTextFormat 对象，可以考虑使用 makeTextFormat() 。 Insert new tag/crumb with the provided DCrumbTextFormat at the given position. To create a ready-to-use DCrumbTextFormat object, call makeTextFormat().

返回: 插入标签成功时返回 true，否则返回 false.; true if we appended a new tag into the crumb edit widget.

参见: makeTextFormat(), insertCrumb()

◆ insertCrumb() [2/2]

bool Dtk::Widget::DCrumbEdit::insertCrumb	(	const QString &	text,
		int	pos = `-1`
	)

像标签编辑控件中插入新的标签

Insert new tag/crumb to the crumb edit widget.

text 标签的文字内容. text of the tag/crumb. pos 待插入的位置. pos position to be inserted.

通过给定的文字创建新的标签并插入到标签编辑控件中的指定位置。 Insert new tag/crumb with the provided text to the given position.

返回: 插入标签成功时返回 true，否则返回 false.; true if we appended a new tag into the crumb edit widget.

参见: appendCrumb()

◆ insertFromMimeData()

void Dtk::Widget::DCrumbEdit::insertFromMimeData ( const QMimeData * source )

overrideprotected

\reimp

◆ keyPressEvent()

void Dtk::Widget::DCrumbEdit::keyPressEvent ( QKeyEvent * event )

overrideprotected

\reimp

◆ makeTextFormat() [1/2]

DCrumbTextFormat Dtk::Widget::DCrumbEdit::makeTextFormat ( ) const

创建一个直接可用的 DCrumbTextFormat 对象.

create a ready-to-use DCrumbTextFormat object.

返回: 创建的 DCrumbTextFormat 对象; the created DCrumbTextFormat object

◆ makeTextFormat() [2/2]

DCrumbTextFormat Dtk::Widget::DCrumbEdit::makeTextFormat ( DCrumbEdit::CrumbType type ) const

根据所给的标签类型（颜色）创建一个直接可用的 DCrumbTextFormat 对象.

create a ready-to-use DCrumbTextFormat object with the given color.

将根据所给的（颜色）类型创建一个新的 DCrumbTextFormat 对象，并将其内文字属性设为颜色的名称。 Create a ready-to-use DCrumbTextFormat object with the given color, and set its text as the color name.

返回: 创建的 DCrumbTextFormat 对象; the created DCrumbTextFormat object

◆ mouseDoubleClickEvent()

void Dtk::Widget::DCrumbEdit::mouseDoubleClickEvent ( QMouseEvent * event )

overrideprotected

\reimp

◆ paintEvent()

void Dtk::Widget::DCrumbEdit::paintEvent ( QPaintEvent * event )

overrideprotected

\reimp

◆ setCrumbRadius

void Dtk::Widget::DCrumbEdit::setCrumbRadius ( int crumbRadius )

slot

设置控件圆角角度

crumbRadius 圆角角度.

◆ setCrumbReadOnly

void Dtk::Widget::DCrumbEdit::setCrumbReadOnly ( bool crumbReadOnly )

slot

设置或取消设置标签编辑控件的只读状态

crumbReadOnly 是否只读.

◆ setSplitter

void Dtk::Widget::DCrumbEdit::setSplitter ( const QString & splitter )

slot

设置分割符

设置表示划分标签边界的分割字符，可用于一次性输入多个以给定分隔符分割的标签。

splitter 分割线字符.

该类的文档由以下文件生成:

include/dtkwidget/widgets/dcrumbedit.h
src/widgets/dcrumbedit.cpp

Public 类型

Public 槽

信号

Public 成员函数

Protected 成员函数

属性

详细描述

成员函数说明

◆ appendCrumb() [1/2]

◆ appendCrumb() [2/2]

◆ canInsertFromMimeData()

◆ containCrumb()

◆ createMimeDataFromSelection()

◆ crumbList()

◆ crumbTextFormat()

◆ focusOutEvent()

◆ insertCrumb() [1/2]

◆ insertCrumb() [2/2]

◆ insertFromMimeData()

◆ keyPressEvent()

◆ makeTextFormat() [1/2]

◆ makeTextFormat() [2/2]

◆ mouseDoubleClickEvent()

◆ paintEvent()

◆ setCrumbRadius

◆ setCrumbReadOnly

◆ setSplitter