QHashProxyRo class reference
[Container proxies module]

Declaration  

#include <QtLua/QHashProxy>

namespace QtLua {
template <typename Container> class QHashProxyRo;
};

This class is a member of the QtLua namespace.

Description  

This template class may be used to expose an attached QHash or QMap container object to lua script for read access. The QHashProxy class may be used for read/write access.

See QHashProxy class documentation for details and examples.

Members  

Inherited members  

Types  

Functions  

Members detail  

QHashProxyRo()  

Create a QHashProxy object with no attached container

QHashProxyRo(Container &hash)  

Create a QHashProxy object and attach given container

typedef Ref<const QHashProxyRo, QHashProxyRo> const_ptr  

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

virtual bool meta_contains(State *ls, const Value &key)  

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.

virtual Value meta_index(State *ls, const Value &key)  

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.

virtual Value meta_operation(State *ls, ValueBase::Operation op, const Value &a, const Value &b)  

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.

virtual Ref<Iterator> new_iterator(State *ls)  

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 QHashProxyRo type provided for convenience

void set_container(Container *hash)  

Attach or detach container. argument may be NULL

virtual bool support(ValueBase::Operation c) const  

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.

Valid XHTML 1.0 StrictGenerated by diaxen on Sat Mar 30 15:29:54 2013 using MkDoc