dccv23::ItemModule类 参考

类 dccv23::ItemModule 继承关系图:

信号
void	clicked (QWidget *widget)
信号 继承自 dccv23::ModuleObject
void	moduleDataChanged ()
	基本信息改变后发送此信号
void	displayNameChanged (const QString &displayName)
	displayName改变后发送此信号
void	stateChanged (uint32_t flag, bool state)
	stateChanged 状态标志变化 (可见、禁用等)
void	childStateChanged (ModuleObject *const child, uint32_t flag, bool state)
	childStateChanged 子项状态标志变化 (可见、禁用等)
void	removedChild (ModuleObject *const module)
	删除child前触发
void	insertedChild (ModuleObject *const module)
	插入child后触发
void	childrenSizeChanged (const int size)
	childrens() 改变后必须发送此信号
void	triggered ()
	trigger触发该信号，框架收到信号会切换到该ModuleObject页
void	currentModuleChanged (ModuleObject *currentModule)
	currentModuleChanged 当前激活的子项改变时会触发此信号
void	visibleChanged ()

Public 成员函数
	ItemModule (QObject *parent=nullptr)
	ItemModule (const QString &name, const QString &displayName, bool isTitle=true)
template<typename FunT >
	ItemModule (const QString &name, const QString &displayName, FunT callback, bool leftVisible=true)
template<class classT , class WidgetT >
	ItemModule (const QString &name, const QString &displayName, classT *receiver, WidgetT *(classT::*callback)(ModuleObject *), bool leftVisible=true)
template<class classT , class WidgetT >
	ItemModule (const QString &name, const QString &displayName, classT *receiver, WidgetT *(classT::*callback)(), bool leftVisible=true)
void	setTitleItem (bool isTitle)
void	setBackground (bool has)
void	setWordWrap (bool on)
bool	wordWrap () const
void	setLeftVisible (bool visible)
bool	clickable () const
void	setClickable (const bool clickable)
template<typename FunT >
void	setRightWidget (FunT callback)
template<class classT , class WidgetT >
void	setRightWidget (classT *receiver, WidgetT *(classT::*callback)(ModuleObject *))
template<class classT , class WidgetT >
void	setRightWidget (classT *receiver, WidgetT *(classT::*callback)())
QWidget *	page () override
	每次被调均需new新的QWidget
DCC_MODULE_TYPE	getClassID () const override
Public 成员函数 继承自 dccv23::ModuleObject
	ModuleObject (QObject *parent=nullptr)
	ModuleObject (const QString &name, const QString &displayName={}, QObject *parent=nullptr)
	ModuleObject (const QString &name, const QStringList &contentText, QObject *parent=nullptr)
	ModuleObject (const QString &name, const QString &displayName, const QStringList &contentText, QObject *parent=nullptr)
	ModuleObject (const QString &name, const QString &displayName, const QVariant &icon, QObject *parent=nullptr)
	ModuleObject (const QString &name, const QString &displayName, const QString &description, QObject *parent=nullptr)
	ModuleObject (const QString &name, const QString &displayName, const QString &description, const QVariant &icon, QObject *parent=nullptr)
	ModuleObject (const QString &name, const QString &displayName, const QString &description, const QIcon &icon, QObject *parent=nullptr)
	ModuleObject (const QString &name, const QString &displayName, const QString &description, const QStringList &contentText, const QVariant &icon, QObject *parent=nullptr)
	ModuleObject (const ModuleInitContext &message, QObject *parent=nullptr)
virtual QWidget *	activePage (bool autoActive=true)
	activePage 激活并返回page
QString	name () const
QString	displayName () const
QString	description () const
QStringList	contentText () const
QVariant	icon () const
int	badge () const
bool	isHidden () const
bool	isVisible () const
bool	isDisabled () const
bool	isEnabled () const
bool	getFlagState (uint32_t flag) const
	获取状态标志
uint32_t	getFlag () const
bool	extra () const
void	setExtra (bool value=true)
bool	noSearch () const
void	setNoSearch (bool noSearch=true)
ModuleObject *	currentModule () const
	currentModule 当前active的子项 当前active的子项变化时会触发currentModuleChanged信号， page与子项相关时需要处理currentModuleChanged信号
virtual ModuleObject *	defultModule ()
	defultModule 默认active的子项 当某个页面被active时，会通过defultModule去active子项 当返回为nullptr时，不再递归active子项 ModuleObject类默认处理为返回第一个未隐藏的子项
ModuleObject *	getParent ()
int	findChild (ModuleObject *const child)
	搜索子项，使用广度搜索
bool	hasChildrens ()
const QList< ModuleObject * > &	childrens ()
	子项，不可直接使用QList进行增删改操作，应使用appendChild、removeChild、insertChild
ModuleObject *	children (const int index) const
int	getChildrenSize () const
virtual void	appendChild (ModuleObject *const module)
virtual void	removeChild (ModuleObject *const module)
virtual void	removeChild (const int index)
virtual void	insertChild (QList< ModuleObject * >::iterator before, ModuleObject *const module)
virtual void	insertChild (const int index, ModuleObject *const module)

额外继承的成员函数
Public 槽 继承自 dccv23::ModuleObject
virtual void	active ()
	当进入模块时，active会被调用，如无需通知则可不实现
virtual void	deactive ()
	当离开模块时，deactive会被调用，如无需通知则可不实现
void	setHidden (bool hidden)
void	setVisible (bool visible)
void	setDisabled (bool disabled)
void	setEnabled (bool enabled)
void	trigger ()
virtual void	setName (const QString &name)
virtual void	setDisplayName (const QString &displayName)
virtual void	setDescription (const QString &description)
virtual void	setContentText (const QStringList &contentText)
virtual void	addContentText (const QString &contentText)
virtual void	addContentText (const QStringList &contentText)
virtual void	setIcon (const QVariant &icon)
virtual void	setIcon (const QIcon &icon)
virtual void	setBadge (int badge)
virtual void	setFlagState (uint32_t flag, bool state)
	setFlagState 设置状态标志，状态标志共32位，高16位为预留，低16位可根据需要设置
void	setCurrentModule (ModuleObject *child)
	setCurrentModule 设置当前active的子项
静态 Public 成员函数 继承自 dccv23::ModuleObject
static int	findChild (ModuleObject *const module, ModuleObject *const child)
static unsigned	GetCurrentVersion ()
	Returns current ModuleObject version
static bool	IsVisible (dccv23::ModuleObject *const module)
	IsVisible 返回module是否显示，判断了配置项和程序设置项
static bool	IsHidden (dccv23::ModuleObject *const module)
static bool	IsHiddenFlag (uint32_t flag)
	IsHiddenFlag 判断标志是否为隐藏标志
static bool	IsEnabled (dccv23::ModuleObject *const module)
	IsEnabled 返回module是否可用，判断了配置项和程序设置项
static bool	IsDisabled (dccv23::ModuleObject *const module)
static bool	IsDisabledFlag (uint32_t flag)
	IsDisabledFlag 判断标志是否为禁用标志
属性 继承自 dccv23::ModuleObject
QString	name
QString	displayName
QString	description
QStringList	contentText
QVariant	icon
int	badge
bool	hidden
bool	disabled

成员函数说明

getClassID()

DCC_MODULE_TYPE dccv23::ItemModule::getClassID ( ) const

inlineoverridevirtual

重载 dccv23::ModuleObject .

page()

QWidget * dccv23::ItemModule::page ( )

overridevirtual

每次被调均需new新的QWidget

返回

返回自定义页面

警告

page返回的widget生命周期只是对应窗口显示的时候，即模块切换时就会被析构。ModuleObject的生命周期是从控制中心启动到关闭

重载 dccv23::ModuleObject .

---

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

• include/widgets/itemmodule.h