HandleTable Class Reference

Provide a mirror of the table of handles maintained by GDI when importing a MetaFile. This is necessary because, given a GDI handle, it is not possible to ask GDI what kind of object it is, and hence work out e.g. what kind of pen/brush it is. This class therefore creates, selects, and deletes handle objects in the same way that GDI would (see EnumMetafile help in SDK documentation for further details...possibly). At the moment, this HandleTable only supports pens and brushes. More...

List of all members.

Public Member Functions
	HandleTable (MetaFileFilter *)
	Initialises the HandleTable. The table initially contains no entries.
	~HandleTable ()
	Deinitialises a handle table; deallocates the handle table.
BOOL	CreatePen (LOGPEN_16 *)
	Create a handle for the specified pen in the HandleTable, and store the pen information in this.
BOOL	CreateBrush (LOGBRUSH_16 *)
	Create a handle for the specified brush in the HandleTable, and store the brush information in this.
BOOL	CreatePalette (LOGPALETTE_16 *)
	Creates a Palette object ready for use.
BOOL	CreatePatternBrush (WORD *)
	Creates a PatternBrush object ready for use.
BOOL	CreateFontIndirect (LOGFONT_16 *)
	Creates a Font object ready for use.
BOOL	CreateRegion (WORD *)
	Creates a Region object ready for use.
BOOL	SelectObject (INT32 Index)
	Mimic the selection of a GDI object. This function will update the relevant status variables in the associated MetaFileFilter object.
BOOL	DeleteObject (INT32 Index)
	Deletes a handle from the Handle table. The index of this handle should no longer be used (unless, of course, it is reallocated to a new handle).
Private Member Functions
INT32	FindFreeSlot ()
	Find the index of the first free slot available in the handle table. If no free handles are found, the table is expanded and the index of the first new slot is returned. If it is not possible to expand the table (out of memerory) then BAD_SLOT is returned.
Private Attributes
MetaFileFilter *	Context
HandleRecord *	Handles
INT32	TableSize

---

Detailed Description

Provide a mirror of the table of handles maintained by GDI when importing a MetaFile. This is necessary because, given a GDI handle, it is not possible to ask GDI what kind of object it is, and hence work out e.g. what kind of pen/brush it is. This class therefore creates, selects, and deletes handle objects in the same way that GDI would (see EnumMetafile help in SDK documentation for further details...possibly). At the moment, this HandleTable only supports pens and brushes.

Author:

Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>

Date:

28/03/94

See also:

HandleRecord; MetaFileFilter

Definition at line 260 of file metafilt.cpp.

---

Constructor & Destructor Documentation

HandleTable::HandleTable (  MetaFileFilter *  pFilter  )

Initialises the HandleTable. The table initially contains no entries. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/03/94 See also: HandleTable Definition at line 302 of file metafilt.cpp. { Handles = NULL; TableSize = 0; Context = pFilter; }

HandleTable::~HandleTable (   )

Deinitialises a handle table; deallocates the handle table. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/03/94 See also: HandleTable Definition at line 320 of file metafilt.cpp. { CCFree(Handles); Handles = NULL; TableSize = 0; }

---

Member Function Documentation

BOOL HandleTable::CreateBrush (  LOGBRUSH_16 *  pBrush  )

Create a handle for the specified brush in the HandleTable, and store the brush information in this. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/03/94 Parameters: pBrush  - the logical brush information for this brush. [INPUTS] (See LOGBRUSH in Win16 SDK Help) Returns: TRUE if handle was created ok, FALSE if not. Errors: Out of memory. See also: HandleTable::CreatePen Definition at line 477 of file metafilt.cpp. { INT32 Style = pBrush->lbStyle; COLORREF Col = (COLORREF) pBrush->lbColor; // Get a new slot to put this pen in INT32 Slot = FindFreeSlot(); if (Slot == BAD_SLOT) // Could not create this pen return FALSE; Handles[Slot].Type = HANDLE_BRUSH; switch (Style) { case BS_SOLID: Handles[Slot].Colour = DocColour(GetRValue(Col), GetGValue(Col), GetBValue(Col)); break; case BS_NULL: Handles[Slot].Colour = DocColour(COLOUR_TRANS); break; default: ENSURE(FALSE, "Unknown brush style in metafile!"); ERROR(_R(IDT_BAD_METAFILE), FALSE); } // All ok return TRUE; }

BOOL HandleTable::CreateFontIndirect (  LOGFONT_16 *  pNewFont  )

Creates a Font object ready for use. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 18/5/95 Parameters: pNewFont  - the font we are creating [INPUTS] Returns: TRUE if it worked, FALSE if there was a problem Definition at line 576 of file metafilt.cpp. { // Get a new slot to put this pen in INT32 Slot = FindFreeSlot(); // Could not create this Palette if (Slot == BAD_SLOT) return FALSE; // Say what this is Handles[Slot].Type = HANDLE_FONTINDIRECT; Handles[Slot].pFont = pNewFont; // return Happy return TRUE; }

BOOL HandleTable::CreatePalette (  LOGPALETTE_16 *   )

Creates a Palette object ready for use. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 18/5/95 Returns: TRUE if it worked, FALSE if there was a problem Definition at line 521 of file metafilt.cpp. { // Get a new slot to put this pen in INT32 Slot = FindFreeSlot(); // Could not create this Palette if (Slot == BAD_SLOT) return FALSE; // Say what this is Handles[Slot].Type = HANDLE_PALETTE; // return Happy return TRUE; }

BOOL HandleTable::CreatePatternBrush (  WORD *   )

Creates a PatternBrush object ready for use. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 18/5/95 Returns: TRUE if it worked, FALSE if there was a problem Definition at line 548 of file metafilt.cpp. { // Get a new slot to put this pen in INT32 Slot = FindFreeSlot(); // Could not create this Palette if (Slot == BAD_SLOT) return FALSE; // Say what this is Handles[Slot].Type = HANDLE_PATTERNBRUSH; // return Happy return TRUE; }

BOOL HandleTable::CreatePen (  LOGPEN_16 *  pPen  )

Create a handle for the specified pen in the HandleTable, and store the pen information in this. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/03/94 Parameters: pPen  - the logical pen information for this pen. [INPUTS] (See LOGPEN in Win16 SDK Help) Returns: TRUE if handle was created ok, FALSE if not. Errors: Out of memory. See also: HandleTable::CreateBrush Definition at line 422 of file metafilt.cpp. { INT32 Style = pPen->lopnStyle; COLORREF Col = (COLORREF) pPen->lopnColor; // Get a new slot to put this pen in INT32 Slot = FindFreeSlot(); if (Slot == BAD_SLOT) // Could not create this pen return FALSE; Handles[Slot].Type = HANDLE_PEN; switch (Style) { case PS_SOLID: case PS_INSIDEFRAME: Handles[Slot].Colour = DocColour(GetRValue(Col), GetGValue(Col), GetBValue(Col)); break; case PS_NULL: Handles[Slot].Colour = DocColour(COLOUR_TRANS); break; default: ENSURE(FALSE, "Unknown pen style in metafile!"); ERROR(_R(IDT_BAD_METAFILE), FALSE); } // Scale pen width to document coordinates. DocCoord PenSize(pPen->lopnWidth.x, 0); Context->ScaleCoord(&PenSize); Handles[Slot].PenWidth = PenSize.x; // All ok return TRUE; }

BOOL HandleTable::CreateRegion (  WORD *   )

Creates a Region object ready for use. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 18/5/95 Returns: TRUE if it worked, FALSE if there was a problem Definition at line 604 of file metafilt.cpp. { // Get a new slot to put this pen in INT32 Slot = FindFreeSlot(); // Could not create this Palette if (Slot == BAD_SLOT) return FALSE; // Say what this is Handles[Slot].Type = HANDLE_REGION; // return Happy return TRUE; }

BOOL HandleTable::DeleteObject (  INT32  Index  )

Deletes a handle from the Handle table. The index of this handle should no longer be used (unless, of course, it is reallocated to a new handle). Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/03/94 Parameters: Index  - index of the handle object to delete from the table/ [INPUTS] Returns: TRUE if handle deleted ok; FALSE if not. Errors: Bad index handle (i.e. specified handle does not exist) See also: HandleTable::SelectObject Definition at line 701 of file metafilt.cpp. { // Sanity check if ((Index < 0) || (Index >= TableSize)) { // Out of range index if (IsUserName("Rik")) TRACE( _T("Tried to delete out of range object\n")); return FALSE; } // Try to select the object. switch (Handles[Index].Type) { case HANDLE_NONE: // No such object if (IsUserName("Rik")) TRACE( _T("Tried to delete non-existent object\n")); return FALSE; case HANDLE_PEN: case HANDLE_BRUSH: case HANDLE_PALETTE: case HANDLE_PATTERNBRUSH: case HANDLE_FONTINDIRECT: case HANDLE_REGION: Handles[Index].Type = HANDLE_NONE; break; default: ENSURE(FALSE, "Bad metafile handle type!"); ERROR(_R(IDT_BAD_METAFILE), FALSE); } // To get here we must have deleted the object ok return TRUE; }

INT32 HandleTable::FindFreeSlot (   )  [private]

Find the index of the first free slot available in the handle table. If no free handles are found, the table is expanded and the index of the first new slot is returned. If it is not possible to expand the table (out of memerory) then BAD_SLOT is returned. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/03/94 Returns: Index of first free slot in the handle table, or BAD_SLOT if there is no free slot. Errors: Out of memory. See also: HandleTable Definition at line 354 of file metafilt.cpp. { INT32 Slot; // Search the existing table for blanks for (Slot = 0; Slot < TableSize; Slot++) { if (Handles[Slot].Type == HANDLE_NONE) return Slot; } // Didn't find a free slot - get some more memory and return the first slot we get. INT32 NewTableSize = TableSize + TableGranularity; // If no slots yet, then allocate a table, otherwise expand the existing table HandleRecord *NewHandles; if (Handles == NULL) NewHandles = (HandleRecord *) CCMalloc(NewTableSize * sizeof(HandleRecord)); else NewHandles = (HandleRecord *) CCRealloc(Handles, NewTableSize * sizeof(HandleRecord)); // Did that work? if (NewHandles == NULL) { // No more memory available, but error state set by ccmalloc return BAD_SLOT; } // Initialise the new slots for (Slot = TableSize; Slot < NewTableSize; Slot++) { NewHandles[Slot].Type = HANDLE_NONE; // This bizarre syntax of 'new' allows us to call the constructor for an object // that has already been allocated. We need to do this otherwise all the // DocColour objects in the handle table are not initialised. // The constructors are not called because we just CCMalloc() the block of memory, // because we want to be able to resize the block (using CCRealloc). new(&NewHandles[Slot].Colour) DocColour; } // Remember the first slot Slot = TableSize; // Update handle table variables Handles = NewHandles; TableSize = NewTableSize; // Return the first new slot return Slot; }

BOOL HandleTable::SelectObject (  INT32  Index  )

Mimic the selection of a GDI object. This function will update the relevant status variables in the associated MetaFileFilter object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/03/94 Parameters: Index  - the index of the handle to select. [INPUTS] Returns: TRUE if the handle was selected ok; FALSE if not. Errors: Bad index handle (i.e. specified handle does not exist) See also: HandleTable::DeleteObject Definition at line 635 of file metafilt.cpp. { // Sanity check if ((Index < 0) || (Index >= TableSize)) { // Out of range index if (IsUserName("Rik")) TRACE( _T("Tried to select out of range object\n")); ERROR(_R(IDT_BAD_METAFILE), FALSE); } // Try to select the object. switch (Handles[Index].Type) { case HANDLE_NONE: // No such object if (IsUserName("Rik")) TRACE( _T("Tried to select non-existent object\n")); return FALSE; case HANDLE_PEN: Context->SetLineColour(Handles[Index].Colour); Context->SetLineWidth(Handles[Index].PenWidth); break; case HANDLE_BRUSH: Context->SetFillColour(Handles[Index].Colour); break; case HANDLE_PALETTE: break; case HANDLE_PATTERNBRUSH: break; case HANDLE_FONTINDIRECT: Context->SetLogicalFont(Handles[Index].pFont); break; case HANDLE_REGION: break; default: ENSURE(FALSE, "Bad metafile handle type!"); ERROR(_R(IDT_BAD_METAFILE), FALSE); } // To get here we must have selected the object ok return TRUE; }

---

Member Data Documentation

MetaFileFilter* HandleTable::Context [private]

Definition at line 282 of file metafilt.cpp.

HandleRecord* HandleTable::Handles [private]

Definition at line 285 of file metafilt.cpp.

INT32 HandleTable::TableSize [private]

Definition at line 288 of file metafilt.cpp.

---

The documentation for this class was generated from the following file:

• wxOil/metafilt.cpp (r1785/r1282)

---