UserItem class reference
[Model/View module]

This class is a member of the QtLua namespace.

This class together with the UserListItem and UserItemModel classes enable easy use of list or hierarchical data structures that can be viewed and modified from lua script, Qt view widgets and C++ code.

This class implement the generic hierarchical data structure leaf node. It must be used as a base class for objects which may be exposed to Qt views via the UserItemModel class.

UserItem objects can be inserted in and removed from UserListItem objects from the C++ code with the UserItem::insert and UserItem::remove functions.

Each UserItem object have a node name used for display in Qt views and access from lua script. This name can be accessed from C++ code with the UserItem::get_name and UserItem::set_name functions.

Each data structure modification by lua script or user view interaction may be allowed or denied by reimplemention of UserItem::is_move_allowed, UserItem::is_rename_allowed, UserItem::is_remove_allowed, and UserItem::is_replace_allowed functions.

See UserItemModel for example.

• 24 members inherited from UserData

• typedef [...] const_ptr
• typedef [...] ptr

• UserItem(const String &name = [...])
• UserItem(const UserItem &item)
• ~UserItem()
• UserItemModel * get_model() const
• QModelIndex get_model_index(int column = [...]) const
• const String & get_name() const
• UserListItem * get_parent() const
• void insert(const Ref<UserListItem> &parent, int pos = [...])
• void move(const Ref<UserListItem> &parent)
• void remove()
• void set_name(const String &name)

• void data_changed(int column = [...]) const
• virtual QVariant get_data(int column, int role) const
• virtual Qt::ItemFlags get_flags(int column) const
• virtual QIcon & get_icon() const
• int get_row() const
• virtual bool is_move_allowed() const
• virtual bool is_remove_allowed() const
• virtual bool is_rename_allowed() const
• virtual bool is_replace_allowed() const
• virtual bool set_data(int column, int role)

Create a new UserItem with given name

No documentation available

No documentation available

Shortcut for Ref smart pointer class to UserItem type provided for convenience

This member access is protected.

Make model emit QAbstractItemModel::dataChanged signal for this item

This member access is protected.

May be reimplemented for column > 0, see QAbstractItemModel::data.

This member access is protected.

May be reimplemented for column > 0, see QAbstractItemModel::flags.

This member access is protected.

Must return icon decoration to use for this node.

Get associated UserItemModel

Get QModelIndex

Get item name

Get pointer to parent container

This member access is protected.

Get child position in parent item

Insert this item in parent container, remove from existing parent if any.

This member access is protected.

Must return true if item can change parent containers. (default is true)

This member access is protected.

Must return true if item can be removed from container. (default is true)

This member access is protected.

Must return true if item can renamed. (default is true)

This member access is protected.

Must return true if item can be removed by replacement by an other item (default is is_remove_allowed())

This function is deprecated.

The as UserItem::insert.

Shortcut for Ref smart pointer class to UserItem type provided for convenience

Remove this item from its container

This member access is protected.

May be reimplemented for column > 0, see QAbstractItemModel::setData.

Set item name. Name may be mangled to be a valid lua identifier.