SGDisplayPreviewFonts Class Reference

This is the base-class for the installed font items in the fonts gallery. An instance of this class should never be created, instead SGTTFItem and SGATMItem's should be used. More...

#include <sgfonts.h>

Inheritance diagram for SGDisplayPreviewFonts:

List of all members.

Public Member Functions
	SGDisplayPreviewFonts ()
	SGDisplayPreviewFonts constructor DON'T call this constructor. It ERROR3's. Call the other constructor.
	~SGDisplayPreviewFonts ()
	SGDisplayPreviewFonts destructor General memory and object tidy up - all thumbnails are vaped...
virtual BOOL	HandleEvent (SGEventType EventType, void *EventInfo, SGMiscInfo *MiscInfo)
	Handles a SuperGallery DisplayTree event.
void	DragWasReallyAClick (SGMouseInfo *Mouse, SGMiscInfo *MiscInfo)
	Handles a mouse click event. This is a callback function - drags of bitmaps from galleries will call this function back if the drag turns out to just be a click.
virtual void	GetNameText (String_256 *Result)
	Returns the name text for this item, to support simple searching and sorting operations, with redraw methods for font items. Notes:.
virtual void	GetFullInfoText (String_256 *Result)
	Returns the full-info text for this item, to support simple searching operations, and redraw methods for font items. Notes:.
virtual INT32	CompareTo (SGDisplayNode *Other, INT32 SortKey)
	Compares this node to the 'other' node, to determine their relative positions in the display tree. Returns a value which usually indicates that the other node should be inserted before (-1, or 0) or after (+1) this item.
virtual BOOL	CreateThumbnail (KernelBitmap **Bitmap)
	Creates a bitmap for this font We assume the item contains a valid logfont structure.
KernelBitmap *	GetDisplayedKernelBitmap (SGMiscInfo *MiscInfo, BOOL Background)
	To find out the KernelBitmap this object is responsible for displaying.
String_64 *	GetDisplayedTextDescription (void)
	To find the Text description for this object.
virtual void	GetKeyWords (String_256 *Result)
	To determine the keywords for this node. Generally, this is used for a simple searching mechanism.
BOOL	IsFontBeingUsed (void)
Static Public Member Functions
static LibDisplayType	GetDisplayType (SGMiscInfo *MiscInfo)
	Return the display type to use - similar to the library item ones Notes:.
static BOOL	GetThumbnailDetails (INT32 Mode, UINT32 *X, UINT32 *Y, String_256 *Text)
	Quick way of returning size and information details regarding the font preview thumbnails.
static void	DrawTypeIcon (SGRedrawInfo *RedrawInfo, SGMiscInfo *MiscInfo, DocRect *TypeRect, FontClass Type)
	Draws / Plots the 'ATM' or 'TTF' icon itself into the gallery.
Public Attributes
KernelBitmap *	FontBitmap
String_64	FontDescription
UINT32	ID
FontClass	Type
LOGFONT *	CachedLogFont
INT32	IntLeading
BOOL	Invalid
Static Public Attributes
static INT32	DMode
Protected Member Functions
virtual void	CalculateMyRect (SGFormatInfo *FormatInfo, SGMiscInfo *MiscInfo)
	Shared code for PreviewFonts items to calculate where they will appear in the grand scheme of things.
virtual void	HandleRedraw (SGRedrawInfo *RedrawInfo, SGMiscInfo *MiscInfo)
	SGDisplayPreviewFonts item redraw method - removed from the main HandleEvent method merely to make the code tidier.
virtual BOOL	DrawThumb (RenderRegion *Renderer, SGRedrawInfo *RedrawInfo, SGMiscInfo *MiscInfo, DocRect *Rectangle, BOOL Background=FALSE)
	Draws a thumbnail for the library item. This can be overridden, so the colour library for instance would plot a rectangle instead of a bitmap.
virtual void	DrawItemText (RenderRegion *Renderer, SGRedrawInfo *RedrawInfo, SGMiscInfo *MiscInfo, DocRect *Rectangle, DocRect *BmpRect, BOOL Selected)
	Plots the item text in the position as required by the GetDisplayType. Notes:.
void	MoveAfter (SGDisplayNode *NodeToMove)
	MOVES the given node (to a different position in the DisplayTree) as the previous (left) sibling of this node. If the node is not linked into a tree, it is effectively just inserted.
void	MoveBefore (SGDisplayNode *NodeToMove)
	MOVES the given node (to a different position in the DisplayTree) as the previous (left) sibling of this node. If the node is not linked into a tree, it is effectively just inserted.
BOOL	GetBubbleHelp (DocCoord *MousePos, String_256 *Result)
	Called by the parent gallery when bubble help is needed. The parent gallery will do a hit test to determine which node contains the pointer, and will then ask that node to supply bubble/status-line help.
BOOL	GetStatusLineHelp (DocCoord *MousePos, String_256 *Result)
	Called by the parent gallery when status line help is needed. The parent gallery will do a hit test to determine which node contains the pointer, and will then ask that node to supply bubble/status-line help.
Private Member Functions
	CC_DECLARE_DYNAMIC (SGDisplayPreviewFonts)

---

Detailed Description

This is the base-class for the installed font items in the fonts gallery. An instance of this class should never be created, instead SGTTFItem and SGATMItem's should be used.

Author:

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

Date:

03/02/95

See also:

FontsSGallery; SuperGallery; SGDisplayItem

Definition at line 175 of file sgfonts.h.

---

Constructor & Destructor Documentation

SGDisplayPreviewFonts::SGDisplayPreviewFonts (   )

SGDisplayPreviewFonts constructor DON'T call this constructor. It ERROR3's. Call the other constructor. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 591 of file sgfonts.cpp. { FontBitmap = NULL; FontDescription = _T(""); CachedLogFont = NULL; ID = 0; IntLeading = 0; Type = FC_UNDEFINED; Invalid = FALSE; }

SGDisplayPreviewFonts::~SGDisplayPreviewFonts (   )

SGDisplayPreviewFonts destructor General memory and object tidy up - all thumbnails are vaped... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 616 of file sgfonts.cpp. { // The FontBitmap is also referenced in the thumbnail cache, and that's where its // memory is free'd FontBitmap = NULL; FontDescription = _T(""); if(CachedLogFont != NULL) { delete CachedLogFont; CachedLogFont = NULL; } ID = 0; IntLeading = 0; }

---

Member Function Documentation

void SGDisplayPreviewFonts::CalculateMyRect (  SGFormatInfo *  FormatInfo, SGMiscInfo *  MiscInfo )  [protected, virtual]

Shared code for PreviewFonts items to calculate where they will appear in the grand scheme of things. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Parameters: FormatInfo  - The formatting info from which to calculate my position/size [INPUTS] MiscInfo - As usual, the useful misc info struct member  variable FormatRect - is returned filled in with the size/position of [OUTPUTS] this PreviewFonts item's display area. This is dependent upon the current display mode and format state FormatInfo will be updated as a result of the formatting operation Notes: Scope: private (for use of SGDisplayPreviewFonts class only) Definition at line 708 of file sgfonts.cpp. { UINT32 XSize = SG_InfiniteWidth; UINT32 YSize = SG_DefaultLargeIcon; DMode = MiscInfo->DisplayMode; // Get the relevant size details for the current mode (pixels) GetThumbnailDetails(DMode, &XSize, &YSize, NULL); INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); // Convert pixel values into millipoint measurements switch(DMode) { case 1: // Full info mode requires more text description space //XSize = SG_InfiniteWidth; XSize = (XSize * OnePixel) + (SG_DefaultNameText * 2); break; case 3: // No description requires no text description space XSize = (XSize * OnePixel) + (SGF_SURROUND * OnePixel * 2) + (SGF_TYPE_WIDTH * OnePixel); break; case 4: // Just text YSize = GridLock(MiscInfo, 18 * OnePixel); XSize = GridLock(MiscInfo, SG_DefaultNameText); CalculateFormatRect(FormatInfo, MiscInfo, XSize, YSize); return; default: // Normal and Small modes just have the font name at present XSize = (XSize * OnePixel) + (INT32)((float) SG_DefaultNameText * 1.1); break; } YSize = (YSize + (SGF_SURROUND * 2)) * OnePixel; // Snap to gridpoints XSize = GridLock(MiscInfo, XSize); YSize = GridLock(MiscInfo, YSize); CalculateFormatRect(FormatInfo, MiscInfo, XSize, YSize); }

SGDisplayPreviewFonts::CC_DECLARE_DYNAMIC (  SGDisplayPreviewFonts   )  [private]

INT32 SGDisplayPreviewFonts::CompareTo (  SGDisplayNode *  Other, INT32  SortKey )  [virtual]

Compares this node to the 'other' node, to determine their relative positions in the display tree. Returns a value which usually indicates that the other node should be inserted before (-1, or 0) or after (+1) this item. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 13/4/95 Parameters: Other  - the node to compare this node to [INPUTS] SortKey - An integer identifying how to compare the items 0 = No sorting (always returns 0) 1 = Sort-by-name 2 = Sort-by-size 3 = Sort-by-namelength 4 = Sort-by-type (ATM / TTF) Other values will return 0, unless the derived class overrides this method in order to provide other sort modes. Returns: negative (I am lesser), 0 (we are equal), or positive (I am greater) See also: SGDisplayNode::AddItem Reimplemented from SGDisplayNode. Definition at line 1285 of file sgfonts.cpp. { switch(SortKey) { case 1: // Sort by name - override default and make 'FRED' and 'fred' equal... { String_256 MyName; String_256 ItsName; GetNameText(&MyName); MyName.toLower(); Other->GetNameText(&ItsName); ItsName.toLower(); return(MyName.CompareTo(ItsName, FALSE)); } case 2: // Search by size // We could hunt for the ttf file and find it's size, maybe in future versions return 0; case 3: { String_256 MyName; String_256 ItsName; GetNameText(&MyName); Other->GetNameText(&ItsName); return (MyName.Length() - ItsName.Length()); } break; case 4: { SGDisplayPreviewFonts *OtherFont = (SGDisplayPreviewFonts *)Other; if(Type == OtherFont->Type) return 0; if(Type == FC_ATM && OtherFont->Type == FC_TRUETYPE) return -1; return 1; break; } } return (SGDisplayNode::CompareTo(Other, SortKey)); }

BOOL SGDisplayPreviewFonts::CreateThumbnail (  KernelBitmap **  Bitmap  )  [virtual]

Creates a bitmap for this font We assume the item contains a valid logfont structure. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/2/95 Parameters: -  [INPUTS] *Bitmap  contains the bitmap on exit [OUTPUTS] Returns: TRUE if the bmp was created successfully FALSE if it was not Notes: Only works with 8 and 32 bpp bmps at the mo. Reimplemented in SGTTFItem, and SGATMItem. Definition at line 1355 of file sgfonts.cpp. { ERROR3("SGDisplayPreviewFonts::CreateThumbnail should be overridden"); // we've created a thumbnail - if ok is false then it's not got much in, but it's there... return TRUE; }

void SGDisplayPreviewFonts::DragWasReallyAClick (  SGMouseInfo *  Mouse, SGMiscInfo *  MiscInfo )  [virtual]

Handles a mouse click event. This is a callback function - drags of bitmaps from galleries will call this function back if the drag turns out to just be a click. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 8/4/95 Parameters: Mouse  - The mouse info passed to the original click handler [INPUTS] MiscInfo - The misc info passed to the original click handler See also: SGDisplayPreviewFonts::HandleEvent; GalleryFontsDragInfo::OnClick Reimplemented from SGDisplayNode. Definition at line 1516 of file sgfonts.cpp. { // Just get default selection action to be applied for this click DefaultClickHandler(Mouse, MiscInfo, TRUE); }

void SGDisplayPreviewFonts::DrawItemText (  RenderRegion *  Renderer, SGRedrawInfo *  RedrawInfo, SGMiscInfo *  MiscInfo, DocRect *  Rectangle, DocRect *  BmpRect, BOOL  Selected )  [protected, virtual]

Plots the item text in the position as required by the GetDisplayType. Notes:. Parameters: Renderer  - Pointer to RenderRegion in which to plot the bitmap rect [INPUTS] RedrawInfo - Various bits of Redraw information such as colours MiscInfo - Miscellaneous info as passed to the redraw handler by the sgallery code Rectangle - Pointer to a DocRect the size and position of which the selected rectangle will use, so we need to draw our thumbnail inside this. BmpRect - Bitmap rectangle Selected - Should the text be drawn in a selected state ? [OUTPUTS]  Returns: See also: SGLibDisplayItem::HandleRedraw Definition at line 823 of file sgfonts.cpp. { LibDisplayType DType = GetDisplayType(MiscInfo); switch(DType) { case LibDisplay_SmallThumb: case LibDisplay_MediumThumb: case LibDisplay_LargeThumb: return; // No text default: break; } INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); // Work out the text rectangle and stick it here DocRect TextRect(*Rectangle); TextRect.lo.x = BmpRect->hi.x + SG_GapBeforeText; GridLockRect(MiscInfo, &TextRect); Renderer->SetLineWidth(0); Renderer->SetLineColour(RedrawInfo->Transparent); // Set up the colours for rendering our text, and fill the background if selected if (Selected) { Renderer->SetFillColour(RedrawInfo->SelBackground); DocRect SelRect(TextRect); // Text not in gallery, don't redraw if(TextRect.lo.x > Rectangle->hi.x) return; SelRect.hi.y = TextRect.lo.y + TextRect.Height()/2 - (OnePixel * 2); SelRect.lo.y = TextRect.lo.y + TextRect.Height()/2 + (OnePixel * 2); SelRect.hi.y += SG_DefaultLargeIcon/2; SelRect.lo.y -= (SG_DefaultLargeIcon/2 + OnePixel); SelRect.hi.x = TextRect.hi.x; GridLockRect(MiscInfo, &SelRect); Renderer->DrawRect(&SelRect); Renderer->SetFixedSystemTextColours(&RedrawInfo->SelForeground, &RedrawInfo->SelBackground); } else Renderer->SetFixedSystemTextColours(&RedrawInfo->Foreground, &RedrawInfo->Background); Renderer->SetFillColour(RedrawInfo->Foreground); // No point drawing the text, etc... if(TextRect.lo.x + (OnePixel * 4) > Rectangle->hi.x) return; // Work out proper text string to display and display it String_256 DisplayText; if(DMode == 1) GetFullInfoText(&DisplayText); else GetNameText(&DisplayText); // Left justified text TextRect.lo.x += (OnePixel * 4); Renderer->DrawFixedSystemText(&DisplayText, TextRect); }

BOOL SGDisplayPreviewFonts::DrawThumb (  RenderRegion *  Renderer, SGRedrawInfo *  RedrawInfo, SGMiscInfo *  MiscInfo, DocRect *  Rectangle, BOOL  Background = FALSE )  [protected, virtual]

Draws a thumbnail for the library item. This can be overridden, so the colour library for instance would plot a rectangle instead of a bitmap. Parameters: Renderer  - Pointer to RenderRegion in which to plot the bitmap rect [INPUTS] RedrawInfo - Various bits of Redraw information such as colours MiscInfo - Miscellaneous info as passed to the redraw handler by the sgallery code Rectangle - Pointer to a DocRect the size and position of which the selected rectangle will use, so we need to draw our thumbnail inside this. Background - TRUE if redrawing in backgrounding - return FALSE if not in buffer [OUTPUTS]  Returns: TRUE if things went OK, FALSE otherwise For bitmaps, drawing them at a 1:1 aspect ratio looks much better than simply squashing them into an arbitrary rectangle. Notes: See also: SGLibDisplayItem::HandleRedraw Definition at line 918 of file sgfonts.cpp. { LibDisplayType DType = GetDisplayType(MiscInfo); if(DType == LibDisplay_JustText) return TRUE; FontBitmap = GetDisplayedKernelBitmap(MiscInfo, Background); // Bitmap not there... if(FontBitmap == NULL) return FALSE; if(FontBitmap->ActualBitmap == NULL) return FALSE; DMode = MiscInfo->DisplayMode; // FontsSGallery *FSGallery = FontsSGallery::ThisGallery; DocRect BmpRect(*Rectangle); INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); UINT32 XSize = 0; UINT32 YSize = 0; Renderer->SetLineWidth(0); DocColour trans(COLOUR_TRANS); Renderer->SetLineColour(trans); BOOL ThumbnailOK = TRUE; BitmapInfo Info; BOOL InfoOK = FontBitmap->ActualBitmap->GetInfo( &Info ); if(InfoOK) { // Get the details for the bitmap XSize = (UINT32)Info.PixelWidth; YSize = (UINT32)Info.PixelHeight; ThumbnailOK = TRUE; } else { // Get the default details for this mode GetThumbnailDetails(DMode, &XSize, &YSize, NULL); ThumbnailOK = FALSE; } XSize *= OnePixel; // YSize *= OnePixel; // Thumbnail rectangle... space around edges but don't scale thumbnail BmpRect.lo.x += (3 * OnePixel); BmpRect.hi.x = BmpRect.lo.x + XSize ; BmpRect.Inflate(0, -(3 * OnePixel)); GridLockRect(MiscInfo, &BmpRect); // Ensure it maps exactly to specific pixels NodeBitmap* DummyBmp = NULL; if(Invalid) return FALSE; if(ThumbnailOK) { // Setup the bitmap ready for plotting DummyBmp = new NodeBitmap(); if (DummyBmp == NULL) { ThumbnailOK = FALSE; } else { // Need to clip to MyRect.hi.x at some point; DummyBmp->SetUpPath(); DummyBmp->CreateShape(BmpRect); DummyBmp->GetBitmapRef()->SetBitmap(FontBitmap); // Now render the bitmap DummyBmp->Render(Renderer); // Unscaled version - problems with win32s // Renderer->DrawBitmap(IconRect.LowCorner(), FontBitmap); delete DummyBmp; } } // This could happen in the last block. Basically, we haven't got a bitmap, or had // problems creating one... if(!ThumbnailOK) { // NULL bitmap, just draw rectangle DocColour NullBitmapColour(230L, 230L, 230L); // Draw the 'blank' bitmap Renderer->SetFillColour(NullBitmapColour); // RedrawInfo->Background//); GridLockRect(MiscInfo, &BmpRect); // Ensure we're on a pixel Renderer->DrawRect(&BmpRect); } // Drawn bitmap preview ok return TRUE; }

void SGDisplayPreviewFonts::DrawTypeIcon (  SGRedrawInfo *  RedrawInfo, SGMiscInfo *  MiscInfo, DocRect *  TypeRect, FontClass  Type )  [static]

Draws / Plots the 'ATM' or 'TTF' icon itself into the gallery. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 9/10/95 Parameters: RedrawInfo  - The information on the kernel-rendered redraw area [INPUTS] FormatInfo - The formatting information structure TypeRect - A small rectangle to the left of the main display item Type - The FontClass for the item Definition at line 1182 of file sgfonts.cpp. { INT32 BitmapID = 0; // Work out the bmp ID, if not known, simply return... if(Type == FC_ATM) BitmapID = _R(IDB_ATM_SYMBOL); else if(Type == FC_TRUETYPE) BitmapID = _R(IDB_TTF_SYMBOL); else return; DocRect GlyphRect(*TypeRect); INT32 OnePixel = (INT32) MiscInfo->PixelSize; INT32 Centre = GlyphRect.lo.y + ((GlyphRect.hi.y - GlyphRect.lo.y) / 2); GlyphRect.lo.y = Centre - ((SGF_TYPE_WIDTH / 2) * OnePixel); GlyphRect.hi.y = Centre + (((SGF_TYPE_WIDTH / 2) + 1) * OnePixel); // Always round up... // Bodge so 'text only' mode has space to left of icon... LibDisplayType DType = SGDisplayPreviewFonts::GetDisplayType(MiscInfo); if(DType == LibDisplay_JustText) GlyphRect.lo.x += (6 * OnePixel); RedrawInfo->Renderer->DrawBitmap(GlyphRect.lo, BitmapID); }

BOOL SGDisplayPreviewFonts::GetBubbleHelp (  DocCoord *  MousePos, String_256 *  Result )  [protected, virtual]

Called by the parent gallery when bubble help is needed. The parent gallery will do a hit test to determine which node contains the pointer, and will then ask that node to supply bubble/status-line help. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 25/4/95 Parameters: MousePos  - The current mouse position. This will generally be expected [INPUTS] to lie inside this item's FormatRect. With it, this item can provide help on specific areas of an item. On  exit, if the return value is TRUE, the string pointed at by Result [OUTPUTS] will contain a bubble help string for this item Returns: TRUE if it filled in the string, FALSE if it did not Notes: The base class returns FALSE (i.e. provides no help) If you can provide help, then override the base class method to do so. See also: SGDisplayNode::GetStatusLineHelp Reimplemented from SGDisplayNode. Definition at line 1719 of file sgfonts.cpp. { ERROR3IF(MousePos == NULL || Result == NULL, "Invalid NULL params"); *Result = *GetDisplayedTextDescription(); return(TRUE); }

KernelBitmap * SGDisplayPreviewFonts::GetDisplayedKernelBitmap (  SGMiscInfo *  MiscInfo, BOOL  Background )

To find out the KernelBitmap this object is responsible for displaying. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 22/04/95 Parameters: MiscInfo  - misc info given to the gallery redraw code [INPUTS] Background - if false then redrawing in foreground - only return bmp if in cache [OUTPUTS]  Returns: A pointer to the KernelBitmap which this Display Item is used to display, or NULL if there is no thumbnail (e.g. a colour library has no thumbs), or the thumbnail failed to load/cache Definition at line 654 of file sgfonts.cpp. { // Invalid font - don't display thumbnail, or allow it to be dragged... if(Invalid) return NULL; LibDisplayType DType = GetDisplayType(MiscInfo); if(DType == LibDisplay_JustText) return NULL; FontsSGallery *FSGallery = FontsSGallery::ThisGallery; ERROR3IF(FSGallery == NULL, "SGDisplayPreviewFonts::GetDisplayedKernelBitmap, FontsSGallery::ThisGallery is NULL"); // We haven't got the bmp from the cache yet FontBitmap = NULL; if(FSGallery->InsCache != NULL) { // Depending on 'Background' return the thumbnail from the cache (or generate a new one and add // it to the cache) or return NULL if we're in a hurry... FSGallery->InsCache->SetSize((SGThumbSize)MiscInfo->DisplayMode); if(!FSGallery->InsCache->GetThumbnail(ID, Background, &FontBitmap, NULL, (LP_SGTHUMBS_MOREINFO)this)) FontBitmap = NULL; } return FontBitmap; }

String_64 * SGDisplayPreviewFonts::GetDisplayedTextDescription (  void   )  [inline]

To find the Text description for this object. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> (Based on template code by Jason) Date: 03/02/95 Returns: A pointer to the Description string which this Display Item uses. Definition at line 331 of file sgfonts.h. { return(&FontDescription); }

LibDisplayType SGDisplayPreviewFonts::GetDisplayType (  SGMiscInfo *  MiscInfo  )  [static]

Return the display type to use - similar to the library item ones Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 15/5/95 Parameters: MiscInfo  - Contains a few useful bits of info that may be [INPUTS] needed for all event types. [OUTPUTS]  Returns: The display mode type to use (position of text, and size of thumb) See also: Definition at line 774 of file sgfonts.cpp. { switch(MiscInfo->DisplayMode) { case 4: return LibDisplay_JustText; break; case 3: return LibDisplay_MediumThumb; break; case 2: return LibDisplay_SmallThumbText; break; case 1: // return LibDisplay_FullInfo; return LibDisplay_SingleLineFullInfo; break; case 0: default: return LibDisplay_LargeThumbText; break; } return LibDisplay_LargeThumbTextUnder; }

void SGDisplayPreviewFonts::GetFullInfoText (  String_256 *  Result  )  [virtual]

Returns the full-info text for this item, to support simple searching operations, and redraw methods for font items. Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/3/95 Parameters: [INPUTS]  Result  - String to place resulting text in [OUTPUTS] Returns: The display mode type to use (position of text, and size of thumb) See also: Reimplemented from SGDisplayNode. Reimplemented in SGTTFItem, and SGATMItem. Definition at line 1250 of file sgfonts.cpp. { ERROR3IF(Result == NULL, "SGDisplayPreviewFonts::GetFullInfoText given null ptr"); // This is usually overridden to give better descriptions... *Result = (String_256)FontDescription; }

void SGDisplayPreviewFonts::GetKeyWords (  String_256 *  Result  )  [virtual]

To determine the keywords for this node. Generally, this is used for a simple searching mechanism. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 30/3/95 Parameters: On  exit, the string pointed at by Result will contain either a blank [OUTPUTS] string, or a list of | seperated keywords associated with the item Notes: The base class returns a blank string. If you can provide a better name string, then override the base class method to do so. See also: SGDisplayNode::GetFullInfoText Reimplemented from SGDisplayNode. Definition at line 1603 of file sgfonts.cpp. { ERROR3IF(Result == NULL, "SGDisplayPreviewFonts::GetKeywords given a NULL param"); if(Result == NULL) return; // We don't support keyword searching on the installed fonts ! *Result = ""; }

void SGDisplayPreviewFonts::GetNameText (  String_256 *  Result  )  [virtual]

Returns the name text for this item, to support simple searching and sorting operations, with redraw methods for font items. Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 13/4/95 Parameters: [INPUTS]  Result  - String to place resulting text in [OUTPUTS] Returns: See also: Reimplemented from SGDisplayNode. Definition at line 1225 of file sgfonts.cpp. { ERROR3IF(Result == NULL, "SGDisplayPreviewFonts::GetNameText given null ptr"); *Result = (String_256)FontDescription; }

BOOL SGDisplayPreviewFonts::GetStatusLineHelp (  DocCoord *  MousePos, String_256 *  Result )  [protected, virtual]

Called by the parent gallery when status line help is needed. The parent gallery will do a hit test to determine which node contains the pointer, and will then ask that node to supply bubble/status-line help. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 25/4/95 Parameters: MousePos  - The current mouse position. This will generally be expected [INPUTS] to lie inside this item's FormatRect. With it, this item can provide help on specific areas of an item. On  exit, if the return value is TRUE, the string pointed at by Result [OUTPUTS] will contain a status line help string for this item Returns: TRUE if it filled in the string, FALSE if it did not Notes: The base class returns FALSE (i.e. provides no help) If you can provide help, then override the base class method to do so. See also: SGDisplayNode::GetBubbleHelp Reimplemented from SGDisplayNode. Definition at line 1757 of file sgfonts.cpp. { ERROR3IF(MousePos == NULL || Result == NULL, "Invalid NULL params"); // "'<FontName>'; Click, then use the Deinstall button to remove font" Result->MakeMsg(_R(IDS_FONTS_INSTALLED_STATUS), ((TCHAR *)(*GetDisplayedTextDescription()))); return(TRUE); }

BOOL SGDisplayPreviewFonts::GetThumbnailDetails (  INT32  Mode, UINT32 *  X, UINT32 *  Y, String_256 *  Text )  [static]

Quick way of returning size and information details regarding the font preview thumbnails. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 16/2/95 Parameters: Mode  - Mode of display (Small, medium, large -> 0-2) [INPUTS] X - Location for return of X size (pixels) Y - Location for return of Y size (pixels) Text - Pointer to font name (used in full info mode) Returns: Text - Text to use as for thumbnail Parameters: Returns  TRUE if things went OK. [OUTPUTS] Definition at line 1539 of file sgfonts.cpp. { if(X == NULL || Y == NULL) return FALSE; switch(Mode) { case 0: // Large (Normal) *X = SGF_NORMAL_X; *Y = SGF_NORMAL_Y; if(Text != NULL) *Text = _R(IDS_LARGEFONTDISPLAYSTRING); break; case 1: // Full info *X = SGF_FULL_X; *Y = SGF_FULL_Y; // Text inserted beforehand //if(Text != NULL) *Text = _R(IDS_FONTS_GALLERY_LARGE_TEXT); break; case 2: // Small (with description) *X = SGF_SMALL_X; *Y = SGF_SMALL_Y; if(Text != NULL) *Text = _R(IDS_FONTS_GALLERY_SMALL_TEXT); break; case 3: // Small (with no description) *X = SGF_FULL_X; *Y = SGF_FULL_Y; //if(Text != NULL) *Text = _R(IDS_FONTS_GALLERY_SMALL_TEXT); break; case 4: // No icon mode... *X = 0; *Y = 0; break; } return TRUE; }

BOOL SGDisplayPreviewFonts::HandleEvent (  SGEventType  EventType, void *  EventInfo, SGMiscInfo *  MiscInfo )  [virtual]

Handles a SuperGallery DisplayTree event. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Parameters: EventType  - An enumerated value describing what type of event is to be processed [INPUTS] EventInfo - A structure describing the event (may be NULL). The exact thing pointed at by this pointer depends upon the event type: MonoOn Event Thing EventInfo points at SGEVENT_FORMAT (SGFormatInfo *) SGEVENT_REDRAW (SGRedrawInfo *) SGEVENT_MOUSECLICK (SGMouseInfo *) MonoOff Use the provided SGDisplayNode::Get[Format]Info() inlines to retrieve this information - they provide useful error/type checking, and hide the cast MiscInfo - always provided. Contains a few useful bits of info that may be needed for all event types. Parameters: FormatInfo  is updated as appropriate [OUTPUTS] Returns: TRUE if the event was handled successfully FALSE if it was not Notes: This overrides the pure virtual SGDisplayNode::HandleEvent method A node need not handle a specific event - if it does not handle it, it should return FALSE. Redraw and Formatting handlers should never return TRUE, as this will prevent the event from continuing through the tree. Non-leaf-nodes must call SGDisplayNode::GiveEventToMyChildren in order to pass the event dow the tree. THIS node is a leaf-node, so it doesn't. See also: SGDisplayNode::HandleEvent Reimplemented from SGDisplayItem. Definition at line 1411 of file sgfonts.cpp. { switch (EventType) { case SGEVENT_FORMAT: { SGFormatInfo *FormatInfo = GetFormatInfo(EventType, EventInfo); CalculateMyRect(FormatInfo, MiscInfo); // Cache our FormatRect for later use } break; case SGEVENT_REDRAW: { DocRect MyRect(FormatRect); // Rely on FormatRect being cached from above SGRedrawInfo *RedrawInfo = GetRedrawInfo(EventType, EventInfo); RedrawInfo->Renderer->SaveContext(); if (IMustRedraw(RedrawInfo)) // only redraw if we intersect the clip rect HandleRedraw(RedrawInfo, MiscInfo); RedrawInfo->Renderer->RestoreContext(); } break; // exit and return FALSE to pass the redraw event on case SGEVENT_MOUSECLICK: { SGMouseInfo *Mouse = GetMouseInfo(EventType, EventInfo); if (FormatRect.ContainsCoord(Mouse->Position)) { if(Mouse->DoubleClick) DefaultClickHandler(Mouse, MiscInfo); else { DefaultPreDragHandler(Mouse, MiscInfo); // Grab a copy of the bitmap required for dragging GalleryFontsDragInfo *DragFont; KernelBitmap *DispBmp = GetDisplayedKernelBitmap(MiscInfo, TRUE); if(DispBmp) { LibraryGallery::TmpDraggingBitmap = DIBUtil::CopyKernelBitmap(DispBmp, TRUE); DragFont = new GalleryFontsDragInfo(this, Mouse, MiscInfo, Mouse->MenuClick, 0, 0); } else { // Null rectangle - give a specific size LibraryGallery::TmpDraggingBitmap = NULL; // Get the relevant size details for the current mode (pixels) UINT32 XSize = SG_InfiniteWidth; UINT32 YSize = SG_DefaultLargeIcon; INT32 DisplayMode = MiscInfo->DisplayMode; SGDisplayPreviewFonts::GetThumbnailDetails(DisplayMode, &XSize, &YSize, NULL); if(XSize == 0 || YSize == 0) { XSize = SGF_SMALL_X; YSize = SGF_SMALL_Y; } // Create the drag object... DragFont = new GalleryFontsDragInfo(this, Mouse, MiscInfo, Mouse->MenuClick, XSize, YSize); } if (DragFont != NULL) DragManagerOp::StartDrag(DragFont, GetListWindow()); } return(TRUE); // Claim this event - nobody else can own this click } } break; default: return SGDisplayItem::HandleEvent(EventType, EventInfo, MiscInfo); } // Default return value: We do not claim this event, so it will be passed on to others return FALSE; }

void SGDisplayPreviewFonts::HandleRedraw (  SGRedrawInfo *  RedrawInfo, SGMiscInfo *  MiscInfo )  [protected, virtual]

SGDisplayPreviewFonts item redraw method - removed from the main HandleEvent method merely to make the code tidier. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Parameters: RedrawInfo  - The information on the kernel-rendered redraw area [INPUTS] FormatInfo - The formatting information structure member variable FormatRect should be set up (before calling this method) to be the rectangle in which to draw this item If the item has a null preview bitmap, but all the info required to generate a bitmap, then we go ahead and generate the bitmap ourselves and cache it with the item. Scope: private Definition at line 1051 of file sgfonts.cpp. { // First, inform the system that we are about to start rendering this item StartRendering(RedrawInfo, MiscInfo); RenderRegion *Renderer = RedrawInfo->Renderer; INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); Renderer->SetLineWidth(0); Renderer->SetLineColour(RedrawInfo->Transparent); LibDisplayType DType = GetDisplayType(MiscInfo); // Exclude the 'TTF' / 'ATM' bmp space from the Format Rect, so as not to confuse things DocRect NewFormatRect(FormatRect); // Space for icon NewFormatRect.lo.x += (SGF_TYPE_WIDTH * OnePixel); GridLockRect(MiscInfo, &NewFormatRect); DocRect TypeRect(FormatRect); TypeRect.hi.x = NewFormatRect.lo.x; DrawTypeIcon(RedrawInfo, MiscInfo, &TypeRect, Type); // Use NewFormatRect from here on... DocRect BmpRect(NewFormatRect); DocRect UnscaledRect(NewFormatRect); if(DType == LibDisplay_JustText) { // No bitmap, so don't reserve much space for it... BmpRect.hi.x = BmpRect.lo.x + OnePixel; } else { UINT32 XSize = 0; UINT32 YSize = 0; DMode = MiscInfo->DisplayMode; // Get the relevant size details for the current mode (pixels) GetThumbnailDetails(DMode, &XSize, &YSize, NULL); // Convert pixels to millipoints XSize *= OnePixel; // Thumbnail rectangle... space around edges but don't scale thumbnail BmpRect.hi.x = BmpRect.lo.x + XSize + (6 * OnePixel); // Space for selection rectangle BmpRect.Inflate(-(OnePixel * 3)); // Ensure it maps exactly to specific pixels GridLockRect(MiscInfo, &BmpRect); // Draw bmp outline it if selected if (Flags.Selected) { if(BmpRect.hi.x > UnscaledRect.hi.x) BmpRect.hi.x = UnscaledRect.hi.x; BmpRect.Inflate(OnePixel * 3); GridLockRect(MiscInfo, &BmpRect); // Ensure we're on a pixel DrawSelectionOutline(RedrawInfo, MiscInfo, &BmpRect); BmpRect.Inflate(-(OnePixel * 3)); } // Not drawn a bitmap yet BOOL DrawnBitmap = FALSE; // The thumbnail drawing section... if(Library::BackgroundRedraw && DType != LibDisplay_JustText) { // Try to draw the thumb from cache. If it's not available in the cache, then // we'll register for background redraw and draw the blank box. Note that // ShouldIDraw... will also force us to always draw the thumb for selected items etc DrawnBitmap = DrawThumb(Renderer, RedrawInfo, MiscInfo, &UnscaledRect, FALSE); if (ShouldIDrawForeground(DrawnBitmap)) { if (!DrawnBitmap) { // We failed to draw anything before, so we must try again, forcing the thumb to // be cached if it is necessary - if this fails we draw a crossed box if (!DrawThumb(Renderer, RedrawInfo, MiscInfo, &UnscaledRect, TRUE)) SGLibDisplayItem::DrawNullBitmapRect(Renderer, MiscInfo, &BmpRect, FALSE); } } else { if (!DrawnBitmap) { // We should background render, so we just draw a blank grey box SGLibDisplayItem::DrawNullBitmapRect(Renderer, MiscInfo, &BmpRect, TRUE); } } } else { // We're not doing this background stuff... Force a thumbnail to be drawn right this second ! if (!DrawThumb(Renderer, RedrawInfo, MiscInfo, &UnscaledRect, TRUE)) SGLibDisplayItem::DrawNullBitmapRect(Renderer, MiscInfo, &BmpRect, FALSE); } } // Draw the text DrawItemText(Renderer, RedrawInfo, MiscInfo, &UnscaledRect, &BmpRect, Flags.Selected); // Finally, inform the system that we have completed rendering this item StopRendering(RedrawInfo, MiscInfo); }

BOOL SGDisplayPreviewFonts::IsFontBeingUsed (  void   )

void SGDisplayPreviewFonts::MoveAfter (  SGDisplayNode *  NodeToMove  )  [protected, virtual]

MOVES the given node (to a different position in the DisplayTree) as the previous (left) sibling of this node. If the node is not linked into a tree, it is effectively just inserted. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 25/3/95 Parameters: NodeToMove  - the node to move [INPUTS] Notes: This base class method simply delinks the item and relinks it elsewhere in the display tree. However, derived classes will override this method so that moving display items can have a further effect of also rearranging the displayed "real" items. Before/After moving the real item, the derived class can then call this baseclass method to complete the action. Take care when moving items between groups (e.g. if an item is "moved" from one docuemnt to another, it could be a bad thing, so be very careful in derived classes to take appropriate action) Any attempt to move an item after *itself* is quietly ignored Returns: Errors: ERROR3 and quiet exit if NodeToMove == NULL See also: SuperGallery; SGDisplayColour::InsertAfter; SGDisplayColour::AddItem Reimplemented from SGDisplayNode. Definition at line 1647 of file sgfonts.cpp. { SGDisplayNode::MoveAfter(NodeToMove); }

void SGDisplayPreviewFonts::MoveBefore (  SGDisplayNode *  NodeToMove  )  [protected, virtual]

MOVES the given node (to a different position in the DisplayTree) as the previous (left) sibling of this node. If the node is not linked into a tree, it is effectively just inserted. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/3/95 Parameters: NodeToMove  - the node to move [INPUTS] Notes: This base class method simply delinks the item and relinks it elsewhere in the display tree. However, derived classes will override this method so that moving display items can have a further effect of also rearranging the displayed "real" items. Before/After moving the real item, the derived class can then call this baseclass method to complete the action. Take care when moving items between groups (e.g. if an item is "moved" from one docuemnt to another, it could be a bad thing, so be very careful in derived classes to take appropriate action) Any attempt to move an item before *itself* is queitly ignored Returns: Errors: ERROR3 and quiet exit if NodeToMove == NULL See also: SuperGallery; SGDisplayColour::InsertBefore; SGDisplayColour::AddItem Reimplemented from SGDisplayNode. Definition at line 1685 of file sgfonts.cpp. { SGDisplayNode::MoveBefore(NodeToMove); }

---

Member Data Documentation

LOGFONT* SGDisplayPreviewFonts::CachedLogFont

Definition at line 257 of file sgfonts.h.

INT32 SGDisplayPreviewFonts::DMode [static]

Definition at line 251 of file sgfonts.h.

KernelBitmap* SGDisplayPreviewFonts::FontBitmap

Definition at line 242 of file sgfonts.h.

String_64 SGDisplayPreviewFonts::FontDescription

Definition at line 243 of file sgfonts.h.

UINT32 SGDisplayPreviewFonts::ID

Definition at line 248 of file sgfonts.h.

INT32 SGDisplayPreviewFonts::IntLeading

Definition at line 258 of file sgfonts.h.

BOOL SGDisplayPreviewFonts::Invalid

Definition at line 261 of file sgfonts.h.

FontClass SGDisplayPreviewFonts::Type

Definition at line 254 of file sgfonts.h.

---

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

• wxOil/sgfonts.h (r1785/r1282)
• wxOil/sgfonts.cpp (r1785/r1282)

---