SGallerySearchDlg Class Reference

#include <sgallery.h>

Inheritance diagram for SGallerySearchDlg:

List of all members.

Public Member Functions
	SGallerySearchDlg ()
	Constructor.
	~SGallerySearchDlg ()
	destructor
MsgResult	Message (Msg *Message)
	Standard DialogOp message handler, for the Gallery display dialogue.
void	Do (OpDescriptor *)
	'Does' a gallery display dialogue op. DO NOT call this method - it must be invoked via DoWithParam
void	DoWithParam (OpDescriptor *, OpParam *Param)
	'Does' a gallery display dialogue op. Shows the dialogue.
BOOL	Create ()
	Creates a gallery display dialogue box.
Static Public Member Functions
static BOOL	Init ()
	Initialises the colour sort dialogue op.
static OpState	GetState (String_256 *, OpDescriptor *)
	Get the state of the Colour sort dialogue op.
static void	InvokeDialog (SuperGallery *Parent)
	Creates a new instance of this dialogue type, connects it to the given gallery, and opens the dialogue on screen.
Static Public Attributes
static const UINT32	IDD = _R(IDD_SGSEARCH)
static const CDlgMode	Mode = MODELESS
Protected Member Functions
void	InitValues (void)
	Initialises the gallery display dialogue, and sets its controls Scope: private.
void	SetControls (void)
	(Re)Initialises the colour manager dialogue controls (This simply sets the combo boxes etc up from the current settings)
void	Search (BOOL FindFirst)
	Applies the current settings in the dialogue to its parent gallery. Searches for the first/next matching gallery item. Selects the matched item. Search for next searches from the first selected item onwards. Search is case insensitive.
SGDisplayItem *	SearchFindNextItem (SGDisplayItem *LastItem, Progress *Hourglass=NULL)
	Get the next item to compare.
SGDisplayItem *	SearchFindStartItem (BOOL FindFirst)
	Get the first item to start the search with.
BOOL	DoComparison (SGDisplayItem *Item, StringBase *SearchText, BOOL UseKeywords=FALSE, BOOL ItsALibrary=FALSE, BOOL FullInfo=FALSE)
	The search routine's main comparison point. All items will go through this, so it must be fairly speedy in operation.
Protected Attributes
SuperGallery *	ParentGallery
Static Protected Attributes
static BOOL	LastSearchFullInfo = FALSE
static String_64	LastSearchText

---

Detailed Description

Definition at line 858 of file sgallery.h.

---

Constructor & Destructor Documentation

SGallerySearchDlg::SGallerySearchDlg (   )

Constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Definition at line 4693 of file sgallery.cpp. : DialogOp(SGallerySearchDlg::IDD, SGallerySearchDlg::Mode) { ParentGallery = NULL; }

SGallerySearchDlg::~SGallerySearchDlg (   )

destructor Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Definition at line 4712 of file sgallery.cpp. { if (ParentGallery != NULL) ParentGallery->CurrentSearchDlg = NULL; }

---

Member Function Documentation

BOOL SGallerySearchDlg::Create (  void   )  [virtual]

Creates a gallery display dialogue box. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Returns: FALSE if it fails Reimplemented from DialogOp. Definition at line 5327 of file sgallery.cpp. { ERROR3IF(ParentGallery == NULL, "My ParentGallery is NULL!"); if (DialogOp::Create()) { ParentGallery->CurrentSearchDlg = this; InitValues(); return(TRUE); } return(FALSE); }

void SGallerySearchDlg::Do (  OpDescriptor *   )  [virtual]

'Does' a gallery display dialogue op. DO NOT call this method - it must be invoked via DoWithParam Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Parameters: OPDescriptor  - the Opdescriptor for this op [INPUTS] Notes: To show this dialogue you should call InvokeDialog See also: SGallerySearchDlg::InvokeDialog Reimplemented from Operation. Definition at line 5361 of file sgallery.cpp. { ERROR3("SGallerySearchDlg - You must use DoWithParam (Call InvokeDialog)"); End(); }

BOOL SGallerySearchDlg::DoComparison (  SGDisplayItem *  Item, StringBase *  SearchText, BOOL  UseKeywords = FALSE, BOOL  ItsALibrary = FALSE, BOOL  FullInfo = FALSE )  [inline, protected]

The search routine's main comparison point. All items will go through this, so it must be fairly speedy in operation. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 30/1/96 Parameters: Item  - The item which we want comparing with the string [INPUTS] SearchText - The string which we want comparing with the item UseKeywords - Should we check keywords too ? ItsALibrary - Are we a library item ? FullInfo - Is this q quick search, or a full info search ? Returns: True if we have a match, false otherwise Definition at line 5102 of file sgallery.cpp. { String_256 ItemText; // Set these if we did a quick compare via TCHAR *'s... BOOL CheckedTitle = FALSE; BOOL CheckedFilename = FALSE; #if 0 // If we are a library, we can use SpeedSearch(TM) technology... // Note that this won't do wildcard searches, but if we don't match, we do normal, slow, // searching later on... CheckedTitle = CheckedFilename = FALSE; if (ItsALibrary) { TCHAR *pSpeedyResult; BOOL CouldGetPointer = ((SGLibDisplayItem *)Item)->GetNameTextPtr(&pSpeedyResult); if (CouldGetPointer) { // Compare two title TCHAR *'s... if(CompareString(LOCALE_USER_DEFAULT, (NORM_IGNORECASE|NORM_IGNOREKANATYPE|NORM_IGNOREWIDTH), pSpeedyResult, -1, (TCHAR *)LastSearchText, -1) == 2) return TRUE; CheckedTitle = TRUE; } CouldGetPointer = ((SGLibDisplayItem *)Item)->GetFileNamePtr(&pSpeedyResult); if(CouldGetPointer) { // Compare two filename TCHAR *'s... if(CompareString(LOCALE_USER_DEFAULT, (NORM_IGNORECASE|NORM_IGNOREKANATYPE|NORM_IGNOREWIDTH), pSpeedyResult, -1, (TCHAR *)LastSearchText, -1) == 2) return TRUE; CheckedFilename = TRUE; } } #endif // Check normal name if(!CheckedTitle) { Item->GetNameText(&ItemText); ItemText.toLower(); if (ItemText.Sub(*SearchText, 0, TCHAR('*')) >= 0) return TRUE; } // Check filenames if told to if (ItsALibrary && !CheckedFilename) { ((SGLibDisplayItem *)Item)->GetFileName(&ItemText); ItemText.toLower(); if (ItemText.Sub(*SearchText, 0, TCHAR('*')) >= 0) return TRUE; } // For galleries which support it, check keywords if (UseKeywords) { Item->GetKeyWords(&ItemText); ItemText.toLower(); // Check if there's a possibility of the string matching before the absolute check if (ItemText.Sub(*SearchText, 0, TCHAR('*')) >= 0) { // ItemText will be a string such as 'bat |animal|bird| mammal' // 'LastSearchText' will be a string such as 'animal' // We need to check whole words, so that 'nima' won't provide a match // change ItemText to be: '|bat||animal|bird||mammal|', then search for '|animal|' if (GenerateIndexFile::ReplaceCharacters(&ItemText, ' ', '|')) { String_256 NewItemText; NewItemText = _T("|"); NewItemText += ItemText; NewItemText += _T("|"); String_256 NewSearchText; NewSearchText = _T("|"); NewSearchText += *SearchText; NewSearchText += _T("|"); if (NewItemText.Sub(NewSearchText, 0, TCHAR('*')) >= 0) return TRUE; } } } // Check text in full info modes if (FullInfo) { Item->GetFullInfoText(&ItemText); ItemText.toLower(); if (ItemText.Sub(*SearchText, 0, TCHAR('*')) >= 0) return TRUE; } return FALSE; }

void SGallerySearchDlg::DoWithParam (  OpDescriptor *  , OpParam *  Param )  [virtual]

'Does' a gallery display dialogue op. Shows the dialogue. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Parameters: Bob  - the Opdescriptor for this op [INPUTS] Param - The parameter. Must point at a GalDlgParam object Notes: To show this dialogue you should call InvokeDialog See also: SGallerySearchDlg::InvokeDialog Reimplemented from Operation. Definition at line 5386 of file sgallery.cpp. { ERROR3IF(Param == NULL, "Null parameters are illegal"); ParentGallery = ((GalDlgParam *)Param)->ParentGal; ERROR3IF(ParentGallery == NULL, "SGallerySearchDlg needs a non-NULL parent gallery!"); if (ParentGallery != NULL && Create()) Open(); else End(); }

OpState SGallerySearchDlg::GetState (  String_256 *  , OpDescriptor *  )  [static]

Get the state of the Colour sort dialogue op. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 5276 of file sgallery.cpp. { OpState OpSt; return(OpSt); }

BOOL SGallerySearchDlg::Init (  void   )  [static]

Initialises the colour sort dialogue op. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from SimpleCCObject. Definition at line 5299 of file sgallery.cpp. { return (RegisterOpDescriptor( 0, _R(IDS_SGSEARCHDLG), CC_RUNTIME_CLASS(SGallerySearchDlg), OPTOKEN_SGSEARCHDLG, SGallerySearchDlg::GetState, _R(IDST_GALLERY_MENU), // Status line help **** !!!! _R(IDBBL_GALLERY_MENU), // Bubble help **** !!!! 0 /* bitmap ID */ )); }

void SGallerySearchDlg::InitValues (  void   )  [protected]

Initialises the gallery display dialogue, and sets its controls Scope: private. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 See also: SGallerySearchDlg::SetControls Definition at line 4734 of file sgallery.cpp. { if (ParentGallery == NULL) { ERROR3("SGallerySearchDlg MUST be given a valid parent pointer"); return; } // Fill in the combo boxes etc with the current settings SetControls(); }

void SGallerySearchDlg::InvokeDialog (  SuperGallery *  Parent  )  [static]

Creates a new instance of this dialogue type, connects it to the given gallery, and opens the dialogue on screen. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Parameters: Parent  - the parent (owner) of this display dialogue. This pointer [INPUTS] is used to inform the parent of changes to display/sort modes. May NOT be NULL. Definition at line 4764 of file sgallery.cpp. { if (Parent->CurrentSearchDlg != NULL) // There's one already open! { // Bring it to the front of the window stack, then return Parent->CurrentSearchDlg->BringToTop(); return; } GalDlgParam GalSearchInfo(Parent); OpDescriptor *Dlg = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(SGallerySearchDlg)); ERROR3IF(Dlg == NULL, "I can't find the Dialog OpDescriptor"); if (Dlg != NULL) Dlg->Invoke(&GalSearchInfo); }

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

Standard DialogOp message handler, for the Gallery display dialogue. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Parameters: Msg  - The dialogue manager message to handle [INPUTS] Returns: A MsgResult Reimplemented from DialogOp. Definition at line 5219 of file sgallery.cpp. { if (!(IS_OUR_DIALOG_MSG(Message))) return DialogOp::Message(Message); DialogMsg* TheMsg = (DialogMsg*)Message; switch(TheMsg->DlgMsg) { case DIM_CREATE: SetKeyboardFocus (_R(IDC_SGSEARCH_TEXT)) ; HighlightText (_R(IDC_SGSEARCH_TEXT)) ; break ; case DIM_COMMIT: // OK clicked case DIM_SOFT_COMMIT: // OK "adjust clicked" Search(FALSE); // The 'OK' button ('Find Next') does not close the dialogue - it will stay // open until the user explicitly chooses 'Close'. break; case DIM_CANCEL: // Cancel clicked Close(); End(); return OK; break; case DIM_LFT_BN_CLICKED: if (TheMsg->GadgetID == _R(IDC_SGSEARCH_FINDFIRST)) Search(TRUE); break; default: break; } return DialogOp::Message(Message); return OK; }

void SGallerySearchDlg::Search (  BOOL  FindFirst  )  [protected]

Applies the current settings in the dialogue to its parent gallery. Searches for the first/next matching gallery item. Selects the matched item. Search for next searches from the first selected item onwards. Search is case insensitive. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Parameters: FindFirst  TRUE = Find first, FALSE = Find next [INPUTS] Notes: Shows an hourglass during the search, and aborts if escape is pressed. Definition at line 4832 of file sgallery.cpp. { if(ParentGallery == NULL) { ERROR3("No parent gallery!"); return; } BOOL Valid = FALSE; String_256 SearchText = GetStringGadgetValue(_R(IDC_SGSEARCH_TEXT), &Valid); if(!Valid) return; // Truncate the search tet into the last-search-text buffer SearchText.Left((StringBase *) &LastSearchText, 63); LastSearchText.toLower(); if(LastSearchText.Length() < 1) { InformWarning(_R(IDE_SGSEARCH_BADTEXT), _R(IDS_OK)); return; } // And remember the last used options for the radio buttons LastSearchFullInfo = GetBoolGadgetSelected(_R(IDC_SGSEARCH_FULLINFO)); // Now, apply the search if(ParentGallery == NULL || ParentGallery->DisplayTree == NULL) return; // Should we use keywords ? BOOL UseKeywords = ParentGallery->CanSearchKeywords(); // Need this if Devirtualising library indexes proves bad... ParentGallery->SetQuietStatus(FALSE); // Find the first selected item (if any) and get the next item to start searching from // If there is no selection, then get the first item SGDisplayItem *Item = SearchFindStartItem(FindFirst); // Work out how many groups we're dealing with... INT32 HourglassCount = -1; if (Item != NULL) { SGDisplayGroup *GroupCountItem = (SGDisplayGroup *)Item->GetParent(); while(GroupCountItem != NULL) { GroupCountItem = (SGDisplayGroup *)GroupCountItem->GetNext(); HourglassCount ++; } } // Start up the hourglass Progress Hourglass(_R(IDS_SGSEARCH_SEARCHING), HourglassCount, TRUE); // This really needs moving out to sglbase sometime soon... BOOL ItsALibrary = ParentGallery->IsLibraryGalleryWithNonLibraryGroups(); // We shouldn't really check for escape for every item INT32 ProgressCounterRate = 30; INT32 ProgressCounter = ProgressCounterRate; // Actually loop through the items and compare each with the given search string while(Item != NULL) { // Possibly update progress indicator; if ESCAPE pressed, abort! if(!(--ProgressCounter)) ProgressCounter = ProgressCounterRate; else if(ProgressCounter == 1 && !Hourglass.Update(Hourglass.GetCount(), TRUE)) { EndSlowJob(); InformMessage(_R(IDE_SGSEARCH_ABORTED), _R(IDS_OK)); return; } if(DoComparison(Item, &LastSearchText, UseKeywords, ItsALibrary, LastSearchFullInfo)) break; if(HourglassCount == -1) Item = SearchFindNextItem(Item, NULL); else Item = SearchFindNextItem(Item, &Hourglass); } if(Item == NULL) { InformMessage(_R(IDE_SGSEARCH_NOMATCH), _R(IDS_OK)); return; } ParentGallery->SelectItems(FALSE); // Clear existing selection Item->Flags.Selected = TRUE; // And select this item Item->ForceRedrawOfMyself(); // Ensuring it redraws itself ParentGallery->ForceGroupFolded((SGDisplayGroup *)Item->GetParent(), FALSE); DocRect ScrollToRect; Item->GetFormatRect(&ScrollToRect); ParentGallery->ScrollToShow(&ScrollToRect); // Scroll to make seln visible on screen ParentGallery->SelectionHasChanged(); // Update gallery for the new selection }

SGDisplayItem * SGallerySearchDlg::SearchFindNextItem (  SGDisplayItem *  LastItem, Progress *  Hourglass = NULL )  [inline, protected]

Get the next item to compare. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> / Jason Date: 30/1/96 Parameters: LastItem  - The last item we compared [INPUTS] Hourglass - Optional Progress bar which will be incremented when jumping groups Returns: The next item to compare Definition at line 4958 of file sgallery.cpp. { SGDisplayNode *Item = LastItem; if (Item->GetNext() == NULL) // Skip to next group { ERROR3IF(Item->GetParent() == NULL, "Tree linkage corruption"); // Make Item = Next group if (Item->GetParent()->GetNext() != NULL) Item = Item->GetParent()->GetNext(); else Item = NULL; BOOL DevirtualisedGroups = FALSE; // Skip through groups until we find one with items while(Item != NULL && Item->GetChild() == NULL) { BOOL DeVirted = FALSE; if(((SGDisplayGroup *)Item)->IsVirtualised()) DeVirted = ((SGDisplayGroup *)Item)->DeVirtualise(); // Update the progress bar for each group jumped if(Hourglass) Hourglass->GetCount(1); DevirtualisedGroups = TRUE; if(!DeVirted) Item = Item->GetNext(); } if(!DevirtualisedGroups && Hourglass) { // We jumped a group, but didn't bother with devirtualising stuff, because // we didn't need to, so update the progress bar Hourglass->GetCount(1); } // Get first item in new group if(Item != NULL) Item = Item->GetChild(); // Always get the first item in a group } else Item = Item->GetNext(); // Get next sibling item return (SGDisplayItem *)Item; }

SGDisplayItem * SGallerySearchDlg::SearchFindStartItem (  BOOL  FindFirst  )  [inline, protected]

Get the first item to start the search with. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> / Jason Date: 30/1/96 Parameters: FindFirst  - Are we doing a find first or a continue from present position search ? [INPUTS] Returns: The first item to compare Definition at line 5023 of file sgallery.cpp. { SGDisplayNode *Item = ParentGallery->DisplayTree->FindNextSelectedItem(NULL); if (Item == NULL || FindFirst) { Item = ParentGallery->DisplayTree->GetChild(); // Find the first leaf node // Skip through groups until we find one with items while(Item != NULL && Item->GetChild() == NULL) { BOOL DeVirted = FALSE; if(((SGDisplayGroup *)Item)->IsVirtualised()) DeVirted = ((SGDisplayGroup *)Item)->DeVirtualise(); if(!DeVirted) Item = Item->GetNext(); } while (Item != NULL && Item->GetChild() != NULL) Item = Item->GetChild(); } else { // Find next item, skipping to the next group if necessary if (Item->GetNext() == NULL) // Skip to next group { ERROR3IF(Item->GetParent() == NULL, "Tree linkage corruption"); // Make Item = Next group if (Item->GetParent()->GetNext() != NULL) Item = Item->GetParent()->GetNext(); else Item = NULL; // Skip through groups until we find one with items while(Item != NULL && Item->GetChild() == NULL) { BOOL DeVirted = FALSE; if(((SGDisplayGroup *)Item)->IsVirtualised()) DeVirted = ((SGDisplayGroup *)Item)->DeVirtualise(); if(!DeVirted) Item = Item->GetNext(); } // Get first item in new group if(Item != NULL) Item = Item->GetChild(); } else Item = Item->GetNext(); // Get next sibling item } return (SGDisplayItem *)Item; }

void SGallerySearchDlg::SetControls (  void   )  [protected]

(Re)Initialises the colour manager dialogue controls (This simply sets the combo boxes etc up from the current settings) Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/95 Definition at line 4796 of file sgallery.cpp. { if (ParentGallery == NULL) { ERROR3("ParentGallery is NULL!"); return; } // Set the search-text field SetStringGadgetValue(_R(IDC_SGSEARCH_TEXT), LastSearchText); // Set the name-only/full-info radio buttons SetBoolGadgetSelected(_R(IDC_SGSEARCH_NAMEONLY), !(LastSearchFullInfo)); SetBoolGadgetSelected(_R(IDC_SGSEARCH_FULLINFO), LastSearchFullInfo); }

---

Member Data Documentation

const UINT32 SGallerySearchDlg::IDD = _R(IDD_SGSEARCH) [static]

Definition at line 875 of file sgallery.h.

BOOL SGallerySearchDlg::LastSearchFullInfo = FALSE [static, protected]

Definition at line 895 of file sgallery.h.

String_64 SGallerySearchDlg::LastSearchText [static, protected]

Definition at line 896 of file sgallery.h.

const CDlgMode SGallerySearchDlg::Mode = MODELESS [static]

Definition at line 876 of file sgallery.h.

SuperGallery* SGallerySearchDlg::ParentGallery [protected]

Definition at line 882 of file sgallery.h.

---

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

• Kernel/sgallery.h (r1785/r1267)
• Kernel/sgallery.cpp (r1785/r1282)

---