TEMPLATESGallery Class Reference

The TEMPLATE SuperGallery class. More...

#include <sgbase.h>

Inheritance diagram for TEMPLATESGallery:

List of all members.

Public Member Functions
	TEMPLATESGallery ()
	TEMPLATESGallery default constructor.
	~TEMPLATESGallery ()
	TEMPLATESGallery destructor.
virtual MsgResult	Message (Msg *Message)
	A standard message handler, really.
Protected Member Functions
virtual BOOL	PreCreate (void)
	The TEMPLATESGallery 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).
void	CreateNewSubtree (Document *ParentDoc, SGDisplayGroup *ExistingGroup=NULL)
	Internal call. This takes the DATATYPE list of the given document and creates a DisplayTree subtree from it. This subtree is then added to the DisplayTree. Note that this does not force a redraw of the list - after making this call, you should also call ForceRedrawOfList.

---

Detailed Description

The TEMPLATE SuperGallery class.

Author:

Unattributed (Xara Group Ltd) <camelotdev@xara.com> (Based on template code by Jason)

Date:

27/1/95 (Based on the Colour SGallery code)

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; SGDisplayTEMPLATE

Definition at line 212 of file sgbase.h.

---

Constructor & Destructor Documentation

TEMPLATESGallery::TEMPLATESGallery (   )

TEMPLATESGallery default constructor. Author: Unattributed (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Definition at line 490 of file sgbase.cpp. { }

TEMPLATESGallery::~TEMPLATESGallery (   )

TEMPLATESGallery destructor. Author: Unattributed (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Definition at line 506 of file sgbase.cpp. { }

---

Member Function Documentation

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

Applies certain conventional gallery actions (usually associated with gallery buttons, for new, edit, delete, etc). Author: Unattributed (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) 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 SuperGallery. Definition at line 670 of file sgbase.cpp. { // No display tree? Better forget about it then! if (DisplayTree == NULL) return(FALSE); // Determine useful info - this is usually needed for most actions, so always get it Document *SelectedDoc = Document::GetSelected(); SGDisplayGroup *DocumentGroup = DisplayTree->FindSubtree(this, SelectedDoc, NULL); SGDisplayDATATYPE *FirstSelected = NULL; if (DocumentGroup != NULL) FirstSelected = (SGDisplayDATATYPE *) DocumentGroup->FindNextSelectedItem(NULL); // Now, process the action TO DO! - see Colour gallery for examples switch(Action) { case SGACTION_CREATE: TRACE( _T("Unimplemented feature executed in TEMPLATE gallery")); break; case SGACTION_APPLY: TRACE( _T("Unimplemented feature executed in TEMPLATE gallery")); break; case SGACTION_REDEFINE: TRACE( _T("Unimplemented feature executed in TEMPLATE gallery")); break; case SGACTION_EDIT: TRACE( _T("Unimplemented feature executed in TEMPLATE gallery")); break; case SGACTION_DELETE: TRACE( _T("Unimplemented feature executed in TEMPLATE gallery")); break; case SGACTION_DISPLAYMODECHANGED: TRACE( _T("Unimplemented feature executed in TEMPLATE gallery")); break; default: return(FALSE); } return(TRUE); }

void TEMPLATESGallery::CreateNewSubtree (  Document *  ParentDoc, SGDisplayGroup *  ExistingGroup = NULL )  [protected]

Internal call. This takes the DATATYPE list of the given document and creates a DisplayTree subtree from it. This subtree is then added to the DisplayTree. Note that this does not force a redraw of the list - after making this call, you should also call ForceRedrawOfList. Author: Unattributed (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Parameters: ParentDoc  - The document to create a display subtree for [INPUTS] ExistingGroup - NULL (creates a new group for this document), or a pointer to the existing group-node for this document (in which case it clears all displayitems from the group and rebuilds it in place - this stops the display group moving around the tree at random!) Notes: Passing in a NULL parent document pointer results in an ERROR3 - the function returns without doing anything in retail builds See also: SuperGallery::ForceRedrawOfList Definition at line 537 of file sgbase.cpp. { ERROR3IF(ParentDoc == NULL, "TEMPLATESGallery::CreateNewSubtree - NULL parameter passed in"); if (ParentDoc == NULL) return; SGDisplayGroup *DisplayDocument; SGDisplayDATATYPE *DisplayDATATYPE; if (ExistingGroup != NULL) { ERROR3IF(ExistingGroup->GetParentDocument() != ParentDoc, "This group is not for that document! What's going down, dude?"); DisplayDocument = ExistingGroup; // Use existing group DisplayDocument->DestroySubtree(FALSE); // Wipe any existing DATATYPE display items } else { DisplayDocument = new SGDisplayGroup(this, ParentDoc,NULL); // Create new Group if (DisplayDocument == NULL) // Total failure - abort return; DisplayTree->AddItem(DisplayDocument); // Add new group to tree } // **** TO DO **** // Fill in some code here to generate SGDisplayDATATYPEs to be displayed. // e.g: (in PSEUDO code!! ;-) // // DATATYPE *Ptr = ParentDoc->GetDATATYPEList()->GetHead(); // while (Ptr != NULL) // { // DisplayDATATYPE = new SGDisplayDATATYPE(Ptr); // if (DisplayDATATYPE != NULL) // DisplayDocument->AddItem(DisplayDATATYPE); // // Ptr = ParentDoc->GetDATATYPEList()->GetNext(); // } // // // Default : create a few items to display // NOTE: The pointer faked up to pass in to the constructor will cause the thing // to blow up if you start actually trying to USE the data item! Replace this at // earliest convenience with proper tree construction code. for (INT32 Bob = 0; Bob < 7; Bob++) { DisplayDATATYPE = new SGDisplayDATATYPE( (DATATYPE *) 0xcdcdcdcd ); if (DisplayDATATYPE != NULL) DisplayDocument->AddItem(DisplayDATATYPE); } }

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

A standard message handler, really. Author: Unattributed (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) 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 SuperGallery. Definition at line 745 of file sgbase.cpp. { if (IS_OUR_DIALOG_MSG(Message)) { DialogMsg* Msg = (DialogMsg*)Message; switch (Msg->DlgMsg) { case DIM_CREATE: SGInit::UpdateGalleryButton(OPTOKEN_DISPLAYTEMPLATEGALLERY, TRUE); break; case DIM_CANCEL: SGInit::UpdateGalleryButton(OPTOKEN_DISPLAYTEMPLATEGALLERY, FALSE); break; } return(SuperGallery::Message(Message)); } // 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(SuperGallery::Message(Message)); // **** TO DO **** // Just another note: Most galleries ignore most messages when closed (!IsVisible()) // This means that they must re-create themselves properly to get back up to date // when they are opened - this is done in the PostCreate handler. If you wish to // respond to messages to keep up to date while closed, you should address the // default code in the PostCreate handler as well. if (IsVisible() && MESSAGE_IS_A(Message, DocChangingMsg)) { DocChangingMsg *TheMsg = (DocChangingMsg *) Message; switch ( TheMsg->State ) { case DocChangingMsg::DocState::BORN: // New document - add to display tree { INT32 Extent = GetDisplayExtent(); // Remember previous list extent CreateNewSubtree(TheMsg->pChangingDoc); // Add a subtree for this doc ShadeGallery(FALSE); // Unshade the gallery InvalidateCachedFormat(); // And redraw what is necessary RedrawEverythingBelow(-Extent); } break; // Pass this message on to the base class as well } } return(SuperGallery::Message(Message)); }

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

The TEMPLATESGallery 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: Unattributed (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) 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 SuperGallery. Definition at line 615 of file sgbase.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); } // **** TO DO **** // You may not need to adjust the following, but note that it re-creates the entire // display tree from scratch whenever the gallery window is opened - if this is // unsuitable for your needs, you'll have to change it (e.g. you could make it only // do it if the DisplayTree has not already been created, above) // And for each document already present, create a display subtree (possibly replacing // a previous displaytree for it if we had one earlier) Document *ParentDoc = (Document *) GetApplication()->Documents.GetTail(); while (ParentDoc != NULL) { // Find the existing subtree, if any SGDisplayGroup *ParentGroup = DisplayTree->FindSubtree(this, ParentDoc, NULL); // Create a new subtree, replacing the old one if possible CreateNewSubtree(ParentDoc, ParentGroup); ParentDoc = (Document *) GetApplication()->Documents.GetPrev(ParentDoc); } return(TRUE); }

---

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

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

---