Enum class reference
[QObject wrapping module]


 
 

 
 


 
 

 
 


 
 

 
 


 
 

 
 


Declaration  

This class is for internal use only.

#include <internal/Enum>

namespace QtLua {
class Enum;
};

This class is a member of the QtLua namespace.

This class is declared in internal/qtluaenum.hh source file, line 43.

Description  

This internal class implements the wrapper which give access to enums of QObject objects from lua.

Members  

Inherited members  

  • 33 members inherited from Member

Types  

Function  

  • Enum(const QMetaObject *mo, int index)

Private functions  

Members detail  

Enum(const QMetaObject *mo, int index)  

This constructor is declared in internal/qtluaenum.hh source file, line 47.

virtual void completion_patch(String &path, String &entry, int &offset)  

This virtual function is declared in internal/qtluaenum.hh source file, line 54.

This member access is private.

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

Documentation inherited from base class:

This function may be reimplemented to further modify completion result on console line when completed to a UserData value. This is usefull to append a dot or a pair of brackets access operator to the userdata value name for instance.

Parameters list:

  • path: Completion result tables path to userdata value.
  • entry: Completion result userdata name. May append to this string directly.
  • offset: Cursor offset. May be decreased to place cursor between inserted brackets for instance.

typedef Ref<const Enum, Enum> const_ptr  

This typedef is declared in QTLUA_REFTYPE function like macro expansion, line 3 in internal/qtluaenum.hh source file, line 45.

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

virtual String get_value_str() const  

This virtual function is declared in internal/qtluaenum.hh source file, line 53.

This member access is private.

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

Documentation inherited from base class:

This function returns an string value describing object value or content. The default implementation returns an hexadecimal object pointer. This is used for mainly for pretty printing.

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

This virtual function is declared in internal/qtluaenum.hh source file, line 50.

This member access is private.

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 Ref<Iterator> new_iterator(State *ls)  

This virtual function is declared in internal/qtluaenum.hh source file, line 51.

This member access is private.

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.

typedef Ref<Enum, Enum> ptr  

This typedef is declared in QTLUA_REFTYPE function like macro expansion, line 5 in internal/qtluaenum.hh source file, line 45.

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

virtual bool support(ValueBase::Operation c) const  

This virtual function is declared in internal/qtluaenum.hh source file, line 52.

This member access is private.

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 16:23:03 2013 using MkDoc