UserListItem class reference
[Model/View module]

This class is a member of the QtLua namespace.

This class together with the UserItem 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.

UserListItem objects are UserItem objects with pointer list to children objects. They can be accessed as tables from lua script.

See UserItemModel for example.

• 44 members inherited from UserItem

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

• UserListItem()
• ~UserListItem()
• Ref<UserItem> get_child(const String &name) const
• virtual int get_child_count() const
• const QList<Ref<UserItem>> & get_list() const
• virtual bool meta_contains(State *ls, const Value &key)
• virtual Value meta_index(State *ls, const Value &key)
• virtual void meta_newindex(State *ls, const Value &key, const Value &value)
• virtual Value meta_operation(State *ls, ValueBase::Operation op, const Value &a, const Value &b)
• virtual Ref<Iterator> new_iterator(State *ls)
• virtual bool support(ValueBase::Operation c) const

• virtual bool accept_child(const Ref<UserItem> &item) const
• virtual void child_changed()
• virtual String default_child_name(int row) const
• virtual int get_column_count() const

No documentation available

No documentation available

This member access is protected.

This function can be reimplemented to allow or deny items membership when inserted from lua script or Qt view.

The return value is true if item is allowed to be a child member.

This member access is protected.

This function is called when a child is added, removed or changes name. Default implementation does nothing.

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

This member access is protected.

This function returns default name of the child item used when first inserted if not already set.

Find a child item from name.

This virtual function overrides the get_child_count virtual function defined in the UserItem base class.

Get number of childs

This member access is protected.

Must return columns count for children of this node, default implementation returns 1.

Get child items list

This virtual function overrides the meta_contains virtual function defined in the UserData base class.

Documentation inherited from base class:

This function returns true if either the ValueBase::OpIndex operation or the ValueBase::OpNewindex operation is supported and an entry is associated to the given key.

The default implementation returns !meta_index(ls, key).is_nil() or false if UserData::meta_index throws.

This virtual function overrides the meta_index virtual function defined in the UserData base class.

Documentation inherited from base class:

This function is called when a table read access operation is attempted on a userdata object. The default implementation throws an error message. The UserData::support function must be reimplemented along with this function to report ValueBase::OpIndex as supported.

Parameters list:

• key: Value used as table index.

The return value is Table access result value.

This virtual function overrides the meta_newindex virtual function defined in the UserData base class.

Documentation inherited from base class:

This function is called when a table write access operation is attempted on a userdata object. The default implementation throws an error message. The UserData::support function must be reimplemented along with this function to report ValueBase::OpNewindex as supported.

Parameters list:

• key: Value used as table index.
• value: Value to put in table.

This virtual function overrides the meta_operation virtual function defined in the UserData base class.

Documentation inherited from base class:

This function is called when a lua operator is used with a UserData object. The default implementation throws an error message. The UserData::support function must be reimplemented along with this function.

Parameters list:

• op: Specify invoked lua operator (see ValueBase::Operation).
• a: First value involved in operation.
• b: Second value involved in operation for binary operators.

The return value is Operation result value.

This virtual function overrides the new_iterator virtual function defined in the UserData base class.

Documentation inherited from base class:

This function may return an Iterator object used to iterate over an userdata object. The default implementation throws an error message. The UserData::support function must be reimplemented along with this function to report ValueBase::OpIterate as supported.

The return value is an Iterator based iterator object.

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

This virtual function overrides the support virtual function defined in the UserData base class.

Documentation inherited from base class:

Check given operation support.

See also ValueBase::support function.