LibFillsSGallery Class Reference

The LibFills SuperGallery class. More...

#include <sglfills.h>

Inheritance diagram for LibFillsSGallery:

List of all members.

Public Member Functions
	LibFillsSGallery ()
	LibFillsSGallery default constructor.
	~LibFillsSGallery ()
	LibFillsSGallery destructor.
virtual BOOL	IsLibraryGalleryWithNonLibraryGroups (void)
	To check if we're a dedicated library gallery, or a half+half (like the font gallery).
virtual MsgResult	Message (Msg *Message)
	A standard message handler, really.
virtual BOOL	CanSearchKeywords (void)
	Used to determine if this type of gallery supports keyword searching. This one does.
virtual BOOL	CanCreateIndexes (void)
	To determine if this gallery can generate indexes or not.
virtual BOOL	GetDefaults (String_256 *DefaultIndex, String_256 *IndexDesc, SGLibType *Type)
	To determine various library gallery default properties.
virtual BOOL	GetLibraryDirectoryName (String_256 *LibDirName)
	Get the default CD directory name for the gallery.
virtual BOOL	CheckForIndexMatch (StringBase *Txt)
	To see whether we should add this line of the index.txt file to this gallery.
virtual void	WorkOutSectionName (String_256 *Section)
	Returns the section name to use in the grm file.
virtual BOOL	GetQuietStatus (void)
	Get the Quiet status of the gallery.
virtual void	SetQuietStatus (BOOL Status)
	Set the Quiet status of the gallery.
virtual BOOL	ScanForLocation (SGLibType Type, StringBase *Result)
	Searches all the drives for a CDROM drive. If it finds the Camelot CD mount here at Xara HQ, we point to that instead. Notes:.
virtual SGLibType	GetGalleryType ()
virtual String_256 *	GetDefaultLibraryPath ()
void	SelectionHasChanged (void)
	To inform the gallery that the selection has changed in some way. We need to grey different buttons on different occasions Notes:.
virtual BOOL	InitMenuCommands (void)
	Initialises any menu commands that this gallery needs.
virtual BOOL	BuildCommandMenu (GalleryContextMenu *TheMenu, SGMenuID MenuID)
	To build a menu of commands to be popped up over the gallery.
virtual OpState	GetCommandState (StringBase *CommandID, String_256 *ShadeReason)
	To determine the state of a given menu item. This method is an exact parallel to an Op's GetState method (in fact, it is called by an Op's GetState).
virtual void	DoCommand (StringBase *CommandID)
	To apply a given command when it is chosen from the menu.
Static Public Member Functions
static BOOL	Init (void)
Static Public Attributes
static String_256	DefaultLibraryPath = TEXT("D:\\fills")
static INT32	DefaultDisplayMode = 0
static UINT32	DefaultSortKeys = 1
static LibFillsSGallery *	ThisGallery = NULL
static BOOL	QuietStatus = FALSE
Protected Member Functions
void	DoShadeGallery (BOOL ShadeIt)
	To un-grey the options... button when there are no docs Notes:.
virtual BOOL	PreCreate (void)
	The LibFillsSGallery PreCreate handler. This overrides the base class PreCreate function. It is called at the very beginning of the SuperGallery::Create method, before the window has been created.
virtual BOOL	ApplyAction (SGActionType Action)
	Applies certain conventional gallery actions (usually associated with gallery buttons, for new, edit, delete, etc).
virtual SGDisplayGroup *	AddLibraryGroup (Library *LibraryToDisplay, INT32 NumItems)
	Create a library group, as opposed to a display group Notes:.
virtual SGDisplayItem *	AddLibraryItem (SGDisplayGroup *LibraryGroup, Library *ParentLib, LibraryIndex ItemIndex, BOOL bNew=FALSE)
	Called by the Library class to create a display item for every item in a newly-scanned library file. It is essentially a callback to the gallery which requested that the library be scanned.
void	HandleDragStart (DragMessage *DragMsg)
	Checks a DragMessage to see if it is a colour drag. If it is, then it creates a drag target for this gallerys listbox.
bool	FillUsingFillGallerySelection (FillTypeEnum FillType)
	To import a fill into camelot, then apply it in the mannor selected.
BOOL	BrowseClicked (void)
	Pops up the browse box and lets a new location be set for the data.
void	SortGallery (void)
	Sorts the contents of the gallery in an alphabetical fashion, whilst keeping the old sort key status... Notes:.
SGDisplayItem *	CopyDisplayItem (SGDisplayItem *SourceItem, SGDisplayGroup *DestGroup, SGDisplayItem *TargetPosition)
	"Copies" the existing node in the tree in an appropriate fashion.
KernelBitmap *	GetSelectedBitmap (void)

---

Detailed Description

The LibFills SuperGallery class.

Author:

Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> (Based on Clipart gallery code by Richard / Jason)

Date:

23/3/95

Notes: SuperGalleries are specced in a number of docs including specs.doc ("super" gallery extensions) specs.doc (gallery basic ui) There is also howtouse.doc which describes creating a supergallery

See also:

SuperGallery; SGDisplayLibFills

Definition at line 134 of file sglfills.h.

---

Constructor & Destructor Documentation

LibFillsSGallery::LibFillsSGallery (   )

LibFillsSGallery default constructor. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 23/3/95 Definition at line 203 of file sglfills.cpp. { LibFillsSGallery::ThisGallery = this; // Default gallery size CSize Size(((333 * 2) - 32) - 32, 256); SetGallerySize(Size); }

LibFillsSGallery::~LibFillsSGallery (   )

LibFillsSGallery destructor. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 23/3/95 Definition at line 224 of file sglfills.cpp. { OpenLibFiles.DeleteAll(); // Ensure all open libraries are closed LibFillsSGallery::ThisGallery = NULL; }

---

Member Function Documentation

SGDisplayGroup * LibFillsSGallery::AddLibraryGroup (  Library *  LibraryToDisplay, INT32  NumItems )  [protected, virtual]

Create a library group, as opposed to a display group Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 20/4/95 Parameters: LibraryToDisplay  - Pointer to the library associated with the group [INPUTS] NumItems - Number of items in the group Returns: The newly created library group, or NULL if there were problems Reimplemented from LibraryGallery. Definition at line 1465 of file sglfills.cpp. { ERROR3IF(LibraryToDisplay == NULL, "LibFillsSGallery::AddLibraryGroup - NULL parameter is illegal"); if (DisplayTree == NULL) { ERROR3("LibFillsSGallery::AddLibraryGroup called before the DisplayTree was initialised!"); return(NULL); } SGLibGroup *TheGroup = (SGLibGroup *)DisplayTree->FindSubtree(this, NULL, LibraryToDisplay); if (TheGroup == NULL) { // No existing group for that library, so create a new one TheGroup = new SGLibGroup(this, NULL, LibraryToDisplay); if (TheGroup == NULL) // Failed! return(NULL); // And add it to our display tree DisplayTree->AddItem(TheGroup); } else TheGroup->DestroySubtree(FALSE); // Delete all items in the group return(TheGroup); }

SGDisplayItem * LibFillsSGallery::AddLibraryItem (  SGDisplayGroup *  LibraryGroup, Library *  ParentLib, LibraryIndex  ItemIndex, BOOL  bNew = FALSE )  [protected, virtual]

Called by the Library class to create a display item for every item in a newly-scanned library file. It is essentially a callback to the gallery which requested that the library be scanned. Parameters: LibraryGroup  - The group to add the item into [INPUTS] ParentLib - (For cross checking inputs) the library you allege the above group is for. ItemIndex - The Library generated index for this item Returns: NULL, or a pointer to the created item Notes: This method MUST BE OVERRIDDEN by the derived gallery that opens the library, in order to create appropriate SGDisplayItem-derived nodes for the things in the library (e.g. a Fills library gallery will have to create items that display Fills thumbnails) See also: SuperGallery::AddLibraryGroup; SuperGallery::RemoveLibraryGroup Reimplemented from LibraryGallery. Definition at line 1102 of file sglfills.cpp. { ERROR3IF(LibraryGroup == NULL || ParentLib == NULL, "LibFillsSGallery::AddLibraryItem - NULL params are illegal"); ERROR3IF(LibraryGroup->GetParentLibrary() != ParentLib, "LibFillsSGallery::AddLibraryitem - The DisplayGroup is not for the same library!"); // Create a Fills library item SGFillsItem *NewItem = new SGFillsItem(ItemIndex, bNew); // Alphabetic add... /* SGSortKey SortKeys[MaxSGSortKeys]; for (INT32 i = 0; i < MaxSGSortKeys; i++) { SortKeys[i].SortKey = 0; SortKeys[i].Reversed = FALSE; } SortKeys[0].SortKey = 1;*/ if (NewItem != NULL) LibraryGroup->AddItem(NewItem/*, (SGSortKey *)SortKeys*/); return(NewItem); }

BOOL LibFillsSGallery::ApplyAction (  SGActionType  Action  )  [protected, virtual]

Applies certain conventional gallery actions (usually associated with gallery buttons, for new, edit, delete, etc). Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 23/3/95 Parameters: Action  - Indicates what action to apply [INPUTS] Returns: TRUE to indicate successful handling of the action, or FALSE to indicate failure See also: SGActionType Reimplemented from LibraryGallery. Definition at line 570 of file sglfills.cpp. { // No display tree? Better forget about it then! if (DisplayTree == NULL) return(FALSE); // Now, process the action TO DO! - see Colour gallery for examples switch(Action) { case SGACTION_APPLYADJUST: // Drop through to SGACTION_APPLY handler case SGACTION_APPLY: // Import the current selection and apply it as a fill if(Document::GetSelected() == NULL) return FALSE; if(!FillUsingFillGallerySelection(ApplyToObject)) return FALSE; break; case SGACTION_SETOPTIONS: // Set values in the options dialogue as it is opened { if (CurrentOptionsDlg == NULL) return(FALSE); CurrentOptionsDlg->AddDisplayModeName(_R(IDS_GALLERYDM_LARGE)); // 0 CurrentOptionsDlg->AddDisplayModeName(_R(IDS_GALLERYDM_FULLINFO)); // 1 CurrentOptionsDlg->AddDisplayModeName(_R(IDS_GALLERYDM_SMALL)); // 2 } break; case SGACTION_SETSORTMODE: { if (CurrentSortDlg == NULL) return(FALSE); CurrentSortDlg->AddSortKeyName(_R(IDS_SORTBY_NAME)); CurrentSortDlg->AddSortKeyName(_R(IDS_SORTBY_MEMORY)); CurrentSortDlg->AddSortKeyName(_R(IDS_SORTBY_NAMELENGTH)); CurrentSortDlg->AddSortKeyName(_R(IDS_SORTBY_FILETYPE)); } break; case SGACTION_DISPLAYMODECHANGED: if(DisplayMode >= 3) DisplayMode = 0; DefaultDisplayMode = DisplayMode; InvalidateCachedFormat(); ReformatAndRedrawIfNecessary(); break; default: return(SuperGallery::ApplyAction(Action)); break; } return(TRUE); }

BOOL LibFillsSGallery::BrowseClicked (  void   )  [protected, virtual]

Pops up the browse box and lets a new location be set for the data. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 2/5/95 Parameters: [INPUTS]  Returns: TRUE if the gallery has new stuff in it (FALSE if cancel clicked, etc)... Reimplemented from LibraryGallery. Definition at line 353 of file sglfills.cpp. { return (LibraryGallery::BrowseClicked(&DefaultLibraryPath, SGLib_Texture, _R(IDS_REMOVE_OLD_GOUPS_FILLS))); }

BOOL LibFillsSGallery::BuildCommandMenu (  GalleryContextMenu *  TheMenu, SGMenuID  MenuID )  [virtual]

To build a menu of commands to be popped up over the gallery. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/95 Parameters: TheMenu  - The menu to add commands to [INPUTS] MenuID - The type of menu (over-list or from-options-button) to create Returns: TRUE if it succeeded Notes: Override this method to stop the default menus being built Reimplemented from SuperGallery. Definition at line 1277 of file sglfills.cpp. { BOOL ok = TRUE; if (MenuID == SGMENU_OPTIONS) { // Options menu ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Add); // With separator ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_EmptyFillsCache, TRUE); // With separator ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Find); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Sort); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Properties); } else { // Over-list menu ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Import); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Fill); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Transp,TRUE); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Remove, TRUE); // With separator ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_SetBackground,TRUE); SGDisplayGroup *TheGroup = FindCommandGroup(); // Fold or unfold as appropriate if (TheGroup == NULL || !TheGroup->Flags.Folded) ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_FoldGroup); else ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_UnfoldGroup); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_PrevGroup); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_NextGroup); } return(ok); }

BOOL LibFillsSGallery::CanCreateIndexes (  void   )  [virtual]

To determine if this gallery can generate indexes or not. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 18/12/95 Returns: TRUE to if index generation is possible Reimplemented from LibraryGallery. Definition at line 371 of file sglfills.cpp. { return TRUE; }

BOOL LibFillsSGallery::CanSearchKeywords (  void   )  [virtual]

Used to determine if this type of gallery supports keyword searching. This one does. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 30/3/95 Returns: TRUE Reimplemented from LibraryGallery. Definition at line 1146 of file sglfills.cpp. { return(TRUE); }

BOOL LibFillsSGallery::CheckForIndexMatch (  StringBase *  Txt  )  [virtual]

To see whether we should add this line of the index.txt file to this gallery. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 18/12/95 Parameters: Kind  - Last column entry in the index.txt file (" T") [INPUTS] Returns: TRUE if this signifies the gallery in question... Reimplemented from LibraryGallery. Definition at line 540 of file sglfills.cpp. { BOOL Match = FALSE; // Textures (fills) if(((Txt->Sub(String_8("T"))!=-1) || (Txt->Sub(String_8("t"))!=-1)) ) Match = TRUE; return Match; }

SGDisplayItem * LibFillsSGallery::CopyDisplayItem (  SGDisplayItem *  SourceItem, SGDisplayGroup *  DestGroup, SGDisplayItem *  TargetPosition )  [protected, virtual]

"Copies" the existing node in the tree in an appropriate fashion. Parameters: SourceItem  - The item to copy elsewhere in the tree (see below) [INPUTS] DestGroup - The group into which the item should be inserted TargetPosition - NULL (to add the copied item to the end of the sibling list), or points to an item BEFORE which the copied item will be inserted. Returns: NULL (failed) or a pointer to the new (copied) display item This method is normally called when a gallery-organising drag completes, and it is discovered that the dragged item(s) have been dragged to a different display group. Notes: This method should be overridden by derived galleries to provide appropriate behaviour (some galleries (e.g colour) will copy the real-item that the given display-item references to the new group (document), while other galleries (layer) may just move the item after all). Note the handy InsertCopiedItem and MoveBefore/After methods which are available to take all of the hard work out of copying/moving items! See the body of this method in the source code for example pseudocode. For real code, see the Colour Gallery (sgcolour.cpp) See also: SuperGallery::InsertCopiedItem; SGDisplayItem::MoveBefore; SGDisplayItem::MoveAfter; ColourSGallery::CopyDisplayItem Reimplemented from LibraryGallery. Definition at line 1533 of file sglfills.cpp. { if(SourceItem == NULL || DestGroup == NULL) { ERROR3("LibFillsSGallery::CopyDisplayItem -> Illegal NULL param"); return NULL; } // Check if we've dragged from one group to another and warn if that's the case if(DestGroup->IsKindOf(CC_RUNTIME_CLASS(SGLibGroup))) { SGDisplayNode *SourceGroup = SourceItem->GetParent(); if((SGDisplayGroup *)SourceGroup != DestGroup) { // "Can't move library fills between groups." InformError(_R(IDS_FILLS_BETWEEN_GROUPS), _R(IDS_OK)); Error::ClearError(); } } return(NULL); }

void LibFillsSGallery::DoCommand (  StringBase *  CommandID  )  [virtual]

To apply a given command when it is chosen from the menu. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/95 Parameters: CommandID  - The String ID of the command [INPUTS] Notes: Override this method to provide handling for your special commands. Call the base class if you don't recognise the command, so that it can handle standard commands. The base class handles all of these (maybe more - see the base class help) Properties, Sort, Find; New, Edit, Delete, Redefine; (it calls ApplyAction as appropriate) NextGroup, PrevGroup, FoldGroup, UnfoldGroup; Reimplemented from SuperGallery. Definition at line 1408 of file sglfills.cpp. { if (*CommandID == SGCmd_Import) // --- Import { if (Document::GetSelected() != NULL) FillUsingFillGallerySelection(AddToPage); } else if (*CommandID == SGCmd_Fill) // --- Fill { if (Document::GetSelected() != NULL) FillUsingFillGallerySelection(ApplyToObject); } else if (*CommandID == SGCmd_EmptyFillsCache) { RemoveWebFolders(SGLib_Fractal); } else if (*CommandID == SGCmd_Transp) // --- Transp { if (Document::GetSelected() != NULL) FillUsingFillGallerySelection(ApplyToObjectAsTransp); } else if (*CommandID == SGCmd_Add) // --- Add fills BrowseClicked(); else if (*CommandID == SGCmd_Remove) // --- Remove { RemoveSelectedLibraries(TRUE); UpdateGRMFile(); } else if (*CommandID == SGCmd_SetBackground) // --- Set background { if (Document::GetSelected() != NULL) FillUsingFillGallerySelection(SetBackground); } else SuperGallery::DoCommand(CommandID); // Unknown command- pass to the base class }

void LibFillsSGallery::DoShadeGallery (  BOOL  ShadeIt  )  [protected, virtual]

To un-grey the options... button when there are no docs Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> (based on Jason code) Date: 28/3/95 Reimplemented from LibraryGallery. Definition at line 890 of file sglfills.cpp. { if (DisplayTree == NULL) return; // Keep this here always EnableGadget(_R(IDC_GALLERY_MENU), TRUE); EnableGadget(_R(IDC_LIBGAL_IMPORT), !ShadeIt); EnableGadget(_R(IDC_BMPGAL_FILL), !ShadeIt); EnableGadget(_R(IDC_BMPGAL_TEXTURE), !ShadeIt); EnableGadget(_R(IDC_BMPGAL_BACKGROUND), !ShadeIt); EnableGadget(_R(IDC_LIBGAL_ADD_FILLS), TRUE); LibraryGallery::DoShadeGallery(ShadeIt); }

bool LibFillsSGallery::FillUsingFillGallerySelection (  FillTypeEnum  FillType  )  [protected]

To import a fill into camelot, then apply it in the mannor selected. Author: Jonathan_Payne (Xara Group Ltd) <camelotdev@xara.com> Date: 20/9/2000 Parameters: FillType  - The type of fill required (see def. of FillTypeEnum) [INPUTS] Returns: TRUE if things went OK, false otherwise See also: OnPageDrop Definition at line 922 of file sglfills.cpp. { PathName FileName; UINT32 TagObjectToFill = 0; // used for ApplyToObject and ApplyToObjectAsTransp // when downloading a fill if (GetSelectedItemCount() != 1 && FillType != AddToPage) { TRACEUSER( "Jonathan", _T("Fills: FillUsingGallerySelection failing due to multiple selection\n")); return false; } SGLibDisplayItem *FillItem = static_cast<SGLibDisplayItem *>(DisplayTree->FindNextSelectedItem()); if (!FillItem->GetFileName(&FileName)) return false; if (!FileName.IsValid(FileName.GetPath())) { ERROR3("Filename is invalid"); return false; } bool NeedToDownload; if (_taccess(FileName.GetPath(), 0) == -1) NeedToDownload = true; else NeedToDownload = false; if (FillType == ApplyToObject || FillType == ApplyToObjectAsTransp) { SelRange* Sel = GetApplication()->FindSelection(); if (Sel==0) { ERROR3("Can't find SelRange!"); return false; } if (NeedToDownload) { Node *NodeToFill = Sel->FindFirst(); if (Sel->FindNext(NodeToFill) != 0) { // If mulitple objects are selected, saving the tag of just one object is not // going to do much good so for now we just give up in this case InformError(_R(IDE_SGLFILLS_NOMULTI_DL_FILL)); return false; } if (NodeToFill) TagObjectToFill = NodeToFill->GetTag(); else { // No node selected. This means the user has pressed fill from the gallery // with no selection, intending to set the default fill of the document. To // do this we set TagObjectToFill to zero which results in TagObjectValid not // being set. We do not have to use this logic in the case where the fill is // already downloaded as the ApplyFill(...) stuff just uses the current selection // (or the lack of current selection). TagObjectToFill = 0; } } } // Calculate where to put an imported object DocCoord DropPos; DocRect PageRect; Spread *s; if ((s = Document::GetSelectedSpread()) != 0) { if (s->GetPagesRect(&PageRect)) DropPos = PageRect.Centre(); else return false; } else return false; if (!NeedToDownload) // Don't need to download the fill { TRACEUSER( "Jonathan", _T("Fills: File in cache\n")); OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(OpBitmapImport)); if (pOpDesc != 0) { BitmapImportParam Param; Param.File = &FileName; Param.Result = TRUE; Param.pTargetDoc = Document::GetSelected(); Param.FillType = FillType; Param.pSpread = Document::GetSelectedSpread(); Param.DropPos = DropPos; Param.TagObjectValid = false; Param.pObjectValid = false; // Do it... pOpDesc->Invoke((OpParam *) &Param); if (!Param.Result) { ERROR3("Problem importing file from cache"); return false; } } } else // Need to download the fill { TRACEUSER( "Jonathan", _T("Fills: File not in cache : downloading\n")); OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(OpAsynchBitmapImport)); if (pOpDesc != 0) { AsynchBitmapImportParam* Param = new AsynchBitmapImportParam; if (!Param) return false; Library* pLibrary = FillItem->GetParentLibrary(); String_256 strFileURL = FileName.GetPath(); pLibrary->LocalPath2URL(&strFileURL); Param->file = FileName; Param->pTargetDoc = Document::GetSelected(); Param->strURL = strFileURL; String_256 strDescription; FillItem->GetNameText(&strDescription); Param->strDescription = _T("'"); Param->strDescription += strDescription; Param->strDescription += _T("'"); Param->type = TYPE_FILL; Param->FillType = FillType; Param->priority = AsynchDownload::PRIORITY_HIGH; Param->pSpread = Document::GetSelectedSpread(); Param->DropPos = DropPos; Param->TagObjectToFill = TagObjectToFill; Param->pObjectValid = false; // If TagObjectToFill == 0, don't set pObjectValid or TagObjectValid so // ApplyFill(...) just applies the fill to nothing (except if the user has // changed the selection during the download, in which case that object will // get filled - bit bad, but that is a very rare case). if (TagObjectToFill) Param->TagObjectValid = true; else Param->TagObjectValid = false; // Do it... pOpDesc->Invoke((OpParam *) Param); } } return true; }

OpState LibFillsSGallery::GetCommandState (  StringBase *  CommandID, String_256 *  ShadeReason )  [virtual]

To determine the state of a given menu item. This method is an exact parallel to an Op's GetState method (in fact, it is called by an Op's GetState). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/95 Parameters: CommandID  - TheString ID of the command [INPUTS] ShadeReason  - If you return (OpState.Greyed == TRUE) then this should be filled [OUTPUTS] ion with the reason that the item is shaded/greyed. Returns: An OpState indicating the current menu item state. Notes: Override this method to provide state info for your special commands Call the base class for unknown commands to allow it to handle them for you The base class handles all of these (maybe more - see the base class help) Properties, Sort, Find; New, Edit, Delete, Redefine; NextGroup, PrevGroup, FoldGroup, UnfoldGroup; Reimplemented from SuperGallery. Definition at line 1344 of file sglfills.cpp. { TRACEUSER( "Jonathan", _T("Fills::GetCommandState called for ")); TRACEUSER("Jonathan", *CommandID); TRACEUSER( "Jonathan", _T("\n")); OpState State; if (*CommandID == SGCmd_Add) // --- Add (always available) { return(State); } else if (*CommandID == SGCmd_EmptyFillsCache) { if (m_bDiscardWebFolders) State.Greyed = TRUE; return (State); } else if (*CommandID == SGCmd_Fill || *CommandID == SGCmd_Transp || // --- Fill/Transp/Set Background/Import *CommandID == SGCmd_SetBackground || *CommandID == SGCmd_Import) { if (GetSelectedItemCount() != 1) { State.Greyed = TRUE; ShadeReason->MakeMsg(_R(IDS_SGSHADE_SINGLE)); } } else if (*CommandID == SGCmd_Remove) // --- Remove { if (GetSelectedGroupCount() < 1) { State.Greyed = TRUE; ShadeReason->MakeMsg(_R(IDS_SGSHADE_NOSELGROUP)); } } else return(SuperGallery::GetCommandState(CommandID, ShadeReason)); // Unknown command- pass to baseclass return(State); }

virtual String_256* LibFillsSGallery::GetDefaultLibraryPath (   )  [inline, virtual]

Reimplemented from LibraryGallery. Definition at line 186 of file sglfills.h. {return &DefaultLibraryPath;}

BOOL LibFillsSGallery::GetDefaults (  String_256 *  DefaultIndex, String_256 *  IndexDesc, SGLibType *  Type )  [virtual]

To determine various library gallery default properties. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 18/12/95 Parameters: DefaultIndex  - The filename for the default index file (Xaraclip.txt) [OUTPUTS] IndexDesc - Description of the index / gallery (Clipart) Type - Default library type associated with this gallery Returns: TRUE if this was overridden successfully Reimplemented from LibraryGallery. Definition at line 393 of file sglfills.cpp. { if(DefaultIndex != NULL) *DefaultIndex = _R(IDS_LIBRARIES_FILLS_FILENAME); // "XaraText.txt"; if(IndexDesc != NULL) *IndexDesc = _R(IDS_LIBRARIES_FILLS_DESC); // "Fills"; if(Type != NULL) *Type = SGLib_Texture; return TRUE; }

virtual SGLibType LibFillsSGallery::GetGalleryType (   )  [inline, virtual]

Reimplemented from LibraryGallery. Definition at line 184 of file sglfills.h. { return SGLib_Fractal;}

BOOL LibFillsSGallery::GetLibraryDirectoryName (  String_256 *  LibDirName  )  [virtual]

Get the default CD directory name for the gallery. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 19/12/95 Parameters: LibDirName  - Returns the Default directory (on the clipart CD) for the gallery [OUTPUTS] Returns: TRUE if overridden and directory obtained... Reimplemented from LibraryGallery. Definition at line 422 of file sglfills.cpp. { LibDirName->MakeMsg(_R(IDS_LIBRARIES_FILLS_DIRNAME)); return TRUE; }

BOOL LibFillsSGallery::GetQuietStatus (  void   )  [virtual]

Get the Quiet status of the gallery. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 19/12/95 Returns: TRUE if Quiet has been pressed (SetQuiet status called with TRUE) Reimplemented from LibraryGallery. Definition at line 439 of file sglfills.cpp. { return LibFillsSGallery::QuietStatus; }

KernelBitmap* LibFillsSGallery::GetSelectedBitmap (  void   )  [protected]

void LibFillsSGallery::HandleDragStart (  DragMessage *  DragMsg  )  [protected, virtual]

Checks a DragMessage to see if it is a colour drag. If it is, then it creates a drag target for this gallerys listbox. Author: Will_Cowling (Xara Group Ltd) <camelotdev@xara.com> Date: 25/3/95 Parameters: DragMsg  - The DRAGSTARTED message that we've just recieved, indicating [INPUTS] the type of drag being started Notes: Overrides the default base-class action. Calls down to the base class if it is not a colour drag, so that dragging of gallery groups is allowed Reimplemented from LibraryGallery. Definition at line 1170 of file sglfills.cpp. { // If it's a bitmap drag, add a target for our window. If not, let the base class // have a look at it (to see if it is a gallery item being dragged) if (DragMsg->pInfo->IsKindOf(CC_RUNTIME_CLASS(GalleryFillsDragInfo))) SGFillsDragTarget *NewTarget = new SGFillsDragTarget(this, GetListGadgetID()); else SuperGallery::HandleDragStart(DragMsg); }

BOOL LibFillsSGallery::Init (  void   )  [static]

Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 23/3/95 Returns: TRUE if the sgallery initialised successfully FALSE if it failed to initialise Reimplemented from SimpleCCObject. Definition at line 244 of file sglfills.cpp. { return(TRUE); }

BOOL LibFillsSGallery::InitMenuCommands (  void   )  [virtual]

Initialises any menu commands that this gallery needs. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 18/9/95 Returns: TRUE for success Notes: Will only create the menu commands once - further calls in the future will return TRUE immediately wihtout doing anything. Reimplemented from SuperGallery. Definition at line 1217 of file sglfills.cpp. { static BOOL MenusInitialised = FALSE; BOOL ok = TRUE; if (!MenusInitialised) { // Initialise menu command Ops // "Standard" entries for options menu ok = ok && InitMenuCommand((StringBase *) &SGCmd_Find, _R(IDS_SGMENU_FIND)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Sort, _R(IDS_SGMENU_SORT)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Properties, _R(IDS_SGMENU_PROPERTIES)); // "Special" entries for options menu ok = ok && InitMenuCommand((StringBase *) &SGCmd_Add, _R(IDS_SGMENU_ADDFILL)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_EmptyFillsCache, _R(IDS_SGMENU_EMPTYFILLCACHE)); // "Special" entries for over-list menu ok = ok && InitMenuCommand((StringBase *) &SGCmd_Import, _R(IDS_SGMENU_IMPORT)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Fill, _R(IDS_SGMENU_FILL)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Transp, _R(IDS_SGMENU_TRANSP)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_SetBackground, _R(IDS_SGMENU_SETBACKGROUND)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Download, _R(IDS_SGMENU_DOWNLOAD)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Remove, _R(IDS_SGMENU_REMOVE)); // "Standard" commands for over-list menu ok = ok && InitMenuCommand((StringBase *) &SGCmd_FoldGroup, _R(IDS_SGMENU_FOLD)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_UnfoldGroup, _R(IDS_SGMENU_UNFOLD)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_NextGroup, _R(IDS_SGMENU_NEXTGROUP)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_PrevGroup, _R(IDS_SGMENU_PREVGROUP)); MenusInitialised = TRUE; } return(ok); }

virtual BOOL LibFillsSGallery::IsLibraryGalleryWithNonLibraryGroups (  void   )  [inline, virtual]

To check if we're a dedicated library gallery, or a half+half (like the font gallery). Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 19/12/95 Returns: TRUE if the SuperGallery is a LibraryGallery, yet also can contain non-library groups Reimplemented from LibraryGallery. Definition at line 143 of file sglfills.h. {return TRUE;};

MsgResult LibFillsSGallery::Message (  Msg *  Message  )  [virtual]

A standard message handler, really. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 23/3/95 Parameters: Message  - The message to handle [INPUTS] Notes: Any messages that this does not handle must be passed down to the SuperGallery base class message handler. NOTE WELL that the SuperGallery base class handler does some funky things for us - see SuperGallery::Message - such as deleting our display subtree for any document which dies (which, uncannily, would explain why they go away like that when you close documents ;-), and shading the gallery when there are no documents present. [To override this behaviour in these cases, you should respond to the message, and return OK rather than calling the base class message handler] See also: SuperGallery::Message Reimplemented from LibraryGallery. Definition at line 658 of file sglfills.cpp. { // Added by Craig Hamilton 18/1/01. static HANDLE handle = NULL; CString mutexName = "autorunMutex"; // End added. // If we have no displaytree, then we have not been shown, or something terrible has // happened, so we don't bother handling any of these messages. if (DisplayTree == NULL) return(LibraryGallery::Message(Message)); KernelBitmap *SelectedBitmap = NULL; if (IS_OUR_DIALOG_MSG(Message)) { DialogMsg* Msg = (DialogMsg*)Message; switch (Msg->DlgMsg) { case DIM_CREATE: // Added by Craig Hamilton 18/1/01. // This and the section of code of the same date in the DIM_CANCEL handler below // deal with the creation and destruction of a kernel object that is recognised by // the autorun. If this object exists then the autorun does not run. This is so // that the user can enter their resources cd while the gallery is open and not be // annoyed by the autorun appearing. handle = CreateMutex(NULL,TRUE,mutexName); // End added. SGInit::UpdateGalleryButton(OPTOKEN_DISPLAYFILLSGALLERY, TRUE); LibFillsSGallery::ThisGallery->GalleryAboutToReOpen(); break; case DIM_CANCEL: // Added by Craig Hamilton 18/1/01. if(handle != NULL) { CloseHandle(handle); } // End added. SGInit::UpdateGalleryButton(OPTOKEN_DISPLAYFILLSGALLERY, FALSE); // Flush the thumbnail cache BROADCAST_TO_CLASS(ThumbMessage(ThumbMessage::ThumbState::KILLCACHE, SGLib_Texture), DialogOp); BROADCAST_TO_CLASS(ThumbMessage(ThumbMessage::ThumbState::KILLCACHE, SGLib_Fractal), DialogOp); GalleryAboutToClose(); break; case DIM_LFT_BN_CLICKED: switch (Msg->GadgetID) { case _R(IDC_LIBGAL_OPEN): if(Document::GetSelected() != NULL) FillUsingFillGallerySelection(AddToPage); break; case _R(IDC_LIBGAL_IMPORT): FillUsingFillGallerySelection(AddToPage); break; case _R(IDC_LIBGAL_BROWSE): case _R(IDC_LIBGAL_ADD_FILLS): BrowseClicked(); break; case _R(IDC_BMPGAL_FILL): if(!FillUsingFillGallerySelection(ApplyToObject)) { return(SuperGallery::Message(Message)); } break; case _R(IDC_BMPGAL_TEXTURE): if(Document::GetSelected() != NULL) if(!FillUsingFillGallerySelection(ApplyToObjectAsTransp)) { return(SuperGallery::Message(Message)); } break; case _R(IDC_BMPGAL_BACKGROUND): if(Document::GetSelected() != NULL) if(!FillUsingFillGallerySelection(SetBackground)) { return(SuperGallery::Message(Message)); } break; case _R(IDC_BMPGAL_SAVE): #ifdef _DEBUG { SGDisplayNode *Item = DisplayTree->FindNextSelectedItem(NULL); if(Item != NULL && Item->IsKindOf(CC_RUNTIME_CLASS(SGLibDisplayItem))) { SGLibDisplayItem *LibItem = (SGLibDisplayItem *)Item; Library *Parent = LibItem->GetParentLibrary(); if(Parent != NULL) { PathName *Source = Parent->ReturnIndexLocation(); PathName Dest(*Source); Dest.SetType((String_256)"BAK"); SGLibOil::FileCopy(Source, &Dest); Parent->SaveIndexInDisplayedOrder(Source, TRUE); } } } #endif break; case _R(IDC_GALLERY_HELP): // Show help page HelpUserTopic(_R(IDS_HELPPATH_Gallery_Fill)); break; default: break; } } } else if (MESSAGE_IS_A(Message, DocChangingMsg)) { DocChangingMsg *Msg = (DocChangingMsg *) Message; switch (Msg->State) { case DocChangingMsg::DocState::SELCHANGED: if (Msg->pNewDoc == NULL) { // There is no selected doc - this can only mean there are no docs // at all, so we had better shade the gallery DoShadeGallery(TRUE); SuperGallery::ShadeGallery(TRUE); } else { // Possibly a new document DoShadeGallery(FALSE); SuperGallery::ShadeGallery(FALSE); SelectionHasChanged(); } break; } } else if (MESSAGE_IS_A(Message, ThumbMessage) && DisplayTree != NULL) { ThumbMessage *Msg = (ThumbMessage *) Message; // If a library Thumb message comes around, flush the redraw stuff, etc if(Msg->State == ThumbMessage::ThumbState::CACHESIZECHANGED) { FlushBackgroundRedraws(); ForceRedrawOfList(); } } return(LibraryGallery::Message(Message)); }

BOOL LibFillsSGallery::PreCreate (  void   )  [protected, virtual]

The LibFillsSGallery PreCreate handler. This overrides the base class PreCreate function. It is called at the very beginning of the SuperGallery::Create method, before the window has been created. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 23/3/95 Returns: TRUE if the Gallery initialised successfully FALSE if it should not be opened due to a failure to initialise Notes: As this is called before the window is open, it must not attempt to touch any of the button gadgets in the window, or force redraws, etc. Also, events cannot be passed to the tree, as the tree formatting relies on knowing the window size - however, the tree will be reformatted and redrawn automatically when the window is opened - this will happen shortly. Reimplemented from LibraryGallery. Definition at line 272 of file sglfills.cpp. { // If there isn't already one, create a DisplayTree if (DisplayTree == NULL) { DisplayTree = new SGDisplayRootScroll(this); // New root node, with a scrollbar if (DisplayTree == NULL) return(FALSE); } // Add the library groups to the gallery if they're not there already if(OpenLibFiles.IsEmpty()) { String_256 sLoc = DefaultLibraryPath; // Set DefaultLibraryPath to <ExeLocation>\Fills - the user might have installed // the fills to his hard disk: if(CResDll::GetExecutablePath((TCHAR*)DefaultLibraryPath)) { // Look for the resources in the main Xara X folder first String_256 LibDirName; GetLibraryDirectoryName(&LibDirName); DefaultLibraryPath += "\\"; DefaultLibraryPath += LibDirName; PathName ThisPath(DefaultLibraryPath); if(!SGLibOil::FileExists(&ThisPath)) // will also work for paths (not just paths with a filename on the end) { // Fills not on hard disk. Try the CD location if(!ScanForLocation(SGLib_Texture, NULL)) { // hard drive and CD location not found // put the original path back DefaultLibraryPath = sLoc; } } } LibraryGallery::AddLibraryGroups(SGLib_Texture, &DefaultLibraryPath); } // Use last time's display mode DisplayMode = LibFillsSGallery::DefaultDisplayMode; return TRUE; }

BOOL LibFillsSGallery::ScanForLocation (  SGLibType  Type, StringBase *  Result )  [virtual]

Searches all the drives for a CDROM drive. If it finds the Camelot CD mount here at Xara HQ, we point to that instead. Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 19/12/95 Parameters: Type  of library to scan for [INPUTS] (We  assume the library static strings exist and use them - bit yucky) [OUTPUTS] If a Result pointer if given then we copy this into there as well.. Returns: FALSE if it fails; TRUE if we got a path Reimplemented from LibraryGallery. Definition at line 479 of file sglfills.cpp. { #ifndef STANDALONE // Search for a CD ROM drive String_256 DriveName; BOOL AreWeXara = FALSE; String_256 XaraDrive; BOOL Adjust = KeyPress::IsAdjustPressed(); #ifndef _DEBUG Adjust = FALSE; #endif if(SGLibOil::LocateCDROMDrive(this, Type, &DriveName, &AreWeXara, &XaraDrive, Adjust)) { if(AreWeXara) DriveName = XaraDrive; switch(Type) { case SGLib_Texture: case SGLib_Fractal: LibFillsSGallery::DefaultLibraryPath = DriveName; #ifdef _DEBUG if(Adjust) { LibFillsSGallery::DefaultLibraryPath += TEXT("Graphics\\Fills"); } else #endif { String_256 LibDirName; GetLibraryDirectoryName(&LibDirName); LibFillsSGallery::DefaultLibraryPath += LibDirName; } if(Result) *Result = LibFillsSGallery::DefaultLibraryPath; return TRUE; } } #endif return FALSE; }

void LibFillsSGallery::SelectionHasChanged (  void   )  [virtual]

To inform the gallery that the selection has changed in some way. We need to grey different buttons on different occasions Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> (based on Jason code) Date: 28/3/95 Reimplemented from LibraryGallery. Definition at line 834 of file sglfills.cpp. { if (DisplayTree == NULL) return; // As we now allow the gallery to be closed and all the groups to remain, we must now // also check to see if the gallery is visible i.e. open or not. If not then get out now. // Required as SetStringGadgetValue will ERROR and memory leak if called when dialog closed. if (!IsVisible()) return; INT32 Count = DisplayTree->GetSelectedItemCount(); BOOL Documents = (Document::GetSelected() != NULL); // Set up button states // Enable the import button if there is a selection and valid documents EnableGadget(_R(IDC_LIBGAL_IMPORT), (Count > 0) && Documents); String_256 strCommand, strDummy; BOOL bEnable = Count == 1 && Documents; // Import button strCommand = SGCmd_Import; EnableGadget(_R(IDC_LIBGAL_IMPORT), bEnable && !((GetCommandState(&strCommand, &strDummy)).Greyed)); // Fill button strCommand = SGCmd_Fill; EnableGadget(_R(IDC_BMPGAL_FILL), bEnable && !((GetCommandState(&strCommand, &strDummy)).Greyed)); // Transp button strCommand = SGCmd_Transp; EnableGadget(_R(IDC_BMPGAL_TEXTURE), bEnable && !((GetCommandState(&strCommand, &strDummy)).Greyed)); // Background button strCommand = SGCmd_SetBackground; EnableGadget(_R(IDC_BMPGAL_BACKGROUND), bEnable && !((GetCommandState(&strCommand, &strDummy)).Greyed)); EnableGadget(_R(IDC_LIBGAL_ADD_FILLS), TRUE); LibraryGallery::SelectionHasChanged(); }

void LibFillsSGallery::SetQuietStatus (  BOOL  Status  )  [virtual]

Set the Quiet status of the gallery. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 19/12/95 Parameters: Status  - Set to TRUE and call if Quiet has just been pressed on an 'adding [INPUTS] indexes' dialog Reimplemented from LibraryGallery. Definition at line 456 of file sglfills.cpp. { LibFillsSGallery::QuietStatus = Status; }

void LibFillsSGallery::SortGallery (  void   )  [protected, virtual]

Sorts the contents of the gallery in an alphabetical fashion, whilst keeping the old sort key status... Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 2/5/95 Parameters: [INPUTS]  Returns: See also: Reimplemented from LibraryGallery. Definition at line 334 of file sglfills.cpp. { LibraryGallery::SortGallery(); }

void LibFillsSGallery::WorkOutSectionName (  String_256 *  Section  )  [virtual]

Returns the section name to use in the grm file. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 28/5/95 Parameters: Section  - String used to return the section name [OUTPUTS] Reimplemented from LibraryGallery. Definition at line 1193 of file sglfills.cpp. { if(Section) *Section = _R(IDS_SGLFILLS_SECTION_NAME); // "FillsGallery"; }

---

Member Data Documentation

INT32 LibFillsSGallery::DefaultDisplayMode = 0 [static]

Definition at line 245 of file sglfills.h.

String_256 LibFillsSGallery::DefaultLibraryPath = TEXT("D:\\fills") [static]

Definition at line 242 of file sglfills.h.

UINT32 LibFillsSGallery::DefaultSortKeys = 1 [static]

Definition at line 248 of file sglfills.h.

BOOL LibFillsSGallery::QuietStatus = FALSE [static]

Definition at line 255 of file sglfills.h.

LibFillsSGallery * LibFillsSGallery::ThisGallery = NULL [static]

Definition at line 252 of file sglfills.h.

---

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

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

---