BitmapExportParam Class Reference

Passes infomation about bitmap(s) to export. More...

#include <impexpop.h>

Inheritance diagram for BitmapExportParam:

OpParam CCObject SimpleCCObject GIFAnimationExportParam List of all members.

Public Member Functions

 BitmapExportParam ()
 Default Constructor.
 BitmapExportParam (UINT32 Count, KernelBitmap **pBitmap, BmpDlgParam *pParam)
 Used to pass around lists of bitmaps. Note that deleting the bitmap array is the responsibility of the caller.
BmpDlgParamGetBmpDlgParam ()
BOOL SetBmpDlgParam (BmpDlgParam *pParam)
 

virtual UINT32 GetBitmapCount ()
 For getting the number of bitmaps in the array!
virtual KernelBitmapGetBitmap (UINT32 Index)
 For safely getting a pointer to a bitmap in the bitmap array.
virtual LayerGetLayer (UINT32 Index)
virtual UINT32 GetLayerCount ()

Protected Attributes

BmpDlgParamm_pBmpDlgParam

Private Member Functions

 CC_DECLARE_DYNAMIC (BitmapExportParam)

Detailed Description

Passes infomation about bitmap(s) to export.

Author:
Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/6/96
See also:
OpParam

Definition at line 173 of file impexpop.h.


Constructor & Destructor Documentation

BitmapExportParam::BitmapExportParam  ) 
 

Default Constructor.

> BitmapExportParam::BitmapExportParam()

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
13/5/97

Definition at line 2024 of file impexpop.cpp.

02024                                     : OpParam(0, 0)
02025 {
02026     m_pBmpDlgParam = 0; 
02027 }

BitmapExportParam::BitmapExportParam UINT32  Count,
KernelBitmap **  pBitmap,
BmpDlgParam pParam
 

Used to pass around lists of bitmaps. Note that deleting the bitmap array is the responsibility of the caller.

Author:
Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/6/96
Parameters:
Count - The number of indexes in the array [INPUTS] pBitmap - pointer to an array of pointers to kernel bitmaps
- [OUTPUTS]
Returns:
-

Definition at line 2041 of file impexpop.cpp.

02041                                                                                               :
02042     OpParam((INT32)Count, (void *)pBitmap)
02043 {
02044     ERROR3IF(Count==0, "Zero bitmap count, that's not right");
02045     ERROR3IF(pBitmap==0, "0 bitmap array");
02046     ERROR3IF(!(*pBitmap)->IS_KIND_OF(KernelBitmap), "This dosen't seem to be an array of kernel bitmaps");
02047 
02048     // Save a reference to the BmpDlgParam, for use in BmpPrefsDlg.
02049     SetBmpDlgParam(pParam);
02050 }


Member Function Documentation

BitmapExportParam::CC_DECLARE_DYNAMIC BitmapExportParam   )  [private]
 

KernelBitmap * BitmapExportParam::GetBitmap UINT32  Index  )  [virtual]
 

For safely getting a pointer to a bitmap in the bitmap array.

Author:
Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/6/96
Parameters:
Index - the index of the required bitmap [INPUTS]
- [OUTPUTS]
Returns:
Pointer to the nth bitmap, 0 if error

Reimplemented in GIFAnimationExportParam.

Definition at line 2081 of file impexpop.cpp.

02082 {
02083     ERROR2IF(Index>=(UINT32)Param1, 0, "Index out of bounds");
02084     ERROR2IF(Param2==0, 0, "0 array");
02085 
02086     ERROR3IF( !( ( (KernelBitmap**)(void *)Param2 )[Index])->IS_KIND_OF(KernelBitmap), "This dosen't seem to be a pointer to a kernel bitmap");
02087     return( (KernelBitmap**)(void *)Param2 )[Index];
02088 }

UINT32 BitmapExportParam::GetBitmapCount  )  [virtual]
 

For getting the number of bitmaps in the array!

Author:
Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com>
Date:
11/6/96
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
The number of bitmaps in the bitmap array. (The array runs 0..Count-1)

Reimplemented in GIFAnimationExportParam.

Definition at line 2064 of file impexpop.cpp.

02065 {
02066     return (UINT32)Param1;
02067 }

BmpDlgParam* BitmapExportParam::GetBmpDlgParam  )  [inline]
 

Definition at line 180 of file impexpop.h.

00180 { return m_pBmpDlgParam; }

virtual Layer* BitmapExportParam::GetLayer UINT32  Index  )  [inline, virtual]
 

Reimplemented in GIFAnimationExportParam.

Definition at line 188 of file impexpop.h.

00188 { return NULL; }

virtual UINT32 BitmapExportParam::GetLayerCount  )  [inline, virtual]
 

Reimplemented in GIFAnimationExportParam.

Definition at line 189 of file impexpop.h.

00189 { return 0; }

BOOL BitmapExportParam::SetBmpDlgParam BmpDlgParam pParam  ) 
 

Author:
Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com>
Date:
05/01/96
Parameters:
pParam - Allows the transfer of bitmap info. [INPUTS]
- [OUTPUTS]
Returns:
-

Definition at line 2101 of file impexpop.cpp.

02102 {
02103     ERROR2IF(pParam == 0,FALSE, "pParam is 0");
02104     m_pBmpDlgParam = pParam;
02105     return TRUE;
02106 }


Member Data Documentation

BmpDlgParam* BitmapExportParam::m_pBmpDlgParam [protected]
 

Definition at line 192 of file impexpop.h.


The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:51:17 2007 for Camelot by  doxygen 1.4.4