SGLibDisplayItem Class Reference

#include <sglib.h>

Inheritance diagram for SGLibDisplayItem:

List of all members.

Public Member Functions
	SGLibDisplayItem ()
	SGLibDisplayItem constructor DON'T call this constructor. It ERROR3's. Call the other constructor.
	SGLibDisplayItem (LibraryIndex LibraryIndexToDisplay, BOOL bIsNew=FALSE)
	SGLibDisplayItem constructor.
	~SGLibDisplayItem ()
	SGLibDisplayItem destructor.
virtual 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.
LibraryIndex	GetDisplayedLibraryIndex (void)
	To find out the LibraryIndex this object is responsible for displaying.
BOOL	GetThumbSize (SGMiscInfo *MiscInfo, DocRect *Rectangle, KernelBitmap *Bitmap, INT32 *XSize, INT32 *YSize, double *Scale=NULL, INT32 *XTrans=NULL, INT32 *YTrans=NULL, BOOL *Outline=NULL)
	Returns the size of thumbnail to render. For thumbnails, drawing them at a 1:1 aspect ratio looks much better than simply squashing them into an arbitrary rectangle. This code handles that...
Library *	GetParentLibrary (void)
	Finds the library for which this DisplayItem displays an item.
virtual void	GetFileName (String_256 *Result)
	Returns the filename (without path) for the given item This is needed by the searching code.
virtual BOOL	GetThumbFileName (String_256 *path)
	To find the corresponding filename for this object's thumb.
virtual BOOL	ShouldDownloadThumb ()
	Used to decide whether or not to (re)start a thumbnail download.
virtual BOOL	DownloadThumbnail ()
	Starts to download the item's thumbnail.
virtual void	OnThumbDownloadComplete ()
	Should be called when the thumbnail download is over - it will force a redraw among other things.
virtual void	OnThumbDownloadProgress (const INT32 nPercentageCompleted)
	Called on thumbnail download progress - it will update the thumbnail's placeholder. NB: the background is not erased to prevent flickering.
virtual BOOL	ShouldIDrawForeground (BOOL ForceForeground)
	overrides the base class version to force foreground mode if the item is downloading its thumbnail. This is necessary to avoid flickering.
BOOL	IsDownloadingThumb ()
virtual BOOL	GetFileNamePtr (TCHAR **Result)
	Returns the filename (without path) for the given item This is needed by the searching code.
virtual void	GetNameText (String_256 *Result)
	Returns the name text for this item, to support simple searching and sorting operations, and generic redraw methods for library items.
virtual BOOL	GetNameTextPtr (TCHAR **Result)
	Returns a pointer to the filename for this item... The main use of this call is to speed sorting up, since passing pointers about is much quicker than constructing strings....
virtual BOOL	GetDisplayedTextDescription (String_256 *Result)
	To find the Text description for this object.
virtual BOOL	GetDisplayedTextDescription (TCHAR **Result)
	To find the Text description for this object.
virtual BOOL	GetActualDisplayedText (String_256 *String, INT32 Line=0)
	Returns the mode-sensitive string that will actually be displayed. This is handy for sorting methods, etc...
virtual BOOL	GetActualDisplayedTextPtr (TCHAR **String, INT32 Line=0)
	Returns the mode-sensitive string ptr that will actually be displayed. This is handy for sorting methods, etc...
BOOL	GetFileName (PathName *Result)
	To find the corresponding filename for this object.
KernelBitmap *	GetDisplayedKernelBitmap (SGMiscInfo *MiscInfo, BOOL Background=FALSE)
	To find out the KernelBitmap this object is responsible for displaying.
INT32	GetFileSize (Library *Lib=NULL)
	To determine the keywords for this node. Generally, this is used for a simple searching mechanism.
virtual 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.
virtual 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.
Static Public Member Functions
static void	DrawNullBitmapRect (RenderRegion *Renderer, SGMiscInfo *MiscInfo, DocRect *Rectangle, BOOL Background)
	Draws a rectangle with two lines crossing it, to signify that the thumbnail could not be found, or could not be generated.
Protected Member Functions
virtual BOOL	HandleEvent (SGEventType EventType, void *EventInfo, SGMiscInfo *MiscInfo)
	Handles a SuperGallery DisplayTree event.
virtual BOOL	StartDrag (SGEventType EventType, void *EventInfo, SGMiscInfo *MiscInfo, INT32 *XSize, INT32 *YSize)
	Sets the TmpDraggingBitmap up, and returns the sizes to the caller.
virtual INT32	GetTextWidth (SGFormatInfo *FormatInfo, SGMiscInfo *MiscInfo)
	An overridable way of returning the width of the text description.
virtual void	CalculateMyRect (SGFormatInfo *FormatInfo, SGMiscInfo *MiscInfo)
	Shared code for LibraryIndex items to calculate where they will appear in the grand scheme of things.
virtual void	HandleRedraw (SGRedrawInfo *RedrawInfo, SGMiscInfo *MiscInfo)
	SGLibDisplayItem item redraw method - removed from the main HandleEvent method merely to make the code tidier. Notes: Scope: private.
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:.
virtual void	DrawPlaceholder (RenderRegion *Renderer, SGMiscInfo *MiscInfo, DocRect *Rectangle, BOOL Background)
	Draws a thumbnail placeholder if the actual thumbnail is not available. If the thumb is downloading, it displays the percentage downloaded so far.
virtual void	DrawItemThumbnail (SGRedrawInfo *pRedrawInfo, SGMiscInfo *pMiscInfo, DocRect *pRect)
	draws the item's thumbnail Scope: protected
virtual LibDisplayType	GetDisplayType (SGMiscInfo *MiscInfo)
	Return the display type to use - this should be overridden by the library gallery using the code.
virtual void	GetFullInfoText (String_256 *Result)
	Returns the full-info text for this item, to support simple searching operations, and generic redraw methods for library items. Notes: This overrides the sgdisplaynode version to give full information...
virtual void	GetFullInfoText (String_256 *Result, INT32 Line=0)
	Returns the full-info text for this item, to support simple searching operations, and generic redraw methods for library items. Notes:.
virtual void	GetKeyWords (String_256 *Result)
	To determine the keywords for this node. Generally, this is used for a simple searching mechanism.
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.
Protected Attributes
BOOL	bIsDownloadingThumb
INT32	nPercentageDownloaded
BOOL	bIsNew
OpThumbDownload *	pDownloadOp
LibraryIndex	TheLibraryIndex
Private Member Functions
	CC_DECLARE_DYNAMIC (SGLibDisplayItem)
Friends
class	OpThumbDownload

---

Detailed Description

Definition at line 149 of file sglib.h.

---

Constructor & Destructor Documentation

SGLibDisplayItem::SGLibDisplayItem (   )

SGLibDisplayItem constructor DON'T call this constructor. It ERROR3's. Call the other constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Definition at line 166 of file sglib.cpp. { ERROR3("Illegal call on default SGLibDisplayItem constructor - call the other one!"); TheLibraryIndex = NULL; }

SGLibDisplayItem::SGLibDisplayItem (  LibraryIndex  LibraryIndexToDisplay, BOOL  bNew = FALSE )

SGLibDisplayItem constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Parameters: LibraryIndexToDisplay  - A LibraryIndex indicating which library item [INPUTS] this DisplayItem is displaying Definition at line 189 of file sglib.cpp. { TheLibraryIndex = LibraryIndexToDisplay; bIsDownloadingThumb = FALSE; pDownloadOp = NULL; nPercentageDownloaded = 0; bIsNew = bNew; }

SGLibDisplayItem::~SGLibDisplayItem (   )

SGLibDisplayItem destructor. Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/97 Definition at line 210 of file sglib.cpp. { if (IsDownloadingThumb() && pDownloadOp) pDownloadOp->Abort(); }

---

Member Function Documentation

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

Shared code for LibraryIndex items to calculate where they will appear in the grand scheme of things. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/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 LibraryIndex 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: LibraryIndexs supply only one display mode ("full info") Scope: private (for use of SGLibDisplayItem class only) Reimplemented in SGLibFontItem. Definition at line 310 of file sglib.cpp. { INT32 XSize = SG_InfiniteWidth; INT32 YSize = SG_DefaultLargeIcon; INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); Library *ParentLib = GetParentLibrary(); // If we're displaying text underneath the thumbnail, add some space for it LibDisplayType DType = GetDisplayType(MiscInfo); // Get width of text XSize = GetTextWidth(FormatInfo, MiscInfo); // Extra space required by the text switch(DType) { case LibDisplay_SmallThumbTextUnder: case LibDisplay_MediumThumbTextUnder: case LibDisplay_LargeThumbTextUnder: // Text is underneath YSize = SG_GapAboveText + SG_SPACE_UNDER; break; default: // Text is to the right YSize = 0; break; } // Lock the current sizes to the grid YSize = GridLock(MiscInfo, YSize); // Extra Space required if selected YSize += (3 * 2 * OnePixel); // Add in space required by the bitmap itself switch(DType) { case LibDisplay_SmallThumbTextUnder: case LibDisplay_SmallThumbText: case LibDisplay_SmallThumb: YSize += GridLock(MiscInfo, ParentLib->PreviewBMPHeight(SGThumb_Small) * OnePixel); XSize += GridLock(MiscInfo, ParentLib->PreviewBMPWidth(SGThumb_Small) * OnePixel); break; case LibDisplay_LargeThumbTextUnder: case LibDisplay_Default: case LibDisplay_LargeThumbText: case LibDisplay_LargeThumb: YSize += GridLock(MiscInfo, ParentLib->PreviewBMPHeight(SGThumb_Large) * OnePixel); XSize += GridLock(MiscInfo, ParentLib->PreviewBMPWidth(SGThumb_Large) * OnePixel); break; case LibDisplay_MediumThumbTextUnder: case LibDisplay_MediumThumbText: case LibDisplay_MediumThumb: YSize += GridLock(MiscInfo, ParentLib->PreviewBMPHeight(SGThumb_Medium) * OnePixel); XSize += GridLock(MiscInfo, ParentLib->PreviewBMPWidth(SGThumb_Medium) * OnePixel); break; case LibDisplay_FullInfo: case LibDisplay_SingleLineFullInfo: YSize += GridLock(MiscInfo, ParentLib->PreviewBMPHeight(SGThumb_Medium) * OnePixel); XSize += GridLock(MiscInfo, ParentLib->PreviewBMPWidth(SGThumb_Medium) * OnePixel); //XSize = SG_InfiniteWidth; break; case LibDisplay_JustText: // No description requires no text description space YSize = GridLock(MiscInfo, 18 * OnePixel); XSize = GridLock(MiscInfo, SG_DefaultNameText); break; } // Calculate a proper rectangle for the item CalculateFormatRect(FormatInfo, MiscInfo, XSize, YSize); }

SGLibDisplayItem::CC_DECLARE_DYNAMIC (  SGLibDisplayItem   )  [private]

INT32 SGLibDisplayItem::CompareTo (  SGDisplayNode *  Other, INT32  SortKey )  [protected, 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 (memory size) 3 = sort by name length 4 = sort by type 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. Reimplemented in SGLibFontItem. Definition at line 2224 of file sglib.cpp. { switch(SortKey) { case 1: // Sort by name - override default and make 'FRED' and 'fred' equal... // Note - we should really make "'Fred'" and "Fred'" equal, since full info sorting // can be a bit rampant if you don't know what's going on... { BOOL FoundPtr = FALSE; #ifndef _BATCHING // Normal, quick alphabetic sorting TCHAR *pOurName = NULL; TCHAR *pTheirName = NULL; FoundPtr = GetActualDisplayedTextPtr(&pOurName); if(FoundPtr) { FoundPtr = ((SGLibDisplayItem *)Other)->GetActualDisplayedTextPtr(&pTheirName); if(FoundPtr) { // Two TCHAR *'s... INT32 Value = 0; // This little beastie (below) is the DBCS string comparison flob which we should // be using for the Jap's, and so forth... // 1 if pOurName < pTheirName // 2 if pOutName == pTheirName // 3 if pOutName > pTheirName Value = CompareString(LOCALE_USER_DEFAULT, (NORM_IGNORECASE | NORM_IGNOREKANATYPE | NORM_IGNOREWIDTH), pOurName, -1, pTheirName, -1); // 1.42 Value -= 2; return (Value); } } // Fields not found, or index file not cached in memory String_256 MyName; String_256 ItsName; GetActualDisplayedText(&MyName); MyName.toLower(); ((SGLibDisplayItem *)Other)->GetActualDisplayedText(&ItsName); ItsName.toLower(); return(MyName.CompareTo(ItsName)); #else // Not so quick, special alphabetic sorting (fred20 > fred10 > fred5 > fred) String_256 MyName; String_256 ItsName; GetActualDisplayedText(&MyName); MyName.toLower(); ((SGLibDisplayItem *)Other)->GetActualDisplayedText(&ItsName); ItsName.toLower(); if(Library::MaxFieldCacheEntries == 50 && MyName == ItsName) { ERROR3_PF(("Identical sort entries found: '%s'", (TCHAR *)MyName)); } INT32 FSize = GetFileSize(NULL); if(FSize == 0) { ERROR3_PF(("Filesize <= 0 found: '%s'", (TCHAR *)MyName)); } INT32 MRCount = MyName.Length() - 1; BOOL MFound = FALSE; TCHAR TheChar = ((TCHAR *)MyName)[MRCount]; while(((TheChar == ' ') || (TheChar >= '0' && TheChar <= '9')) && MRCount > 0) { if(TheChar != ' ') MFound = TRUE; TheChar = ((TCHAR *)MyName)[--MRCount]; } INT32 IRCount = ItsName.Length() - 1; BOOL IFound = FALSE; TheChar = ((TCHAR *)ItsName)[IRCount]; while(((TheChar == ' ') || (TheChar >= '0' && TheChar <= '9')) && IRCount > 0) { if(TheChar != ' ') IFound = TRUE; TheChar = ((TCHAR *)ItsName)[--IRCount]; } if(IFound && MFound) { String_256 MyLeft; String_256 ItsLeft; MyName.Left(&MyLeft, MRCount + 1); ItsName.Left(&ItsLeft, IRCount + 1); if(MyLeft == ItsLeft) { String_256 MyRight; String_256 ItsRight; MyName.Right(&MyRight, MyName.Length() - MRCount - 1); ItsName.Right(&ItsRight, ItsName.Length() - IRCount - 1); INT32 Me = _ttoi((TCHAR *)MyRight); INT32 It = _ttoi((TCHAR *)ItsRight); if(Me > It) return 1; else if(Me < It) return -1; } } return(MyName.CompareTo(ItsName, FALSE)); #endif } case 2: // Sort by size { Library *Lib = GetParentLibrary(); return(GetFileSize(Lib) - ((SGLibDisplayItem *)Other)->GetFileSize(Lib)); } case 3: // Sort by name length { String_256 MyName; String_256 ItsName; GetActualDisplayedText(&MyName); ((SGLibDisplayItem *)Other)->GetActualDisplayedText(&ItsName); return (MyName.Length() - ItsName.Length()); } break; case 4: // Sort by file type { PathName MyPath; PathName ItsPath; GetFileName(&MyPath); ((SGLibDisplayItem *)Other)->GetFileName(&ItsPath); Error::ClearError(); if(MyPath.IsValid() && ItsPath.IsValid()) { String_8 MyType(MyPath.GetType()); String_8 ItsType(ItsPath.GetType()); return(MyType.CompareTo(ItsType, FALSE)); } } break; } return (SGDisplayNode::CompareTo(Other, SortKey)); }

BOOL SGLibDisplayItem::DownloadThumbnail (   )  [virtual]

Starts to download the item's thumbnail. Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 6/02/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE the download was started succesfully, false otherwise Definition at line 2794 of file sglib.cpp. { nPercentageDownloaded = 0; OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(OpThumbDownload)); if (pOpDesc != NULL) { ThumbDownloadParam* Param = new ThumbDownloadParam; ERROR3IF(!Param, "Memory allocation error"); Param->pItem = this; Param->type = GetParentLibrary()->GetType(); // Invoke the operation pOpDesc->Invoke((OpParam*) Param); if (Param->bSuccess) { pDownloadOp = Param->pOp; bIsDownloadingThumb = TRUE; return TRUE; } } return FALSE; }

void SGLibDisplayItem::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: SGFillsItem::HandleEvent; GalleryFillsDragInfo::OnClick Reimplemented from SGDisplayNode. Definition at line 2409 of file sglib.cpp. { // Just get default selection action to be applied for this click DefaultClickHandler(Mouse, MiscInfo, TRUE); }

void SGLibDisplayItem::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 630 of file sglib.cpp. { LibDisplayType DType = GetDisplayType(MiscInfo); // Work out the text rectangle and stick it here DocRect TextRect(*Rectangle); INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); switch(DType) { case LibDisplay_SmallThumbTextUnder: case LibDisplay_MediumThumbTextUnder: case LibDisplay_LargeThumbTextUnder: TextRect = *Rectangle; // Give some extra space above and below the clipart TextRect.lo.y = TextRect.lo.y + SG_SPACE_UNDER; TextRect.hi.y = TextRect.lo.y + SG_GapAboveText; // give the text a little space below the piccy frame, and more below to the next TextRect.Inflate(0, -OnePixel); break; case LibDisplay_SmallThumb: case LibDisplay_MediumThumb: case LibDisplay_LargeThumb: // No text return; break; default: TextRect = *Rectangle; TextRect.lo.x = BmpRect->hi.x + SG_GapBeforeText; break; } GridLockRect(MiscInfo, &TextRect); Renderer->SetLineWidth(0); Renderer->SetLineColour(RedrawInfo->Transparent); DocColour red(0xFF, 0, 0); // for new items // Set up the colours for rendering our text, and fill the background if selected if (Selected) { Renderer->SetFillColour(RedrawInfo->SelBackground); switch(DType) { case LibDisplay_SmallThumbTextUnder: case LibDisplay_MediumThumbTextUnder: case LibDisplay_LargeThumbTextUnder: Renderer->DrawRect(&TextRect); break; case LibDisplay_FullInfo: { // Two line full info selection rectangle 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 + OnePixel*4; SelRect.lo.y -= (SG_DefaultLargeIcon + OnePixel*5); SelRect.hi.x = TextRect.hi.x; GridLockRect(MiscInfo, &SelRect); Renderer->DrawRect(&SelRect); } break; default: { 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); } break; } Renderer->SetFixedSystemTextColours(&RedrawInfo->SelForeground, &RedrawInfo->SelBackground); } else Renderer->SetFixedSystemTextColours(&RedrawInfo->Foreground, &RedrawInfo->Background); // No point drawing the text, etc... if(TextRect.lo.x + (OnePixel * 4) > Rectangle->hi.x) return; // Get the text into the text strings... String_256 DisplayText; String_256 DisplayText2; switch(DType) { case LibDisplay_FullInfo: // Work out proper text strings to display and display it // This string is also used by the sorting code, so use a common function to get it... if(!GetActualDisplayedText(&DisplayText, 1)) DisplayText = TEXT(""); if(!GetActualDisplayedText(&DisplayText2, 2)) DisplayText2 = TEXT(""); break; default: if(!GetActualDisplayedText(&DisplayText, 0)) DisplayText = TEXT(""); break; } if (bIsNew) { String_256 strTemp(_R(IDS_FOLDERNEW)); strTemp += _T(" "); strTemp += DisplayText; DisplayText = strTemp; } // And finally plot the text itself switch(DType) { case LibDisplay_SmallThumbTextUnder: case LibDisplay_MediumThumbTextUnder: case LibDisplay_LargeThumbTextUnder: { // Centred plot // Get the size of the text string DocRect TextBoundRect; Renderer->GetFixedSystemTextSize(&DisplayText, &TextBoundRect); // Centre the TextBoundRect about the TextRect TextBoundRect.Translate(TextRect.lo.x + (TextRect.Width()-TextBoundRect.Width())/2, TextRect.lo.y + (TextRect.Height()-TextBoundRect.Height())/2); // Ooops, too big... Use initial rectangle if(TextBoundRect.Width() > TextRect.Width() || TextBoundRect.Height() > TextRect.Height()) TextBoundRect = TextRect; // Draw the text Renderer->DrawFixedSystemText(&DisplayText, TextBoundRect); if (bIsNew) { *camStrchr(DisplayText, _T(' ')) = 0x00; Renderer->SetFixedSystemTextColours(&red, &RedrawInfo->Background); Renderer->DrawFixedSystemText(&DisplayText, TextBoundRect); Renderer->SetFixedSystemTextColours(&RedrawInfo->Foreground, &RedrawInfo->Background); } } break; case LibDisplay_FullInfo: { // Two line full info plot // Get the size of the text string DocRect TextBoundRect; Renderer->GetFixedSystemTextSize(&DisplayText, &TextBoundRect); // Work out the two bounding rectangles TextRect.lo.x += (OnePixel * 4); DocRect TopTextRect(TextRect); DocRect BottomTextRect(TextRect); INT32 Shift = (TextBoundRect.Height()/2) + (OnePixel * 2); TopTextRect.lo.y += Shift; TopTextRect.hi.y += Shift; BottomTextRect.lo.y -= Shift; BottomTextRect.hi.y -= Shift; // Draw the text Renderer->DrawFixedSystemText(&DisplayText, TopTextRect); if (bIsNew) { *camStrchr(DisplayText, _T(' ')) = 0x00; Renderer->SetFixedSystemTextColours(&red, &RedrawInfo->Background); Renderer->DrawFixedSystemText(&DisplayText, TopTextRect); Renderer->SetFixedSystemTextColours(&RedrawInfo->Foreground, &RedrawInfo->Background); } Renderer->DrawFixedSystemText(&DisplayText2, BottomTextRect); } break; default: // Left justified plot TextRect.lo.x += (OnePixel * 4); //SG_GapBeforeText; Renderer->DrawFixedSystemText(&DisplayText, TextRect); if (bIsNew) { *camStrchr(DisplayText, _T(' ')) = 0x00; Renderer->SetFixedSystemTextColours(&red, &RedrawInfo->Background); Renderer->DrawFixedSystemText(&DisplayText, TextRect); Renderer->SetFixedSystemTextColours(&RedrawInfo->Foreground, &RedrawInfo->Background); } break; } }

void SGLibDisplayItem::DrawItemThumbnail (  SGRedrawInfo *  pRedrawInfo, SGMiscInfo *  pMiscInfo, DocRect *  pDocRect )  [protected, virtual]

draws the item's thumbnail Scope: protected Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: pRedrawInfo  - pointer to SGRedrawInfo struct as passes to the HandleRedraw() [INPUTS] function from whithin which this function should be called pRedrawInfo - pointer to SGMiscInfo struct as passes to the HandleRedraw() function from whithin which this function should be called pDocRect - pointer to the rect where the thumbnail should be drawn Definition at line 540 of file sglib.cpp. { RenderRegion* pRenderer = pRedrawInfo->Renderer; if (Library::BackgroundRedraw) { BOOL DrawnBitmap = DrawThumb(pRenderer, pRedrawInfo, pMiscInfo, pDocRect, FALSE); if (ShouldDownloadThumb()) DownloadThumbnail(); if (ShouldIDrawForeground(DrawnBitmap)) { if (!DrawnBitmap) { if (!DrawThumb(pRenderer, pRedrawInfo, pMiscInfo, pDocRect, TRUE)) { if (IsDownloadingThumb()) // draw grey rectangle if we're still waiting for the thumbnail DrawPlaceholder(pRenderer, pMiscInfo, pDocRect, TRUE); else // draw a crossed box DrawPlaceholder(pRenderer, pMiscInfo, pDocRect, FALSE); } } } else if (!DrawnBitmap) DrawPlaceholder(pRenderer, pMiscInfo, pDocRect, TRUE); } else if (!DrawThumb(pRenderer, pRedrawInfo, pMiscInfo, pDocRect, TRUE)) DrawPlaceholder(pRenderer, pMiscInfo, pDocRect, FALSE); }

void SGLibDisplayItem::DrawNullBitmapRect (  RenderRegion *  Renderer, SGMiscInfo *  MiscInfo, DocRect *  Rectangle, BOOL  Background )  [static]

Draws a rectangle with two lines crossing it, to signify that the thumbnail could not be found, or could not be generated. Parameters: Renderer  - Pointer to RenderRegion in which to plot the bitmap rect [INPUTS] MiscInfo - Miscellaneous info as passed to the redraw handler by the sgallery code Rectangle - Pointer to a DocRect the size and position of where the bitmap would be positioned normally Background - If true, draw a background redrawing, not plotted proper thumbnail rectangle [OUTPUTS]  Returns: Notes: See also: SGLibDisplayItem::HandleRedraw Definition at line 1115 of file sglib.cpp. { if(Renderer == NULL || MiscInfo == NULL || Rectangle == NULL) { ERROR3("SGLibDisplayItem::DrawNullBitmapRect null params are BAD"); return; } // Draw the 'blank' bitmap if(!Background) Renderer->SetFillColour(COLOUR_GREY); else { DocColour NullBitmapColour(230L, 230L, 230L); Renderer->SetFillColour(NullBitmapColour); } GridLockRect(MiscInfo, Rectangle); Renderer->DrawRect(Rectangle); // Yes I know it's horrible, but since we're now a static, DevicePixels doesn't seem to work INT32 OnePixel = MiscInfo->PixelSize; Renderer->SetLineWidth(0); Renderer->SetLineColour(DocColour(COLOUR_TRANS)); Renderer->SetFillColour(DocColour(COLOUR_BLACK)); DocRect TempRect(*Rectangle); // Left TempRect.hi.x = TempRect.lo.x + OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Top TempRect.lo.y = TempRect.hi.y - OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Right TempRect.lo.x = TempRect.hi.x - OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Bottom TempRect.hi.y = TempRect.lo.y + OnePixel; Renderer->DrawRect(&TempRect); if(!Background) { // Pop two intersecting lines through the centre of the rectangle to signify // that the item doesn't have a thumbnail TempRect = *Rectangle; // Middle X TempRect.hi.y = TempRect.lo.y + (TempRect.Height() / 2); TempRect.lo.y = TempRect.hi.y; GridLockRect(MiscInfo, &TempRect); TempRect.hi.y += OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Middle Y TempRect.hi.x = TempRect.lo.x + (TempRect.Width() / 2); TempRect.lo.x = TempRect.hi.x; GridLockRect(MiscInfo, &TempRect); TempRect.hi.x += OnePixel; Renderer->DrawRect(&TempRect); } }

void SGLibDisplayItem::DrawPlaceholder (  RenderRegion *  Renderer, SGMiscInfo *  MiscInfo, DocRect *  Rectangle, BOOL  Background )  [protected, virtual]

Draws a thumbnail placeholder if the actual thumbnail is not available. If the thumb is downloading, it displays the percentage downloaded so far. Parameters: Renderer  - Pointer to RenderRegion in which to plot the bitmap rect [INPUTS] MiscInfo - Miscellaneous info as passed to the redraw handler by the sgallery code Rectangle - Pointer to a DocRect the size and position of where the bitmap would be positioned normally Background - If true, draw a background redrawing, not plotted proper thumbnail rectangle [OUTPUTS]  Returns: Notes: If the OS is not Windows this function will simply call DrawNullBitmapRect See also: SGLibDisplayItem::HandleRedraw Definition at line 2895 of file sglib.cpp. { if (Renderer == NULL || MiscInfo == NULL || Rectangle == NULL) { ERROR3("Illegal NULL pointer"); return; } #ifdef _WIN32 if (Background) { DocColour NullBitmapColour(230L, 230L, 230L); Renderer->SetFillColour(NullBitmapColour); GridLockRect(MiscInfo, Rectangle); Renderer->DrawRect(Rectangle); INT32 OnePixel = MiscInfo->PixelSize; Renderer->SetLineWidth(0); Renderer->SetLineColour(DocColour(COLOUR_TRANS)); Renderer->SetFillColour(DocColour(COLOUR_BLACK)); DocRect TempRect(*Rectangle); // Left TempRect.hi.x = TempRect.lo.x + OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Top TempRect.lo.y = TempRect.hi.y - OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Right TempRect.lo.x = TempRect.hi.x - OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Bottom TempRect.hi.y = TempRect.lo.y + OnePixel; Renderer->DrawRect(&TempRect); if (IsDownloadingThumb()) { String_32 strLabel(GetStringField(0, _R(IDS_LOADINGTHUMB))); DocRect rcText; Renderer->DrawFixedSystemText(&strLabel, rcText, FORMAT_NOPREFIX | FORMAT_CALCRECT | FORMAT_SINGLELINE | FORMAT_CENTER | FORMAT_VCENTER); if (rcText.Width() >= Rectangle->Width()) // we have to draw multiline { camSprintf((TCHAR*) strLabel, _T("%s%d%%"), (TCHAR*) (String_256) GetStringField(1, _R(IDS_LOADINGTHUMB)), nPercentageDownloaded); // DrawFixedSystemText can't center multiline text, so we'll have to adjust the rect Renderer->DrawFixedSystemText(&strLabel, rcText, FORMAT_NOPREFIX | FORMAT_CALCRECT); DocRect rcAdjusted = *Rectangle; rcAdjusted.hi.y -= ((rcAdjusted.hi.y - rcAdjusted.lo.y) - (rcText.hi.y - rcText.lo.y))/2; Renderer->DrawFixedSystemText(&strLabel, rcAdjusted, FORMAT_NOPREFIX | FORMAT_CENTER); } else { camSprintf((TCHAR*) strLabel, _T("%s%d%%"), (TCHAR*) (String_256) GetStringField(2, _R(IDS_LOADINGTHUMB)), nPercentageDownloaded); Renderer->DrawFixedSystemText(&strLabel, *Rectangle, FORMAT_NOPREFIX | FORMAT_SINGLELINE | FORMAT_CENTER | FORMAT_VCENTER); } } } else { DrawNullBitmapRect(Renderer, MiscInfo, Rectangle, Background); } #else DrawNullBitmapRect(Renderer, MiscInfo, Rectangle, Background); #endif }

BOOL SGLibDisplayItem::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 980 of file sglib.cpp. { KernelBitmap *Bitmap = GetDisplayedKernelBitmap(MiscInfo, Background); // Bitmap not there... if(Bitmap == NULL) return FALSE; INT32 XSize = 0; INT32 YSize = 0; double Scale = (double)1; INT32 XTrans = 0; INT32 YTrans = 0; BOOL Outline = FALSE; if(!GetThumbSize(MiscInfo, Rectangle, Bitmap, &XSize, &YSize, &Scale, &XTrans, &YTrans, &Outline)) return FALSE; DocRect BmpRect(0, 0, XSize, YSize); BmpRect.Translate(XTrans, YTrans); #if 0