Detailed Description
- See also:
- Class
BMM_IOList.
- Description:
- This class provides methods that access properties of the IO module. All methods of this class are implemented by the system.
#include <bitmap.h>
Inheritance diagram for BMM_IOHandler:
Public Member Functions |
|
| BMMExport | BMM_IOHandler () |
| BMMExport MCHAR * | ShortDescription (const MCHAR *d=NULL) |
| BMMExport MCHAR * | LongDescription (const MCHAR *d=NULL) |
| BMMExport MCHAR * | Extension (int index, const MCHAR *e=NULL) |
| BMMExport int | NumExtensions () |
| BMMExport void | SetCD (ClassDesc *dll) |
| This grabs the ClassID and the SuperClassID
of Class Descriptor that gets passed in. |
|
| BMMExport ClassDesc * | GetCD () |
| BMMExport Class_ID | GetClassID () |
| BMMExport SClass_ID | GetSuperID () |
| BMMExport void | SetDllNumber (int num) |
| BMMExport int | GetDllNum () |
| BMMExport void | SetCapabilities (DWORD cap) |
| BMMExport DWORD | GetCapabilities () |
| BMMExport BOOL | TestCapabilities (DWORD cap) |
| BMMExport BMM_IOHandler & | operator= (BMM_IOHandler &from) |
Constructor & Destructor Documentation
| BMMExport BMM_IOHandler | ( | ) |
- Remarks:
- Constructor. The description string is set to NULL, the capabilities are set to NONE, and the Class Descriptor is set to NULL.
Member Function Documentation
| BMMExport MCHAR* ShortDescription | ( | const MCHAR * | d = NULL |
) |
- Remarks:
- Returns the short description string for the IO module, and optionally sets it to d if it is not NULL.
- Parameters:
- const MCHAR *d = NULL
The short description string to set.
| BMMExport MCHAR* LongDescription | ( | const MCHAR * | d = NULL |
) |
- Remarks:
- Returns the long description string for the IO module, and optionally sets it to d if it is not NULL.
- Parameters:
- const MCHAR *d = NULL
The long description string to set.
| BMMExport MCHAR* Extension | ( | int | index, |
| const MCHAR * | e = NULL |
||
| ) |
- Remarks:
- Returns the specified IO module file name extension, and optionally sets it to e if it is not NULL.
- Parameters:
- int index
The index of the extension.
const MCHAR *e = NULL
The extension string.
| BMMExport int NumExtensions | ( | ) | [inline] |
- Remarks:
- Returns the number of file name extensions for the IO module.
{ return ioExtension.Count(); }
| BMMExport void SetCD | ( | ClassDesc * | dll | ) |
This grabs the ClassID and the SuperClassID of Class Descriptor that gets passed in.
It does not grab a hold of the Class Descriptor pointer itself. dll - A pointer to the class descriptor.
| BMMExport ClassDesc* GetCD | ( | ) |
- Remarks:
- Returns the class descriptor for the IO module.
| BMMExport Class_ID GetClassID | ( | ) |
| BMMExport SClass_ID GetSuperID | ( | ) |
| BMMExport void SetDllNumber | ( | int | num | ) | [inline] |
{ dllNumber = num; }
| BMMExport int GetDllNum | ( | ) | [inline] |
{ return dllNumber; }
| BMMExport void SetCapabilities | ( | DWORD | cap | ) | [inline] |
- Remarks:
- Sets the capabilities flag for the IO module.
- Parameters:
- DWORD cap
See BitmapIO Capability Flags.
{ ioCapabilities |= cap;};
| BMMExport DWORD GetCapabilities | ( | ) | [inline] |
- Remarks:
- Returns the capabilities flag for the IO module.
- Returns:
- See BitmapIO Capability Flags.
{ return (ioCapabilities);};
| BMMExport BOOL TestCapabilities | ( | DWORD | cap | ) | [inline] |
- Remarks:
- Tests the capability flags passed.
- Parameters:
- DWORD cap
See BitmapIO Capability Flags.
- Returns:
- TRUE if the flags were set; otherwise FALSE.
- Operators:
{ return ((ioCapabilities& cap) != 0);};
| BMMExport BMM_IOHandler& operator= | ( | BMM_IOHandler & | from | ) |
- Remarks:
- Assignment operator.
