SubClassList Class Reference
A collection of ClassEntry objects that have the same super class id. More...
#include <plugin.h>
Inheritance diagram for SubClassList:
Public Member Functions | |
| CoreExport ClassEntry & | operator[] (int i) const |
| Returns a reference to the 'i-th' ClassEntry for this super class. More... | |
| CoreExport int | FindClass (Class_ID classID) const |
| Returns the index in the list of sub-classes of the class whose Class_ID is passed. More... | |
| CoreExport int | FindClass (const MCHAR *name) const |
| Returns the index in the list of sub-classes of the class whose ClassName() is passed. More... | |
| CoreExport void | AddClass (ClassDesc *cld, int dllNum, int index, bool load) |
| CoreExport int | Count (int accType) const |
| Returns the number of sub-classes that match the specified access type. More... | |
| CoreExport SClass_ID | SuperID () const |
| Returns the Super class ID corresponding to this sub-class list. More... | |
| CoreExport int | GetFirst (int accType) const |
| Returns the index of the first ClassEntry of the specified type in the list of sub-classes. More... | |
| CoreExport int | GetNext (int accType) const |
| Returns the index of the next ClassEntry of the specified type (or -1 at the end). More... | |
| CoreExport int | operator== (const SubClassList &lst) const |
| Equality operator. More... | |
| CoreExport int | operator== (const SubClassList &sl) |
| Equality operator. More... | |
| CoreExport int | DeleteClass (ClassDesc *cld) |
| CoreExport void | SetUIInfo (SClassUIInfo *uiInfo) |
| Allows developer to provide some additional information on a superclass. More... | |
| CoreExport SClassUIInfo * | GetUIInfo () const |
| This method returns additional user interface related information on a given superclass. More... | |
| CoreExport void | ReplaceClass (int idx, ClassDesc *cld, int dllNum, int index, bool load) |
| ~SubClassList () | |
| SubClassList (SClass_ID sid) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MaxHeapOperators | |
| static UtilExport void * | operator new (size_t size) |
| Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e) |
| Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new (size_t size, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new (size_t size, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate arrays of objects. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void | operator delete (void *ptr) |
| Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, void *placement_ptr) |
| Placement new operator. More... | |
| static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
| Placement delete operator. More... | |
| static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
| Allocates memory on a specified alignment boundary. More... | |
| static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
| Reallocates memory on a specified alignment boundary. More... | |
| static UtilExport void | aligned_free (void *ptr) |
| Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More... | |
| Protected Member Functions inherited from Noncopyable | |
| Noncopyable () | |
| ~Noncopyable () | |
Detailed Description
A collection of ClassEntry objects that have the same super class id.
Clients can get a SubClassList via ClassDirectory::GetClassList().
- See also
- Class DllDir, Class ClassDirectory, Class ClassEntry, Class ClassDesc, Class SClassUIInfo.
Constructor & Destructor Documentation
◆ ~SubClassList()
| ~SubClassList | ( | ) |
Destructor
◆ SubClassList()
| SubClassList | ( | SClass_ID | sid | ) |
Constructor
Member Function Documentation
◆ operator[]()
| CoreExport ClassEntry& operator[] | ( | int | i | ) | const |
Returns a reference to the 'i-th' ClassEntry for this super class.
- Parameters
-
i - The index of the entry to return. Valid values begin at an index of 1.
◆ FindClass() [1/2]
| CoreExport int FindClass | ( | Class_ID | classID | ) | const |
Returns the index in the list of sub-classes of the class whose Class_ID is passed.
- Parameters
-
classID - Specifies which class to return the index of.
◆ FindClass() [2/2]
| CoreExport int FindClass | ( | const MCHAR * | name | ) | const |
Returns the index in the list of sub-classes of the class whose ClassName() is passed.
- Parameters
-
name - Specifies which class to return the index of.
◆ AddClass()
| CoreExport void AddClass | ( | ClassDesc * | cld, |
| int | dllNum, | ||
| int | index, | ||
| bool | load | ||
| ) |
This method is used internally.
◆ Count()
| CoreExport int Count | ( | int | accType | ) | const |
Returns the number of sub-classes that match the specified access type.
- Parameters
-
accType - One of the following values: ACC_PUBLIC - public classes ACC_PRIVATE - non-public classes ACC_ALL - both of the above (ACC_PUBLIC|ACC_PRIVATE).
◆ SuperID()
| CoreExport SClass_ID SuperID | ( | ) | const |
Returns the Super class ID corresponding to this sub-class list.
◆ GetFirst()
| CoreExport int GetFirst | ( | int | accType | ) | const |
Returns the index of the first ClassEntry of the specified type in the list of sub-classes.
- Parameters
-
accType - One of the following values: ACC_PUBLIC - public classes ACC_PRIVATE - non-public classes
◆ GetNext()
| CoreExport int GetNext | ( | int | accType | ) | const |
Returns the index of the next ClassEntry of the specified type (or -1 at the end).
- Parameters
-
accType - One of the following values: ACC_PUBLIC - public classes ACC_PRIVATE - non-public classes
◆ operator==() [1/2]
| CoreExport int operator== | ( | const SubClassList & | lst | ) | const |
Equality operator.
◆ operator==() [2/2]
| CoreExport int operator== | ( | const SubClassList & | sl | ) |
Equality operator.
◆ DeleteClass()
| CoreExport int DeleteClass | ( | ClassDesc * | cld | ) |
◆ SetUIInfo()
| CoreExport void SetUIInfo | ( | SClassUIInfo * | uiInfo | ) |
Allows developer to provide some additional information on a superclass.
Currently this includes a color, and a method which draws a representative image in a Windows DC.
- Parameters
-
uiInfo - Points to the information to set.
◆ GetUIInfo()
| CoreExport SClassUIInfo* GetUIInfo | ( | ) | const |
This method returns additional user interface related information on a given superclass.
Returns NULL if no superclass information was assigned.
