GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • PythonQtClassInfo.h

This view

  • Original page
  • New address

GeezerVison is showing mevislab.github.io — PythonQt: PythonQtClassInfo Class Reference

PythonQt
Classes | Public Member Functions | Static Public Member Functions | List of all members
PythonQtClassInfo Class Reference

a class that stores all required information about a Qt object (and an optional associated C++ class name) More...

#include <PythonQtClassInfo.h>

Classes

struct  ParentClassInfo
 store information about parent classes More...

Public Member Functions

 PythonQtClassInfo ()
 ~PythonQtClassInfo ()
void setupQObject (const QMetaObject *meta)
 setup as a QObject, taking the meta object as meta information about the QObject
void setupCPPObject (const QByteArray &classname)
 setup as a CPP (non-QObject), taking the classname
void setTypeSlots (int typeSlots)
 set the type capabilities
int typeSlots () const
 get the type capabilities
PythonQtMemberInfo member (const char *member)
 get the Python method definition for a given slot name (without return type and signature)
PythonQtSlotInfo * constructors ()
 get access to the constructor slot (which may be overloaded if there are multiple constructors)
PythonQtSlotInfo * destructor ()
 get access to the destructor slot
void addConstructor (PythonQtSlotInfo *info)
 add a constructor, ownership is passed to classinfo
void setDestructor (PythonQtSlotInfo *info)
 set a destructor, ownership is passed to classinfo
void addDecoratorSlot (PythonQtSlotInfo *info)
 add a decorator slot, ownership is passed to classinfo
void addNestedClass (PythonQtClassInfo *info)
 add a nested class, so that it can be shown as outer class member
const QByteArray & className () const
 get the classname (either of the QObject or of the wrapped CPP object)
QByteArray unscopedClassName () const
 get the unscoped classname (without ParentClass::) for nested classes
bool isQObject ()
 returns if the QObject
bool isCPPWrapper ()
 returns if the class is a CPP wrapper
const QMetaObject * metaObject ()
 get the meta object
void setMetaObject (const QMetaObject *meta)
 set the meta object, this will reset the caching
bool inherits (const char *classname)
 returns if this class inherits from the given classname
bool inherits (PythonQtClassInfo *info)
 returns if this class inherits from the given classinfo
void * castTo (void *ptr, const char *classname)
QString help ()
 get help string for the metaobject
QStringList propertyList ()
 get list of all properties (on QObjects only, otherwise the list is empty)
QStringList memberList ()
 get list of all members (excluding properties, which can be listed with propertyList())
int metaTypeId ()
 get the meta type id of this class (only valid for isCPPWrapper() == true)
void setDecoratorProvider (PythonQtQObjectCreatorFunctionCB *cb)
 set an additional decorator provider that offers additional decorator slots for this class
QObject * decorator ()
 get the decorator qobject instance
void addParentClass (const ParentClassInfo &info)
 add the parent class info of a CPP object
void setPythonQtClassWrapper (PyObject *obj)
 set the associated PythonQtClassWrapper (which handles instance creation of this type)
PyObject * pythonQtClassWrapper ()
 get the associated PythonQtClassWrapper (which handles instance creation of this type)
void setShellSetInstanceWrapperCB (PythonQtShellSetInstanceWrapperCB *cb)
 set the shell set instance wrapper cb
PythonQtShellSetInstanceWrapperCB * shellSetInstanceWrapperCB ()
 get the shell set instance wrapper cb
void addPolymorphicHandler (PythonQtPolymorphicHandlerCB *cb)
 add a handler for polymorphic downcasting
void * castDownIfPossible (void *ptr, PythonQtClassInfo **resultClassInfo)
 cast the pointer down in the class hierarchy if a polymorphic handler allows to do that
void clearNotFoundCachedMembers ()
 clear all members that where cached as "NotFound"
const QList< PythonQtClassInfo * > & nestedClasses ()
 get nested classes
PyObject * copyObject (void *cppObject)
PythonQtSlotInfo * getCopyConstructor ()
 Get the copy constructor for this class.
void setReferenceCounting (PythonQtVoidPtrCB *refCB, PythonQtVoidPtrCB *unrefCB)
 Sets reference counting callbacks for this class and all its subclasses.
PythonQtVoidPtrCB * referenceCountingRefCB ()
 Returns the ref counting CB, if there is any.
PythonQtVoidPtrCB * referenceCountingUnrefCB ()
 Returns the unref counting CB, if there is any.
PyObject * getPythonTypeForProperty (const QString &name)
PythonQtClassInfo * getClassInfoForProperty (const QString &name)
 Returns the class info for given property, if available.
bool supportsRichCompare ()

Static Public Member Functions

static PyObject * findEnumWrapper (const QByteArray &name, PythonQtClassInfo *localScope, bool *isLocalEnum=nullptr)
 returns if the localScope has an enum of that type name or if the enum contains a :: scope, if that class contails the enum
static QByteArray escapeReservedNames (const QByteArray &name)
static void addGlobalNamespaceWrapper (PythonQtClassInfo *namespaceWrapper)
 Add a wrapper that contains global enums.
static void clearGlobalNamespaceWrappers ()

Detailed Description

a class that stores all required information about a Qt object (and an optional associated C++ class name)

for fast lookup of slots when calling the object from Python

Definition at line 88 of file PythonQtClassInfo.h.

Constructor & Destructor Documentation

◆ PythonQtClassInfo()

PythonQtClassInfo::PythonQtClassInfo ( )

Referenced by addGlobalNamespaceWrapper(), addNestedClass(), castDownIfPossible(), findEnumWrapper(), getClassInfoForProperty(), inherits(), and PythonQtClassInfo::ParentClassInfo::ParentClassInfo().

◆ ~PythonQtClassInfo()

PythonQtClassInfo::~PythonQtClassInfo ( )

Member Function Documentation

◆ addConstructor()

void PythonQtClassInfo::addConstructor ( PythonQtSlotInfo * info)

add a constructor, ownership is passed to classinfo

◆ addDecoratorSlot()

void PythonQtClassInfo::addDecoratorSlot ( PythonQtSlotInfo * info)

add a decorator slot, ownership is passed to classinfo

◆ addGlobalNamespaceWrapper()

void PythonQtClassInfo::addGlobalNamespaceWrapper ( PythonQtClassInfo * namespaceWrapper)
static

Add a wrapper that contains global enums.

References PythonQtClassInfo().

◆ addNestedClass()

void PythonQtClassInfo::addNestedClass ( PythonQtClassInfo * info)

add a nested class, so that it can be shown as outer class member

References PythonQtClassInfo().

◆ addParentClass()

void PythonQtClassInfo::addParentClass ( const ParentClassInfo & info)
inline

add the parent class info of a CPP object

Definition at line 185 of file PythonQtClassInfo.h.

185{ _parentClasses.append(info); }

◆ addPolymorphicHandler()

void PythonQtClassInfo::addPolymorphicHandler ( PythonQtPolymorphicHandlerCB * cb)
inline

add a handler for polymorphic downcasting

Definition at line 200 of file PythonQtClassInfo.h.

200{ _polymorphicHandlers.append(cb); }

◆ castDownIfPossible()

void * PythonQtClassInfo::castDownIfPossible ( void * ptr,
PythonQtClassInfo ** resultClassInfo )

cast the pointer down in the class hierarchy if a polymorphic handler allows to do that

References PythonQtClassInfo().

◆ castTo()

void * PythonQtClassInfo::castTo ( void * ptr,
const char * classname )

casts the given ptr to an object of type classname, returns the new pointer which might be different to ptr due to C++ multiple inheritance (if the cast is not possible or if ptr is NULL, NULL is returned)

◆ className()

const QByteArray & PythonQtClassInfo::className ( ) const

get the classname (either of the QObject or of the wrapped CPP object)

Referenced by PythonQtConvertListOfKnownClassToPythonList(), and PythonQtConvertPythonListToListOfKnownClass().

◆ clearGlobalNamespaceWrappers()

void PythonQtClassInfo::clearGlobalNamespaceWrappers ( )
static

Clear the registry of global-namespace wrappers (used for top-level enums). Must be called before destroying PythonQtClassInfo instances and before a fresh init.

References findEnumWrapper().

◆ clearNotFoundCachedMembers()

void PythonQtClassInfo::clearNotFoundCachedMembers ( )

clear all members that where cached as "NotFound"

◆ constructors()

PythonQtSlotInfo * PythonQtClassInfo::constructors ( )

get access to the constructor slot (which may be overloaded if there are multiple constructors)

◆ copyObject()

PyObject * PythonQtClassInfo::copyObject ( void * cppObject)

Create a copy of the given C++ object (which is known to be of a derived class), wrapped by Python and owned by PythonQt. This will downcast if possible and return a copy of the down casted object. This either requires a copy constructor on the class or it needs to be registered as a meta type.

◆ decorator()

QObject * PythonQtClassInfo::decorator ( )

get the decorator qobject instance

◆ destructor()

PythonQtSlotInfo * PythonQtClassInfo::destructor ( )

get access to the destructor slot

◆ escapeReservedNames()

QByteArray PythonQtClassInfo::escapeReservedNames ( const QByteArray & name)
static

Sometimes enum values use a reserved name in Python. In this case replace it with something that is not reserved

◆ findEnumWrapper()

PyObject * PythonQtClassInfo::findEnumWrapper ( const QByteArray & name,
PythonQtClassInfo * localScope,
bool * isLocalEnum = nullptr )
static

returns if the localScope has an enum of that type name or if the enum contains a :: scope, if that class contails the enum

References PythonQtClassInfo().

Referenced by clearGlobalNamespaceWrappers().

◆ getClassInfoForProperty()

PythonQtClassInfo * PythonQtClassInfo::getClassInfoForProperty ( const QString & name)

Returns the class info for given property, if available.

References PythonQtClassInfo().

◆ getCopyConstructor()

PythonQtSlotInfo * PythonQtClassInfo::getCopyConstructor ( )

Get the copy constructor for this class.

◆ getPythonTypeForProperty()

PyObject * PythonQtClassInfo::getPythonTypeForProperty ( const QString & name)

Returns the Python type object for a given property. (the returned object does not get an extra reference count)

◆ help()

QString PythonQtClassInfo::help ( )

get help string for the metaobject

◆ inherits() [1/2]

bool PythonQtClassInfo::inherits ( const char * classname)

returns if this class inherits from the given classname

◆ inherits() [2/2]

bool PythonQtClassInfo::inherits ( PythonQtClassInfo * info)

returns if this class inherits from the given classinfo

References PythonQtClassInfo().

◆ isCPPWrapper()

bool PythonQtClassInfo::isCPPWrapper ( )
inline

returns if the class is a CPP wrapper

Definition at line 147 of file PythonQtClassInfo.h.

147{ return !_isQObject; }

◆ isQObject()

bool PythonQtClassInfo::isQObject ( )
inline

returns if the QObject

Definition at line 144 of file PythonQtClassInfo.h.

144{ return _isQObject; }

◆ member()

PythonQtMemberInfo PythonQtClassInfo::member ( const char * member)

get the Python method definition for a given slot name (without return type and signature)

References member().

Referenced by member().

◆ memberList()

QStringList PythonQtClassInfo::memberList ( )

get list of all members (excluding properties, which can be listed with propertyList())

◆ metaObject()

const QMetaObject * PythonQtClassInfo::metaObject ( )
inline

get the meta object

Definition at line 150 of file PythonQtClassInfo.h.

150{ return _meta; }

◆ metaTypeId()

int PythonQtClassInfo::metaTypeId ( )
inline

get the meta type id of this class (only valid for isCPPWrapper() == true)

Definition at line 176 of file PythonQtClassInfo.h.

176{ return _metaTypeId; }

◆ nestedClasses()

const QList< PythonQtClassInfo * > & PythonQtClassInfo::nestedClasses ( )
inline

get nested classes

Definition at line 212 of file PythonQtClassInfo.h.

212{ return _nestedClasses; }

◆ propertyList()

QStringList PythonQtClassInfo::propertyList ( )

get list of all properties (on QObjects only, otherwise the list is empty)

◆ pythonQtClassWrapper()

PyObject * PythonQtClassInfo::pythonQtClassWrapper ( )
inline

get the associated PythonQtClassWrapper (which handles instance creation of this type)

Definition at line 191 of file PythonQtClassInfo.h.

191{ return _pythonQtClassWrapper; }

◆ referenceCountingRefCB()

PythonQtVoidPtrCB * PythonQtClassInfo::referenceCountingRefCB ( )

Returns the ref counting CB, if there is any.

◆ referenceCountingUnrefCB()

PythonQtVoidPtrCB * PythonQtClassInfo::referenceCountingUnrefCB ( )

Returns the unref counting CB, if there is any.

◆ setDecoratorProvider()

void PythonQtClassInfo::setDecoratorProvider ( PythonQtQObjectCreatorFunctionCB * cb)

set an additional decorator provider that offers additional decorator slots for this class

◆ setDestructor()

void PythonQtClassInfo::setDestructor ( PythonQtSlotInfo * info)

set a destructor, ownership is passed to classinfo

◆ setMetaObject()

void PythonQtClassInfo::setMetaObject ( const QMetaObject * meta)

set the meta object, this will reset the caching

◆ setPythonQtClassWrapper()

void PythonQtClassInfo::setPythonQtClassWrapper ( PyObject * obj)
inline

set the associated PythonQtClassWrapper (which handles instance creation of this type)

Definition at line 188 of file PythonQtClassInfo.h.

188{ _pythonQtClassWrapper = obj; }

◆ setReferenceCounting()

void PythonQtClassInfo::setReferenceCounting ( PythonQtVoidPtrCB * refCB,
PythonQtVoidPtrCB * unrefCB )

Sets reference counting callbacks for this class and all its subclasses.

◆ setShellSetInstanceWrapperCB()

void PythonQtClassInfo::setShellSetInstanceWrapperCB ( PythonQtShellSetInstanceWrapperCB * cb)
inline

set the shell set instance wrapper cb

Definition at line 194 of file PythonQtClassInfo.h.

194{ _shellSetInstanceWrapperCB = cb; }

◆ setTypeSlots()

void PythonQtClassInfo::setTypeSlots ( int typeSlots)
inline

set the type capabilities

Definition at line 112 of file PythonQtClassInfo.h.

112{ _typeSlots = typeSlots; }
PythonQtClassInfo::typeSlots
int typeSlots() const
get the type capabilities
Definition PythonQtClassInfo.h:114

References typeSlots().

◆ setupCPPObject()

void PythonQtClassInfo::setupCPPObject ( const QByteArray & classname)

setup as a CPP (non-QObject), taking the classname

◆ setupQObject()

void PythonQtClassInfo::setupQObject ( const QMetaObject * meta)

setup as a QObject, taking the meta object as meta information about the QObject

◆ shellSetInstanceWrapperCB()

PythonQtShellSetInstanceWrapperCB * PythonQtClassInfo::shellSetInstanceWrapperCB ( )
inline

get the shell set instance wrapper cb

Definition at line 197 of file PythonQtClassInfo.h.

197{ return _shellSetInstanceWrapperCB; }

◆ supportsRichCompare()

bool PythonQtClassInfo::supportsRichCompare ( )

Returns if the class supports rich compare. This tests for eq, ne, lt, le, gt, ge slots and if any of the slots is present it returns true and modifies the _typeSlots with Type_RichCompare. The result is cached internally.

◆ typeSlots()

int PythonQtClassInfo::typeSlots ( ) const
inline

get the type capabilities

Definition at line 114 of file PythonQtClassInfo.h.

114{ return _typeSlots; }

Referenced by setTypeSlots().

◆ unscopedClassName()

QByteArray PythonQtClassInfo::unscopedClassName ( ) const

get the unscoped classname (without ParentClass::) for nested classes

The documentation for this class was generated from the following file:
  • PythonQtClassInfo.h
Generated on for PythonQt by doxygen 1.15.0
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.