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 // Setup the bitmap ready for plotting UINT32 InputBPP = Bitmap->GetBPP(); if(InputBPP >= 24) { CDC *pDC = Renderer->GetRenderDC(); INT32 OutputBPP = pDC->GetDeviceCaps(BITSPIXEL); if(OutputBPP == 8) { //ERROR3("Given a 32\\24bpp bitmap to plot on an 8bpp device"); } } #endif // Create a path with the bitmap in, ready for plotting... NodeBitmap *DummyBmp = new NodeBitmap(); if(DummyBmp == NULL) { ERROR3("SGLibDisplayItem::DrawThumb can't get node bitmap - not enough memory ?"); return FALSE; } DummyBmp->SetUpPath(); DummyBmp->CreateShape(BmpRect); DummyBmp->GetBitmapRef()->SetBitmap(Bitmap); // Plot white background rectangle... //Renderer->SetFillColour(RedrawInfo->Background); //Renderer->SetLineColour(COLOUR_TRANS); //RedrawInfo->Background); //Renderer->DrawRect(Rectangle); // Now render the bitmap DummyBmp->Render(Renderer); delete DummyBmp; // If we're displaying text underneath the thumbnail, add some space for it LibDisplayType DType = GetDisplayType(MiscInfo); // Extra space required by the text switch(DType) { case LibDisplay_SmallThumbTextUnder: case LibDisplay_MediumThumbTextUnder: case LibDisplay_LargeThumbTextUnder: // Text is underneath // Border around small objects if(Outline) { INT32 OnePixel = DevicePixels(MiscInfo, 1); Renderer->SetLineWidth(0); Renderer->SetLineColour(DocColour(COLOUR_TRANS)); Renderer->SetFillColour(DocColour(COLOUR_GREY)); DocRect TempRect(*Rectangle); // Left TempRect.Inflate(OnePixel); TempRect.hi.x = TempRect.lo.x + OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Top TempRect.Inflate(OnePixel); TempRect.lo.y = TempRect.hi.y - OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Right TempRect.Inflate(OnePixel); TempRect.lo.x = TempRect.hi.x - OnePixel; Renderer->DrawRect(&TempRect); TempRect = *Rectangle; // Bottom TempRect.Inflate(OnePixel); TempRect.hi.y = TempRect.lo.y + OnePixel; Renderer->DrawRect(&TempRect); } break; default: // don't add a rectangle unless the text is below - hence a long way away break; } // Drawn bitmap preview ok return TRUE; }

BOOL SGLibDisplayItem::GetActualDisplayedText (  String_256 *  String, INT32  Line = 0 )  [virtual]

Returns the mode-sensitive string that will actually be displayed. This is handy for sorting methods, etc... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 22/5/95 Parameters: Line  - Line number for multi-line strings. All multi-liners start from 1, [INPUTS] and return FALSE if an invalid line is supplied. Setting Line to 0 will return all the text information, String_256 permitting of course... String  - Returns the string that will actually be displayed in the current mode [OUTPUTS] Returns: TRUE if all went ok Definition at line 2119 of file sglib.cpp. { ERROR3IF(String == NULL, "SGLibDisplayItem::GetActualDisplayedText with params is a real recipe for disaster"); // We're going to do something horrible here... SGMiscInfo MiscInfo; SuperGallery *ParentGal = GetParentGallery(); ERROR3IF(ParentGal == NULL, "SGLibDisplayItem::GetActualDisplayedText with null parent gallery"); MiscInfo.DisplayMode = ParentGal->GetDisplayMode(); LibDisplayType DType = GetDisplayType(&MiscInfo); // Work out proper text string to display and display it switch(DType) { case LibDisplay_FullInfo: case LibDisplay_SingleLineFullInfo: // Use the full info description GetFullInfoText(String, Line); break; default: // Just use the normal text description GetNameText(String); break; } return TRUE; }

BOOL SGLibDisplayItem::GetActualDisplayedTextPtr (  TCHAR **  String, INT32  Line = 0 )  [virtual]

Returns the mode-sensitive string ptr that will actually be displayed. This is handy for sorting methods, etc... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 22/5/95 Parameters: Line  - Line number for multi-line strings. All multi-liners start from 1, [INPUTS] and return FALSE if an invalid line is supplied. Setting Line to 0 will return all the text information, String_256 permitting of course... String  - Returns a ptr to the string that will actually be displayed in the current mode [OUTPUTS] Returns: TRUE if all went ok Definition at line 2169 of file sglib.cpp. { ERROR3IF(String == NULL, "SGLibDisplayItem::GetActualDisplayedText with params is a real recipe for disaster"); // We're going to do something horrible here... SGMiscInfo MiscInfo; SuperGallery *ParentGal = GetParentGallery(); ERROR3IF(ParentGal == NULL, "SGLibDisplayItem::GetActualDisplayedText with null parent gallery"); MiscInfo.DisplayMode = ParentGal->GetDisplayMode(); LibDisplayType DType = GetDisplayType(&MiscInfo); // Work out proper text string to display and display it switch(DType) { case LibDisplay_FullInfo: case LibDisplay_SingleLineFullInfo: // Use the full info description - can't do this in memory return FALSE; default: // Just use the normal text description return GetNameTextPtr(String); } return FALSE; }

BOOL SGLibDisplayItem::GetBubbleHelp (  DocCoord *  MousePos, String_256 *  Result )  [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: 1/6/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. Reimplemented in SGLibFontItem. Definition at line 1636 of file sglib.cpp. { ERROR3IF(MousePos == NULL || Result == NULL, "Invalid NULL params"); return FALSE; }

KernelBitmap * SGLibDisplayItem::GetDisplayedKernelBitmap (  SGMiscInfo *  MiscInfo, BOOL  Background = FALSE )

To find out the KernelBitmap this object is responsible for displaying. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 19/02/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 1938 of file sglib.cpp. { KernelBitmap *BM = NULL; SGThumbSize Size = SGThumb_Large; // Get the current display mode type LibDisplayType DType = GetDisplayType(MiscInfo); // Which thumbnail should we be asking the thumb cache for ? switch(DType) { case LibDisplay_MediumThumbText: case LibDisplay_MediumThumbTextUnder: case LibDisplay_MediumThumb: case LibDisplay_FullInfo: case LibDisplay_SingleLineFullInfo: Size = SGThumb_Medium; break; case LibDisplay_SmallThumbText: case LibDisplay_SmallThumbTextUnder: case LibDisplay_SmallThumb: Size = SGThumb_Small; break; case LibDisplay_JustText: return NULL; default: Size = SGThumb_Large; break; } // If we can get a Library from an item, we're sorted... Library *Lib = GetParentLibrary(); // For background redraws we want the bitmap, but for foreground ones we only want // it if it's in the cache... BOOL GotIt = FALSE; if (Lib != NULL) GotIt = Lib->GetThumbnail(TheLibraryIndex, Size, Background, &BM); if(GotIt) return(BM); else return NULL; }

LibraryIndex SGLibDisplayItem::GetDisplayedLibraryIndex (  void   )  [inline]

To find out the LibraryIndex this object is responsible for displaying. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> (Based on template code by Jason) Date: 27/1/95 Returns: A pointer to the LibraryIndex which this Display Item is used to display. Definition at line 312 of file sglib.h. { return(TheLibraryIndex); }

BOOL SGLibDisplayItem::GetDisplayedTextDescription (  TCHAR **  Result  )  [virtual]

To find the Text description for this object. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 18/05/95 Parameters: Result  - will be filled in with the Description string which this [OUTPUTS] Display Item uses. Returns: FALSE if it failed, else TRUE Notes: Will return false if the index is not in memory... Definition at line 2042 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetDisplayedTextDescription - NULL param is illegal"); Library *Lib = GetParentLibrary(); // Get the name using our library code if (Lib != NULL) return(Lib->GetTextname(TheLibraryIndex, Result)); return(FALSE); }

BOOL SGLibDisplayItem::GetDisplayedTextDescription (  String_256 *  Result  )  [virtual]

To find the Text description for this object. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 19/02/95 Parameters: Result  - will be filled in with the Description string which this [OUTPUTS] Display Item uses. Returns: FALSE if it failed, else TRUE Definition at line 2004 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetDisplayedTextDescription - NULL param is illegal"); BOOL ok = FALSE; Library *Lib = GetParentLibrary(); // Get the name using our library code if (Lib != NULL) ok = Lib->GetTextname(TheLibraryIndex, Result); // Ensure String wiped if any problems if(!ok) *Result = TEXT(""); return ok; }

LibDisplayType SGLibDisplayItem::GetDisplayType (  SGMiscInfo *  MiscInfo  )  [protected, virtual]

Return the display type to use - this should be overridden by the library gallery using the code. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 14/3/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) Notes: There is the possibility that the MiscInfo passed only has a valid DisplayMode setup - the rest might be garbage Reimplemented in SGClipartItem, SGFillsItem, and SGLibFontItem. Definition at line 1204 of file sglib.cpp. { switch(MiscInfo->DisplayMode) { case 1: return LibDisplay_SmallThumbText; break; case 2: return LibDisplay_FullInfo; break; case 0: default: return LibDisplay_LargeThumbTextUnder; break; } return LibDisplay_LargeThumbTextUnder; }

BOOL SGLibDisplayItem::GetFileName (  PathName *  Result  )

To find the corresponding filename for this object. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 17/03/95 Parameters: Result  - will be filled in with the full filename of the object [OUTPUTS] Returns: FALSE if it failed, else TRUE Definition at line 2070 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetFileName - NULL param is illegal"); Library *Lib = GetParentLibrary(); Result->SetPathName(String_8(""), FALSE); // Ensure path wiped if we fail //Error::ClearError(); // Get the name using our library code if (Lib != NULL) { String_256 TmpPath; BOOL ok = Lib->GetFilename(TheLibraryIndex, &TmpPath, TRUE); Result->SetPathName(TmpPath); // Dodgy pathname if(!ok && !Result->IsValid()) ok = FALSE; return ok; } return FALSE; }

void SGLibDisplayItem::GetFileName (  String_256 *  Result  )  [virtual]

Returns the filename (without path) for the given item This is needed by the searching code. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/95 Parameters: [INPUTS]  Result  - String to place resulting filename in [OUTPUTS] Definition at line 1238 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetFileName given a NULL param"); // If we can get a Library from an item, we're sorted... Library *Lib = GetParentLibrary(); if (Lib != NULL) { Lib->GetFilename(TheLibraryIndex, Result, FALSE); } else { *Result = ""; } }

BOOL SGLibDisplayItem::GetFileNamePtr (  TCHAR **  Result  )  [virtual]

Returns the filename (without path) for the given item This is needed by the searching code. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/95 Parameters: [INPUTS]  Result  - String to place resulting filename in [OUTPUTS] Notes: Quicker than previous String_256 version... Definition at line 1272 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetFileName given a NULL param"); BOOL ok = FALSE; // If we can get a Library from an item, we're sorted... Library *Lib = GetParentLibrary(); if (Lib != NULL) ok = Lib->GetFilename(TheLibraryIndex, Result); else ok = FALSE; return (ok); }

INT32 SGLibDisplayItem::GetFileSize (  Library *  Lib = NULL  )

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: 13/4/95 Parameters: Lib  can optionally point to the library to use - we can get it if it [INPUTS] doesn't. 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 Definition at line 1584 of file sglib.cpp. { // Check the index file first... if (Lib == NULL) Lib = GetParentLibrary(); if (Lib != NULL) { String_64 SizeTxt(_R(IDS_LIBRARIES_INDEX_ITEM_SIZE)); String_64 Result; if(Lib->GetSingleField(TheLibraryIndex, &SizeTxt, &Result)) { INT32 size = _ttoi((TCHAR *)Result); if(size > 0) return size; } } // If the index info is not available, or the size was 0 in the index, // resort to using the OS on the file PathName ItemPath; GetFileName(&ItemPath); return SGLibOil::FileSize(&ItemPath); }

void SGLibDisplayItem::GetFullInfoText (  String_256 *  Result, INT32  Line = 0 )  [protected, virtual]

Returns the full-info text for this item, to support simple searching operations, and generic redraw methods for library items. Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 14/3/95 Parameters: Line  - Line number for multi-line strings. All multi-liners start from 1, [INPUTS] and return FALSE if an invalid line is supplied. Setting Line to 0 will return all the text information, String_256 permitting of course... Result  - String to place resulting text in [OUTPUTS] See also: Definition at line 1403 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetFullInfoText given a NULL param"); // If we can get a Library from an item, we're sorted... Library *Lib = GetParentLibrary(); if (Lib == NULL) { ERROR3("Lib == NULL in GetFullInfoText"); *Result = ""; } else { // No text if Line is set to something weird... *Result = TEXT(""); String_256 Text; // Full description and title, as given in the index if(Line < 2 && Line >= 0) { GetDisplayedTextDescription(&Text); BOOL FullDescription = (Text.Length() > 0); *Result = Text; // Title used in normal display modes if(Lib->GetTitle(TheLibraryIndex, &Text)) { if(FullDescription) { // " (Text)" String_256 TmpResult; TmpResult.MakeMsg(_R(IDS_SGLIB_FULLDESCRIPTION), (TCHAR *)Text); *Result += TmpResult; } else *Result += Text; } } // Trivial bit of logic made tricky here... // If the first line was blank, give it the Filename, else only give the second // line the filename BOOL GiveLineFileName = FALSE; if((Line == 0) || (Line == 1 && Result->Length() == 0)) GiveLineFileName = TRUE; if(Line == 2) { GiveLineFileName = FALSE; GetDisplayedTextDescription(&Text); if(Text.Length() > 0) GiveLineFileName = TRUE; // Title used in normal display modes if(Lib->GetTitle(TheLibraryIndex, &Text)) if(Text.Length() > 0) GiveLineFileName = TRUE; } // The line needs the filename... if(GiveLineFileName) { // Filename of file without the path Lib->GetFilename(TheLibraryIndex, &Text, FALSE); /* if(Line == 0) *Result += TEXT(", "); *Result += TEXT("'"); *Result += Text; *Result += TEXT("'"); if(Line != 1) *Result += TEXT(", ");*/ String_256 FileNameBit; switch(Line) { case 0: FileNameBit.MakeMsg(_R(IDS_SGLIB_FNAMEBIT_LINE0), (TCHAR *)Text); //", '#1%s', " break; case 1: FileNameBit.MakeMsg(_R(IDS_SGLIB_FNAMEBIT_LINE1), (TCHAR *)Text); //"'#1%s'" break; default: FileNameBit.MakeMsg(_R(IDS_SGLIB_FNAMEBIT_DEFAULT), (TCHAR *)Text); //"'#1%s', " break; } *Result += FileNameBit; } // Filesize of file, expressed in a pleasant textual format if((Line == 0) || (Line == 2)) { INT32 FileSize = GetFileSize(Lib); if(Convert::BytesToString(&Text, (UINT32)FileSize)) { *Result += Text; } } } }

void SGLibDisplayItem::GetFullInfoText (  String_256 *  Result  )  [protected, virtual]

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... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 14/3/95 Parameters: Result  - String to place resulting text in [OUTPUTS] See also: Reimplemented from SGDisplayNode. Reimplemented in SGLibFontItem. Definition at line 1377 of file sglib.cpp. { // Call the below function to get a full line of text... GetFullInfoText(Result, 0); }

void SGLibDisplayItem::GetKeyWords (  String_256 *  Result  )  [protected, 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 1536 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetKeyWords given a NULL param"); if(Result == NULL) return; *Result = ""; //SGDisplayGroup *SGGroup = (SGDisplayGroup *) GetParent(); SuperGallery *Parent = (SuperGallery *)GetParentGallery(); if(Parent != NULL) { if(Parent->CanSearchKeywords()) { Library *Lib = GetParentLibrary(); if (Lib != NULL) { String_64 Key(_R(IDS_LIBRARIES_INDEX_ITEM_KEY)); Lib->GetSingleField(TheLibraryIndex, &Key, Result); } } } }

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

Returns the name text for this item, to support simple searching and sorting operations, and generic redraw methods for library items. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 14/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) Reimplemented from SGDisplayNode. Reimplemented in SGLibFontItem. Definition at line 1305 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetNameText given a NULL param"); // If we can get a Library from an item, we're sorted... Library *Lib = GetParentLibrary(); if (Lib != NULL) { if(!Lib->GetTitle(TheLibraryIndex, Result)) Lib->GetFilename(TheLibraryIndex, Result, FALSE); } else { *Result = ""; } }

BOOL SGLibDisplayItem::GetNameTextPtr (  TCHAR **  Result  )  [virtual]

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.... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 3/5/95 Parameters: [INPUTS]  Result  - points to name in memory if the index file is cached [OUTPUTS] Returns: TRUE if index was cached and name found ok, etc... Notes: BEWARE: If the index file is not in memory this call will probably fail ! Reimplemented in SGLibFontItem. Definition at line 1342 of file sglib.cpp. { ERROR3IF(Result == NULL, "SGLibDisplayItem::GetNameText given a NULL param"); // If we can get a Library from an item, we're sorted... Library *Lib = GetParentLibrary(); BOOL ok = FALSE; if (Lib != NULL) { ok = Lib->GetTitle(TheLibraryIndex, Result); if(!ok) ok = Lib->GetFilename(TheLibraryIndex, Result); } return ok; }

Library * SGLibDisplayItem::GetParentLibrary (  void   )

Finds the library for which this DisplayItem displays an item. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 21/2/95 Returns: NULL if a serious error occurred (ERROR2 reported) else a pointer to the parent SGSubLib library object Definition at line 1898 of file sglib.cpp. { SGDisplayGroup *Parent = (SGDisplayGroup *) GetParent(); if (Parent == NULL) { ERROR2RAW("Infeasible gallery display tree structure detected"); return(NULL); } Library *ParentLib = Parent->GetParentLibrary(); /*if (ParentLib == NULL) { ERROR2RAW("Supergallery library display item has no attached library!"); return(NULL); }*/ return(ParentLib); }

BOOL SGLibDisplayItem::GetStatusLineHelp (  DocCoord *  MousePos, String_256 *  Result )  [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: 6/1/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. Reimplemented in SGLibFontItem. Definition at line 1672 of file sglib.cpp. { ERROR3IF(MousePos == NULL || Result == NULL, "Invalid NULL params"); GetNameText(Result); // Filesize of file, expressed in a pleasant textual format String_32 SizeString; INT32 FileSize = GetFileSize(NULL); if(Convert::BytesToString(&SizeString, (UINT32)GetFileSize(NULL))) { String_32 TmpStr; TmpStr.MakeMsg(_R(IDS_SGLIB_STAT_LINE_SIZE), (TCHAR *)SizeString); *Result += TmpStr; // " (Size)" } /* Double click to open this file, or drag and drop */ String_256 DClick(_R(IDS_LIBRARY_DOUBLE_CLICK_OPEN)); *Result += String_8(_R(IDS_SGFONTS_STATUS_LINE_SEP)); // "; " *Result += DClick; return(TRUE); }

INT32 SGLibDisplayItem::GetTextWidth (  SGFormatInfo *  FormatInfo, SGMiscInfo *  MiscInfo )  [protected, virtual]

An overridable way of returning the width of the text description. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/3/95 Parameters: FormatInfo  - The formatting info from which to calculate my position/size [INPUTS] MiscInfo - As usual, the useful misc info struct Width  (in millipoints) required by the description text for this mode [OUTPUTS] Reimplemented in SGLibFontItem. Definition at line 233 of file sglib.cpp. { INT32 XSize = SG_InfiniteWidth; INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); // If we're displaying text underneath the thumbnail, add some space for it LibDisplayType DType = GetDisplayType(MiscInfo); // Extra space required by the text switch(DType) { case LibDisplay_SmallThumbTextUnder: case LibDisplay_MediumThumbTextUnder: case LibDisplay_LargeThumbTextUnder: // Text is underneath XSize = 0; break; case LibDisplay_SmallThumb: case LibDisplay_MediumThumb: case LibDisplay_LargeThumb: // No text, so no space XSize = 0; break; case LibDisplay_FullInfo: case LibDisplay_SingleLineFullInfo: // XSize = SG_InfiniteWidth; XSize = SG_DefaultNameText * 2; break; case LibDisplay_JustText: // Text only XSize = (SG_DefaultNameText * 4) / 3; break; default: // Text is to the right XSize = (SG_DefaultNameText * 2) / 3; break; } // Lock the current sizes to the grid XSize = GridLock(MiscInfo, XSize); // Extra Space required if selected XSize += (3 * 2 * OnePixel); return XSize; }

BOOL SGLibDisplayItem::GetThumbFileName (  String_256 *  path  )  [virtual]

To find the corresponding filename for this object's thumb. Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 11/12/96 Parameters: Result  - will be filled in with the full filename of the object's thumb file [OUTPUTS] Returns: FALSE if it failed, else TRUE Reimplemented in SGLibFontItem. Definition at line 2974 of file sglib.cpp. { PathName filePath; GetFileName(&filePath); Library* pLibrary = GetParentLibrary(); if (!pLibrary) { ERROR3("Ilegal NULL pointer!"); return FALSE; } if (!pLibrary->IsWebLibrary()) { ERROR3("This function should only be called for web folders"); return FALSE; } PathName indexPath(*(pLibrary->ReturnIndexLocation())); String_256 thumbPath(indexPath.GetLocation()); thumbPath += filePath.GetFileName(FALSE); thumbPath += _T(".png"); // thumbnails for web files will always be PNGs *path = thumbPath; return TRUE; }

BOOL SGLibDisplayItem::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... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/4/95 Parameters: MiscInfo  - Miscellaneous info as passed to the redraw handler by the sgallery code [INPUTS] 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 XSize  - Returned size of thumbnail to use in millipoints [OUTPUTS] YSize - Returned size of thumbnail to use in millipoints Scale - Returns the Scale factor used XTrans - X translation required to centre image in rectangle YTrans - Y translation required to centre image in rectangle Outline - TRUE if the aspect ratio is such that we should put a rectangle round the item Returns: TRUE if things went OK, FALSE otherwise Notes: Going for the record number of parameters to a function ! See also: SGLibDisplayItem::HandleRedraw Definition at line 882 of file sglib.cpp. { if( MiscInfo == NULL || Bitmap == NULL || Rectangle == NULL || Bitmap->ActualBitmap == NULL || XSize == NULL || YSize == NULL) { ERROR3("SGLibDisplayItem::GetThumbSize given null params"); return FALSE; } // Get the bitmap's dimensions BitmapInfo Info; BOOL InfoOK = Bitmap->ActualBitmap->GetInfo( &Info ); if(InfoOK == FALSE) { ERROR3("SGLibDisplayItem::GetThumbSize can't get bitmap info - corrupt bitmap ?"); return FALSE; } MILLIPOINT BmpWidth = 0; MILLIPOINT BmpHeight = 0; INT32 OnePixel = DevicePixels(MiscInfo, 1); BmpWidth = Info.PixelWidth * OnePixel; BmpHeight = Info.PixelHeight * OnePixel; MILLIPOINT BoundWidth = 0; MILLIPOINT BoundHeight = 0; // Get the details of the bounding rectangle // Slight bodge so we round up slightly in the division... Gets the pixel plan right BoundWidth = Rectangle->Width();// + 400; BoundHeight = Rectangle->Height();// + 400; double XScale = (double)BmpWidth / (double)BoundWidth; double YScale = (double)BmpHeight / (double)BoundHeight; double TheScale = 1.0; // Which is the greatest ? if(XScale > YScale) TheScale = XScale; else TheScale = YScale; // If we're nearly at the correct size for the thumb, don't rescale it - looks better if(TheScale > 0.8 && TheScale < 1.0) TheScale = (double)1.0; // Arg... don't want divide by zero show-stoppers, thank you very much ! if(TheScale == 0) return FALSE; *XSize = (INT32)(BmpWidth / TheScale); *YSize = (INT32)(BmpHeight / TheScale); if(Scale != NULL) *Scale = TheScale; if(XTrans != NULL) *XTrans = Rectangle->lo.x + ((BoundWidth - ((INT32)(BmpWidth / TheScale))) / 2); if(YTrans != NULL) *YTrans = Rectangle->lo.y + ((BoundHeight - ((INT32)(BmpHeight / TheScale))) / 2); if(Outline != NULL && (XScale/YScale) > 1.6) *Outline = TRUE; return TRUE; }

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

Handles a SuperGallery DisplayTree event. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 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. Reimplemented in SGClipartItem, SGFillsItem, and SGLibFontItem. Definition at line 1749 of file sglib.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); if (IMustRedraw(RedrawInfo)) // only redraw if we intersect the clip rect HandleRedraw(RedrawInfo, MiscInfo); } break; // exit and return FALSE to pass the redraw event on case SGEVENT_MOUSECLICK: { SGMouseInfo *Mouse = GetMouseInfo(EventType, EventInfo); if (FormatRect.ContainsCoord(Mouse->Position)) { // No drag, so move on to normal selection click handling DefaultClickHandler(Mouse, MiscInfo); return(TRUE); } } break; default: return(SGDisplayItem::HandleEvent(EventType, EventInfo, MiscInfo)); break; } // Default return value: We do not claim this event, so it will be passed on to others return(FALSE); }

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

SGLibDisplayItem item redraw method - removed from the main HandleEvent method merely to make the code tidier. Notes: Scope: private. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/95 (base generated in sgbase.cpp) Parameters: RedrawInfo  - The information on the kernel-rendered redraw area [INPUTS] MiscInfo - always provided. Contains a few useful bits of info that may be needed for all event types. [Member variable FormatRect should be set up (before calling this method) to be the rectangle in which to draw this item] Reimplemented in SGLibFontItem. Definition at line 412 of file sglib.cpp. { // First, inform the system that we are about to start rendering this item StartRendering(RedrawInfo, MiscInfo); // Determine the SGSubLib library object to ask for info on this item Library *ParentLib = GetParentLibrary(); DocRect BmpRect(FormatRect); // Get my redraw position from the cached FormatRect DocRect UnscaledRect(FormatRect); RenderRegion *Renderer = RedrawInfo->Renderer; INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); INT32 TwoPixels = (INT32) DevicePixels(MiscInfo, 2); LibDisplayType DType = GetDisplayType(MiscInfo); //#ifdef _DEBUG // Show format rect // Renderer->SetFillColour(DocColour(0x40, 0x40, 0x40)); // Renderer->DrawRect(&UnscaledRect); //#endif Renderer->SetLineWidth(0); Renderer->SetLineColour(RedrawInfo->Transparent); if(DType == LibDisplay_JustText) { BmpRect.hi.x = BmpRect.lo.x + OnePixel; } else { INT32 XSize = 0; switch(DType) { case LibDisplay_MediumThumbTextUnder: case LibDisplay_MediumThumbText: case LibDisplay_MediumThumb: case LibDisplay_FullInfo: case LibDisplay_SingleLineFullInfo: XSize = ParentLib->PreviewBMPWidth(SGThumb_Medium); break; case LibDisplay_SmallThumbText: case LibDisplay_SmallThumbTextUnder: case LibDisplay_SmallThumb: XSize = ParentLib->PreviewBMPWidth(SGThumb_Small); break; case LibDisplay_Default: case LibDisplay_LargeThumbText: case LibDisplay_LargeThumb: case LibDisplay_LargeThumbTextUnder: default: // OnePixel bodge to get the 1:1 bitmaps inside the rectangle XSize = ParentLib->PreviewBMPWidth(SGThumb_Large); break; } // 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(-(TwoPixels+OnePixel)); // Exclude the space needed below the bmp rect from the bmp rect switch(DType) { case LibDisplay_SmallThumbTextUnder: case LibDisplay_MediumThumbTextUnder: case LibDisplay_LargeThumbTextUnder: BmpRect.lo.y += SG_GapAboveText + SG_SPACE_UNDER; break; default: break; } // Ensure it maps exactly to specific pixels GridLockRect(MiscInfo, &BmpRect); // Set up the colours for rendering our text, and outline it if selected if (Flags.Selected) { if(BmpRect.hi.x > UnscaledRect.hi.x) BmpRect.hi.x = UnscaledRect.hi.x; BmpRect.Inflate(TwoPixels+OnePixel); GridLockRect(MiscInfo, &BmpRect); // Ensure we're on a pixel DrawSelectionOutline(RedrawInfo, MiscInfo, &BmpRect); BmpRect.Inflate(-(TwoPixels+OnePixel)); } // Draw the thumbnail DrawItemThumbnail(RedrawInfo, MiscInfo, &BmpRect); } // 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 SGLibDisplayItem::IsDownloadingThumb (   )  [inline]

Definition at line 244 of file sglib.h. { return bIsDownloadingThumb;}

void SGLibDisplayItem::OnThumbDownloadComplete (   )  [virtual]

Should be called when the thumbnail download is over - it will force a redraw among other things. Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 6/02/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 2836 of file sglib.cpp. { bIsDownloadingThumb = FALSE; ForceRedrawOfMyself(); GetParentGallery()->PaintListNow(); pDownloadOp = NULL; }

void SGLibDisplayItem::OnThumbDownloadProgress (  const INT32  nPercentageCompleted  )  [virtual]

Called on thumbnail download progress - it will update the thumbnail's placeholder. NB: the background is not erased to prevent flickering. Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 6/02/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 2861 of file sglib.cpp. { nPercentageDownloaded = nPercentageCompleted; ForceRedrawOfMyself(FALSE); GetParentGallery()->PaintListNow(); }

BOOL SGLibDisplayItem::ShouldDownloadThumb (   )  [virtual]

Used to decide whether or not to (re)start a thumbnail download. Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 6/02/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if we should download the thumbnail for this item, false otherwise Definition at line 2759 of file sglib.cpp. { Library* pLibrary = GetParentLibrary(); ERROR2IF(!pLibrary, FALSE, "Illegal NULL pointer"); // Check if we belong to a web folder String_256 thumbPath; if (pLibrary->IsWebLibrary()) { GetThumbFileName(&thumbPath); return (_access((TCHAR*) thumbPath, 0) == -1 && !IsDownloadingThumb() && (!((LibraryGallery*) GetParentGallery())->IsThumbDownloadingSuspended()) && !OpThumbDownload::GetLastError(this)); } else { return FALSE; } }

BOOL SGLibDisplayItem::ShouldIDrawForeground (  BOOL  ForceForeground  )  [virtual]

overrides the base class version to force foreground mode if the item is downloading its thumbnail. This is necessary to avoid flickering. Author: Adrian_Stoicar (Xara Group Ltd) <camelotdev@xara.com> Date: 6/5/97 Parameters: ForceForeground  - TRUE if you want to force foreground redrawing (e.g. if you [INPUTS] know your thumbnail is cached you are better off just drawing it immediately), or FALSE to allow the operation to be backgrounded. Returns: TRUE if you should draw in the foreground (i.e. draw the item to completion), FALSE if you should draw the background stuff (i.e. draw a grey box instead of a thumbnail) - if FALSE, you'll be called back to complete the redraw later. See also: SGDisplayNode::ShouldIDrawForeground(BOOL ForceForeground) Reimplemented from SGDisplayNode. Definition at line 592 of file sglib.cpp. { if (pDownloadOp) return SGDisplayNode::ShouldIDrawForeground(TRUE); else return SGDisplayNode::ShouldIDrawForeground(ForceForeground); }

BOOL SGLibDisplayItem::StartDrag (  SGEventType  EventType, void *  EventInfo, SGMiscInfo *  MiscInfo, INT32 *  XSize, INT32 *  YSize )  [protected, virtual]

Sets the TmpDraggingBitmap up, and returns the sizes to the caller. Parameters: EventType  - An enumerated value describing what type of event is to be processed [INPUTS] EventInfo - A structure describing the event MiscInfo - always provided. Contains a few useful bits of info that may be needed for all event types. XSize,YSize  - Dimensions of object to drag [OUTPUTS] Returns: TRUE if it was a drag, false if double-click Notes: If this returns FALSE, don't try to create the drag object because something bad has happened. If it returns TRUE though, you should create the DragInfo object and call DragManagerOp::StartDrag(DragClipart); Definition at line 1822 of file sglib.cpp. { SGMouseInfo *Mouse = GetMouseInfo(EventType, EventInfo); if (Mouse->DoubleClick) { DefaultClickHandler(Mouse, MiscInfo); return FALSE; } else { DefaultPreDragHandler(Mouse, MiscInfo); // Grab a copy of the bitmap required for dragging KernelBitmap *DispBmp = GetDisplayedKernelBitmap(MiscInfo, TRUE); if(DispBmp) LibraryGallery::TmpDraggingBitmap = DIBUtil::CopyKernelBitmap(DispBmp, TRUE); else LibraryGallery::TmpDraggingBitmap = NULL; // Find the displayed pixel sizes of the bitmap to drag Library *ParentLib = GetParentLibrary(); if(ParentLib != 0) { // Thumbnail cache for library SGThumbs *Thumbs = ParentLib->Thumbnails; if(Thumbs != NULL) { // Get current size from thumbnail cache SGThumbSize ThumbSize = SGThumb_Large; if(Thumbs->GetSize(&ThumbSize)) { *XSize = ParentLib->PreviewBMPWidth(ThumbSize); *YSize = ParentLib->PreviewBMPHeight(ThumbSize); if(LibraryGallery::TmpDraggingBitmap != NULL) { INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); DocRect Rectangle(0, 0, (*XSize) * OnePixel, (*YSize) * OnePixel); // Get the proper aspect ratio'd clipped XSize and YSize (MILLIPOINTS) if(!GetThumbSize(MiscInfo, &Rectangle, LibraryGallery::TmpDraggingBitmap, XSize, YSize)) { *YSize = 0; *XSize = 0; } else { // Convert Millipoint values into pixel values *XSize = (*XSize) / OnePixel; *YSize = (*YSize) / OnePixel; } } } } } } return TRUE; }

---

Friends And Related Function Documentation

friend class OpThumbDownload [friend]

Definition at line 294 of file sglib.h.

---

Member Data Documentation

BOOL SGLibDisplayItem::bIsDownloadingThumb [protected]

Definition at line 288 of file sglib.h.

BOOL SGLibDisplayItem::bIsNew [protected]

Definition at line 290 of file sglib.h.

INT32 SGLibDisplayItem::nPercentageDownloaded [protected]

Definition at line 289 of file sglib.h.

OpThumbDownload* SGLibDisplayItem::pDownloadOp [protected]

Definition at line 291 of file sglib.h.

LibraryIndex SGLibDisplayItem::TheLibraryIndex [protected]

Definition at line 292 of file sglib.h.

---

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

• Kernel/sglib.h (r1785/r1282)
• Kernel/sglib.cpp (r1785/r1282)

---