SGDisplayRoot Class Reference

This DisplayTree node type is used by the SuperGallery The top (root) level of the DisplayTree is made up of a single SGDisplayRoot node. This node is used as a single entry-point for all tree-wide actions which the SuperGallery applies to it (redraw, reformatting, etc). More...

#include <sgtree.h>

Inheritance diagram for SGDisplayRoot:

List of all members.

Public Member Functions
	SGDisplayRoot (SuperGallery *ParentGal)
	SGDisplayRoot constructor (makes root nodes invisible by default).
virtual SGDisplayNode *	GetChild (void) const
	Finds the child of this DisplayTree Node. Returns NULL if you have reached the boundary of the tree.
virtual SuperGallery *	GetParentGallery (void) const
	Returns the SuperGallery which 'owns' this node (and its subtree).
virtual void	InsertAfter (SGDisplayNode *NodeToInsert)
	OVERRIDES SGDisplayNode::InsertAfter.
virtual void	InsertBefore (SGDisplayNode *NodeToInsert)
	OVERRIDES SGDisplayNode::InsertBefore.
virtual void	RemoveFromTree (void)
	OVERRIDES SGDisplayNode::RemoveFromTree The root node cannot be removed from the tree - it returns quietly, taking no action (this allows the generic treatment of DestroyTree to work without having to take special action for delinking the root node).
virtual void	DestroySubtree (BOOL IncludingThisNode=TRUE)
	DESTROYS the subtree starting at this root node. This does a depth-first recursive scan of the subtree, delinking each item, and then CALLING EACH ITEMS DESTRUCTOR.
virtual void	InitFormatInfo (SGFormatInfo *FormatInfo, SGMiscInfo *MiscInfo)
	Resets the formatting info structure to default values for the start of a formatting pass. Must be called before SGDisplayRoot::Redraw.
virtual BOOL	HandleEvent (SGEventType EventType, void *EventInfo, SGMiscInfo *MiscInfo)
	Handles a SuperGallery DisplayTree event.
virtual INT32	CalculateListExtent (SGFormatInfo *FormatInfo, SGMiscInfo *MiscInfo)
	Causes the entire subtree from this node to format themselves, and returns the 'height' of the entire list display, in millipoints.
virtual INT32	GetCachedListExtent (void)
	Returns the 'height' of the entire list display, in millipoints. This return value is only valid after the tree has been formatted (including a previous call to CalculateListExtent), so long as the cached tree format is still valid. Use with care.
virtual void	SetScrollOffset (INT32 NewOffset, SGMiscInfo *MiscInfo)
	Changes the scroll offset, and if necessary, redraws the scroll bar.
virtual INT32	GetScrollOffset (void)
virtual void	RedrawScrollBar (SGMiscInfo *MiscInfo)
	Causes the scroll bar, if any, to be redrawn. In the base class, this method does nothing.
virtual SGDisplayItem *	FindNextSelectedItem (SGDisplayNode *CurrentItem=NULL, BOOL *SkipGroup=NULL)
	Scanning the selection within a Display Tree - this will scan over multiple documents/libraries without blinking an eyelid.
virtual INT32	GetSelectedItemCount (void)
	To determine how many eaf items of this tree are selected.
virtual SGDisplayGroup *	FindNextSelectedGroup (SGDisplayNode *CurrentGroup=NULL)
	Scanning the group-selection within a Display Tree.
virtual INT32	GetSelectedGroupCount (void)
	To determine how many eaf Groups of this tree are selected.
virtual void	SelectRange (SGDisplayNode *PrimeNode, SGDisplayNode *AnchorNode)
	Selects the PrimeNode, and if possible, all sibling nodes between it and the Anchor node. If Anchor == NULL or is not found, only PrimeNode is selected. Does not deselect any nodes - you should call SelectItems first to clear the seln.
Static Public Member Functions
static SGDisplayNode *	FindNextItemInTree (SGDisplayNode *StartItem)
	Given an item in the tree, find the next one.
Protected Member Functions
	SGDisplayRoot ()
	Dumps TRACE output to the debugger showing the layout of the tree THIS FUNCTION IS ONLY PRESENT IN DEBUG BUILDS (ifdef _DEBUG) It will also only produce debug output if your UserName is "Jason"SGDisplayRoot constructor (makes root nodes invisible by default).
virtual void	SetChild (SGDisplayNode *NewChild)
	Sets the child of this DisplayTree Node. Overrides to base class method to allow the child to be set.
Protected Attributes
SGDisplayNode *	Child
SuperGallery *	ParentGallery
INT32	ScrollExtent
Private Member Functions
	CC_DECLARE_DYNAMIC (SGDisplayRoot)

---

Detailed Description

This DisplayTree node type is used by the SuperGallery The top (root) level of the DisplayTree is made up of a single SGDisplayRoot node. This node is used as a single entry-point for all tree-wide actions which the SuperGallery applies to it (redraw, reformatting, etc).

Author:

Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>

Date:

19/10/94

By default, the root node is completely invisible on the display, and is just used for internal tidiness. However, galleries could override this class to make a new root type (e.g. you could override the redraw of the entire tree in certain display modes, to give a "show one item at a time" mode, etc)

If the root node has no children, it becomes visible, redrawing itself as a piece of grey text reading 'No items' or similar.

See also:

SGDisplayRootScroll

SuperGallery; SGDisplayNode; SGDisplayGroup; SGDisplayItem;

Definition at line 1157 of file sgtree.h.

---

Constructor & Destructor Documentation

SGDisplayRoot::SGDisplayRoot (   )  [protected]

Dumps TRACE output to the debugger showing the layout of the tree THIS FUNCTION IS ONLY PRESENT IN DEBUG BUILDS (ifdef _DEBUG) It will also only produce debug output if your UserName is "Jason"SGDisplayRoot constructor (makes root nodes invisible by default). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 26/10/94 See also: SGDisplayNode::SGDisplayNode Definition at line 2896 of file sgtree.cpp. { Child = NULL; Flags.Invisible = TRUE; // The root node is always invisible ParentGallery = NULL; ScrollExtent = 0; ERROR3("SGDisplayRoot constructed in an illegal manner"); }

SGDisplayRoot::SGDisplayRoot (  SuperGallery *  ParentGal  )

SGDisplayRoot constructor (makes root nodes invisible by default). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 26/10/94 Parameters: ParentGal  - A pointer to the parent gallery of this node/tree [INPUTS] See also: SGDisplayNode::SGDisplayNode Definition at line 2924 of file sgtree.cpp. { Child = NULL; Flags.Invisible = TRUE; // The root node is always invisible ParentGallery = ParentGal; ScrollExtent = 0; }

---

Member Function Documentation

INT32 SGDisplayRoot::CalculateListExtent (  SGFormatInfo *  FormatInfo, SGMiscInfo *  MiscInfo )  [virtual]

Causes the entire subtree from this node to format themselves, and returns the 'height' of the entire list display, in millipoints. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 26/10/94 Parameters: FormatInfo  - should have been initialised with InitFormatInfo [INPUTS] MiscInfo - Miscellanous info needed for formatting FormatInfo  is updated as appropriate [OUTPUTS] Returns: The needed (window scroll) extent to contain the entire list if it were to be redrawn right now. NOTE that this is a positive value; if you wish to use this to find the bottom of the virtual space coordinates, you must negate it (as Virtual space runs from 0 to -Extent) See also: SGDisplayRoot::InitFormatInfo; SGDisplayRoot::GetCachedListExtent Definition at line 3298 of file sgtree.cpp. { if (GetChild() == NULL) return(0); // Ask ourself to handle a FORMAT event. This recursively formats the tree, and returns // with FormatInfo indicating the state at the end of formatting (FormatInfo->LinePos // is at the end position of the list, and hence gives us the extent) HandleEvent(SGEVENT_FORMAT, FormatInfo, MiscInfo); return(ScrollExtent); }

SGDisplayRoot::CC_DECLARE_DYNAMIC (  SGDisplayRoot   )  [private]

void SGDisplayRoot::DestroySubtree (  BOOL  IncludingThisNode = TRUE  )  [virtual]

DESTROYS the subtree starting at this root node. This does a depth-first recursive scan of the subtree, delinking each item, and then CALLING EACH ITEMS DESTRUCTOR. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/10/94 Parameters: IncludingThisNode  - TRUE (The default) to delete this node (the root of [INPUTS] the subtree) as well as all its children. FALSE to delete its children only (This leaves this node untouched, but vapes all child nodes) NOTE - This parameter is ignored, and always treated as FALSE IT DOES NOT destruct the root node, however (i.e. it destroys the tree down to the point where only the root is left alive). Returns: Errors: May be generated by the RemoveFromTree and destructor calls if the subtree is in some way corrupt - see these calls for details. See also: SuperGallery; SGDisplayNode::RemoveFromTree; SGDisplayNode::DestroySubtree Reimplemented from SGDisplayNode. Definition at line 3108 of file sgtree.cpp. { // Destroy all our children, but DO NOT delete 'this' node! SGDisplayNode::DestroySubtree(FALSE); }

SGDisplayNode * SGDisplayRoot::FindNextItemInTree (  SGDisplayNode *  StartItem  )  [static]

Given an item in the tree, find the next one. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 15/04/96 Parameters: StartItem  - Item from which to start looking for next item [INPUTS] Returns: The next item, or NULL if no further items found Notes: This function will skip virtualised groups, so if you need to do something globally, don't call this... See also: SGDisplayRoot::GetSelectedItemCount; Definition at line 3718 of file sgtree.cpp. { ERROR3IF(StartItem == NULL, "SGDisplayRoot::FindNextItemInTree given a NULL StartItem - bad"); if(StartItem == NULL) return NULL; SGDisplayNode *Item = StartItem; // If this is the last item in the group, skip to the next group if (Item->GetNext() == NULL) { ERROR3IF(Item->GetParent() == NULL, "Tree linkage corruption"); // Check if we're the last group if (Item->GetParent()->GetNext() != NULL) { SGDisplayNode *TmpItem = Item->GetParent()->GetNext(); // Jump over any virtualised groups while(TmpItem != NULL && TmpItem->GetChild() == NULL) TmpItem = TmpItem->GetNext(); // Check if gone over last group if(TmpItem == NULL) Item = NULL; else Item = TmpItem->GetChild(); } else Item = NULL; } else Item = Item->GetNext(); // Get next sibling item return Item; }

SGDisplayGroup * SGDisplayRoot::FindNextSelectedGroup (  SGDisplayNode *  CurrentGroup = NULL  )  [virtual]

Scanning the group-selection within a Display Tree. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 10/2/95 Parameters: CurrentGroup  - NULL to find the first selected Group, else [INPUTS] An SGDisplayGroup indicating the 'position' to search from for the next selected Group Returns: NULL (if no selection), or A pointer to the first selected leaf of this tree which occurs after the 'CurrentGroup'. If CurrentGroup is NULL, then the first selected leaf node is returned. Notes: This method relies heavily on the flat (root/group/Group) structure of current display trees - it will fail horribly if this simple layout is changed. Warning: It may be possible for groups AND items to be selected at one time. This essentially filters Items out of the selection scan. See also: SGDisplayRoot::FindNextSelectedItem; SGDisplayRoot::GetSelectedGroupCount Definition at line 3629 of file sgtree.cpp. { // Find the current group node - my first child, or the the current Group's parent. if (CurrentGroup != NULL) CurrentGroup = ((SGDisplayGroup *) CurrentGroup)->GetNext(); else CurrentGroup = (SGDisplayGroup *) GetChild(); ERROR3IF(CurrentGroup != NULL && !CurrentGroup->IsKindOf(CC_RUNTIME_CLASS(SGDisplayGroup)), "The gallery displaytree seems to have mutated- " "where have my lovely groups gone?"); // Search each sibling group in turn until we find another selected leaf Group while (CurrentGroup != NULL) { if (CurrentGroup->IsSelected()) // Found a selected group - return it return((SGDisplayGroup *)CurrentGroup); CurrentGroup = ((SGDisplayGroup *) CurrentGroup)->GetNext(); } // No more selected groups return(NULL); }

SGDisplayItem * SGDisplayRoot::FindNextSelectedItem (  SGDisplayNode *  CurrentItem = NULL, BOOL *  SkipGroup = NULL )  [virtual]

Scanning the selection within a Display Tree - this will scan over multiple documents/libraries without blinking an eyelid. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 10/2/95 Parameters: CurrentItem  - NULL to find the first selected item, else [INPUTS] An SGDisplayItem (node) indicating the 'position' to search from for the next selected item if  Non-NULL, SkipGroup will be filled in with TRUE if the scan has just [OUTPUTS] skipped onto a new document/library group within the tree, or FALSE if the scan remains in the same group as the last selected node was in. If CurrentItem was NULL on entry, this returned value will be TRUE. Returns: NULL (if no selection), or A pointer to the first selected leaf of this tree which occurs after the 'CurrentItem'. If CurrentItem is NULL, then the first selected leaf node is returned. Use to scan through multiple-group selections, or to find the first selected item without having to know which document/library group it belongs to. Notes: This method relies heavily on the flat (root/group/item) structure of current display trees - it will fail horribly if this simple layout is changed. Warning: It may be possible for groups AND items to be selected at one time. This essentially filters Groups out of the selection scan. See also: SGDisplayNode::FindSubtree; SGDisplayGroup::FindNextSelectedItem; SGDisplayRoot::GetSelectedItemCount; SGDisplayGroup::GetSelectedItemCount; SGDisplayRoot::FindNextSelectedGroup Definition at line 3457 of file sgtree.cpp. { BOOL ReturnSkip = (CurrentItem == NULL); SGDisplayItem *ReturnItem = NULL; // Find the current group node - my first child, or the the current item's parent. SGDisplayGroup *CurrentGroup; if (CurrentItem != NULL) CurrentGroup = (SGDisplayGroup *) CurrentItem->GetParent(); else CurrentGroup = (SGDisplayGroup *) GetChild(); ERROR3IF(CurrentGroup != NULL && !CurrentGroup->IsKindOf(CC_RUNTIME_CLASS(SGDisplayGroup)), "The gallery displaytree seems to have mutated- " "where have my lovely groups gone?"); // Search each sibling group in turn until we find another selected leaf item while (CurrentGroup != NULL && ReturnItem == NULL) { ReturnItem = CurrentGroup->FindNextSelectedItem((SGDisplayItem *)CurrentItem); if (ReturnItem == NULL) { // No more selected items in this group - skip onto the next group, and flag // the fact that we had to skip to a different group ReturnSkip = TRUE; CurrentGroup = (SGDisplayGroup *) CurrentGroup->GetNext(); CurrentItem = NULL; } } // Return the SkipGroup output if (SkipGroup != NULL) *SkipGroup = ReturnSkip; // And return NULL or the next selected node return(ReturnItem); }

INT32 SGDisplayRoot::GetCachedListExtent (  void   )  [virtual]

Returns the 'height' of the entire list display, in millipoints. This return value is only valid after the tree has been formatted (including a previous call to CalculateListExtent), so long as the cached tree format is still valid. Use with care. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/3/95 Returns: The currently cached value for the scroll extent See also: SGDisplayRoot::CalculateListExtent Definition at line 3330 of file sgtree.cpp. { return(ScrollExtent); }

SGDisplayNode * SGDisplayRoot::GetChild (  void   )  const [virtual]

Finds the child of this DisplayTree Node. Returns NULL if you have reached the boundary of the tree. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/10/94 (Made virtual 13/5/95) Returns: A pointer to the first child of this SGDisplayNode object, or NULL See also: SuperGallery; SGDisplayNode::GetParent; SGDisplayNode::GetNext; SGDisplayNode::GetPrevious Reimplemented from SGDisplayNode. Definition at line 2951 of file sgtree.cpp. { return(Child); }

SuperGallery * SGDisplayRoot::GetParentGallery (  void   )  const [virtual]

Returns the SuperGallery which 'owns' this node (and its subtree). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 28/10/94 Returns: The parent SuperGallery, or NULL See also: SGDisplayNode::GetParentGallery Reimplemented from SGDisplayNode. Definition at line 2997 of file sgtree.cpp. { ERROR3IF(ParentGallery == NULL, "I have no parent gallery! This is not right!"); return(ParentGallery); }

INT32 SGDisplayRoot::GetScrollOffset (  void   )  [virtual]

Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/1/95 Returns: In the base class, always returns 0 The current Scroll offset. This is a positive MLLIPOINT value. Note that virtual coordinates go from 0 to -Extent, so the point of VirtualSpace which maps to the top left displayed pixel on screen is at (-ScrollOffset). In the base class, no scrollbar is supplied; this method does nothing See also: SGDisplayRoot::SetScrollOffset; SGDisplayRootScroll::GetScrollOffset Reimplemented in SGDisplayRootScroll. Definition at line 3383 of file sgtree.cpp. { // Base class does nothing - There is no scroll offset return(0); }

INT32 SGDisplayRoot::GetSelectedGroupCount (  void   )  [virtual]

To determine how many eaf Groups of this tree are selected. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 10/2/95 Returns: The number of Groups in this display tree which are selected (may return 0) Notes: This scans the selection (is not cached), so calling it multiple times should be avoided where possible This method relies heavily on the flat (root/group/Group) structure of current display trees - it will fail horribly if this simple layout is changed. See also: SGDisplayRoot::FindNextSelectedGroup; SGDisplayGroup::GetSelectedGroupCount Definition at line 3678 of file sgtree.cpp. { INT32 Count = 0; SGDisplayGroup *Ptr = (SGDisplayGroup *) GetChild(); while (Ptr != NULL) { if (Ptr->IsSelected()) Count++; Ptr = (SGDisplayGroup *) Ptr->GetNext(); } return(Count); }

INT32 SGDisplayRoot::GetSelectedItemCount (  void   )  [virtual]

To determine how many eaf items of this tree are selected. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 10/2/95 Returns: The number of items in this display tree which are selected (may return 0) Notes: This scans the selection (is not cached), so calling it multiple times should be avoided where possible This method relies heavily on the flat (root/group/item) structure of current display trees - it will fail horribly if this simple layout is changed. See also: SGDisplayRoot::FindNextSelectedItem; SGDisplayGroup::GetSelectedItemCount; SGDisplayRoot::GetSelectedGroupCount Definition at line 3522 of file sgtree.cpp. { INT32 Count = 0; SGDisplayGroup *Ptr = (SGDisplayGroup *) GetChild(); while (Ptr != NULL) { Count += Ptr->GetSelectedItemCount(); Ptr = (SGDisplayGroup *) Ptr->GetNext(); } return(Count); }

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

Handles a SuperGallery DisplayTree event. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/10/94 Parameters: See  SGDisplayNode::HandleEvent [INPUTS] 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 down the tree. See also: SGDisplayNode::HandleEvent; SGDisplayGroup::HandleEvent; SGDisplayItem::HandleEvent; SGDisplayRoot::InitFormatInfo; SGDisplayRoot::CalculateListExtent; SGDisplayNode::GiveEventToMyChildren Reimplemented from SGDisplayNode. Reimplemented in SGDisplayRootScroll. Definition at line 3185 of file sgtree.cpp. { switch (EventType) { case SGEVENT_FORMAT: // Do nothing, but ensure we don't use the 'default:' case. break; case SGEVENT_REDRAW: { SGRedrawInfo *RedrawInfo = GetRedrawInfo(EventType, EventInfo); // This line is to stop the white flicker when backgrounding the items // Hmmm... There are a few problems which need sorting out though ! if (BkgEraseMode == TRUE) { StartRendering(RedrawInfo, MiscInfo); RenderRegion *pRender = RedrawInfo->Renderer; // Set default background colour pRender->SetFillColour(RedrawInfo->Background); pRender->SetLineColour(COLOUR_TRANS); //RedrawInfo->Background); // Work out height first to avoid ENSURE in DocRect ctor INT32 height=ScrollExtent; // Extend the rect if necessary to ensure entire window bg is filled if (ScrollExtent < MiscInfo->WindowHeight) height = MiscInfo->WindowHeight; if ((height>=0) && (MiscInfo->MaxWidth>=0)) { // Fill entire display window background with bg colour DocRect WindowBG(0, -height, MiscInfo->MaxWidth, 0); pRender->DrawRect(&WindowBG); } StopRendering(RedrawInfo, MiscInfo); } else BkgEraseMode = TRUE; if (GetChild() == NULL) // We have no children (empty tree) { // Redraw ourself as 'No Items' indicator // ERROR3("SGDisplayRoot::Redraw - I have no children to draw"); return(TRUE); // Might as well return TRUE - there is nobody else! } } break; default: return(SGDisplayNode::HandleEvent(EventType, EventInfo, MiscInfo)); } // We have children, so recursively call them all with this event BOOL result = GiveEventToMyChildren(EventType, EventInfo, MiscInfo); // If we've just reformatted the tree, remember the new list extent if (EventType == SGEVENT_FORMAT) { SGFormatInfo *FormatInfo = GetFormatInfo(EventType, EventInfo); ScrollExtent = (ABS(FormatInfo->LinePos)); SetScrollOffset(GetScrollOffset(), MiscInfo); // Ensure not scrolled off end! if (FormatInfo->LastInvalidNode != NULL) { // The immediately previous (final) node had invalid bounds. // We'd better include the blank part of the list below it in the // invalid bounds, to ensure we don't leave little bits of stuff past the end // of the list if it has got smaller. ERROR3IF(FormatInfo->InvalidBounds.hi.y > 0, "Gallery display formatting error - LastInvalidNode should be NULL " "if there haven't been any invalid nodes yet"); FormatInfo->InvalidBounds.lo.y = FormatInfo->LinePos - MiscInfo->WindowHeight; } } return(result); }

void SGDisplayRoot::InitFormatInfo (  SGFormatInfo *  FormatInfo, SGMiscInfo *  MiscInfo )  [virtual]

Resets the formatting info structure to default values for the start of a formatting pass. Must be called before SGDisplayRoot::Redraw. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 24/10/94 Parameters: FormatInfo  - Points at the format information to be initialised [INPUTS] MiscInfo - Points at a structure containing standard 'MiscInfo' FormatInfo  is initialised as appropriate [OUTPUTS] MiscInfo->MaxWidth is gridlocked to the pixel grid See also: SGDisplayRoot::Redraw Definition at line 3136 of file sgtree.cpp. { MiscInfo->MaxWidth = GridLock(MiscInfo, MiscInfo->MaxWidth); // Maximum width of formatting lines FormatInfo->LinePos = 0; // Start at the top of the list FormatInfo->LineHeight = 0; // The current line is 0 height so far FormatInfo->AvailableWidth = MiscInfo->MaxWidth; // The full line is left to allocate FormatInfo->IndentLevel = 0; // Initially we are not indented FormatInfo->AccumulateBounds = FALSE; // By default, don't accumulate bounds FormatInfo->LastInvalidNode = NULL; // For the group dragging redraw fix FormatInfo->InvalidBounds = DocRect(0, 1, MiscInfo->MaxWidth, 2); }

void SGDisplayRoot::InsertAfter (  SGDisplayNode *  NodeToInsert  )  [virtual]

OVERRIDES SGDisplayNode::InsertAfter. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/10/94 Parameters: NodeToInsert  - the new node to insert into the tree [INPUTS] Insertions at the root node are always converted to AddItem() calls, to insert the item as the last child of the root node. The root cannot have siblings! See also: SGDisplayNode::AddItem Reimplemented from SGDisplayNode. Definition at line 3025 of file sgtree.cpp. { AddItem(NodeToInsert); }

void SGDisplayRoot::InsertBefore (  SGDisplayNode *  NodeToInsert  )  [virtual]

OVERRIDES SGDisplayNode::InsertBefore. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/10/94 Parameters: NodeToInsert  - the new node to insert into the tree [INPUTS] Insertions at the root node are always converted to AddItem() calls, to insert the item as the last child of the root node. The root cannot have siblings! See also: SGDisplayNode::AddItem Reimplemented from SGDisplayNode. Definition at line 3051 of file sgtree.cpp. { AddItem(NodeToInsert); }

void SGDisplayRoot::RedrawScrollBar (  SGMiscInfo *  MiscInfo  )  [virtual]

Causes the scroll bar, if any, to be redrawn. In the base class, this method does nothing. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 3/2/95 Parameters: MiscInfo  - The normal MiscInfo for SGDisplayNode events [INPUTS] See also: SGDisplayRootScroll::RedrawScrollBar Reimplemented in SGDisplayRootScroll. Definition at line 3407 of file sgtree.cpp. { // The base class has no scrollbar, so does nothing }

void SGDisplayRoot::RemoveFromTree (  void   )  [virtual]

OVERRIDES SGDisplayNode::RemoveFromTree The root node cannot be removed from the tree - it returns quietly, taking no action (this allows the generic treatment of DestroyTree to work without having to take special action for delinking the root node). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/10/94 See also: SGDisplayNode::RemoveFromTree; SGDisplayNode::DestroySubtree Reimplemented from SGDisplayNode. Definition at line 3074 of file sgtree.cpp. { // do nothing }

void SGDisplayRoot::SelectRange (  SGDisplayNode *  PrimeNode, SGDisplayNode *  AnchorNode )  [virtual]

Selects the PrimeNode, and if possible, all sibling nodes between it and the Anchor node. If Anchor == NULL or is not found, only PrimeNode is selected. Does not deselect any nodes - you should call SelectItems first to clear the seln. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 26/5/95 Parameters: PrimeNode  - The node which MUST be selected. May NOT be NULL. [INPUTS] AnchorNode - The other node, specifying a range of sibling nodes to be selected. May be NULL, in which case only PrimeNode is selected Note: The code to do the selection is now sub-contracted out to SelectRangeGroups and SelectRangeItems, depending on the type of the two given nodes. If prime node is an item and the other a group, nothing will be selected... If prime node is an item and the null, the item will be selected... Definition at line 3562 of file sgtree.cpp. { ERROR3IF(PrimeNode == NULL, "SGDisplayRoot::SelectRange - PrimeNode must be non-NULL"); if (AnchorNode == NULL || PrimeNode->GetParent() != AnchorNode->GetParent()) { // There is no anchor, or the prime/anchor nodes are not siblings, so // we cannot select a range - select PrimeNode, deselect all others ParentGallery->SelectItems(FALSE); ParentGallery->SelectGroups(FALSE); // Paint the list now to reduce the chance of large redraws if the // old/new selections are far apart. ParentGallery->PaintListNow(); PrimeNode->SetSelected(TRUE); ParentGallery->PaintListNow(); } else if (PrimeNode->IS_KIND_OF(SGDisplayItem) && (AnchorNode == NULL || AnchorNode->IS_KIND_OF(SGDisplayItem))) { // We are selecting a range of items so deselect all groups first ParentGallery->SelectGroups(FALSE); // Deselect all groups SelectRangeItems((SGDisplayItem *)PrimeNode, (SGDisplayItem *)AnchorNode); } else if (PrimeNode->IS_KIND_OF(SGDisplayGroup) && (AnchorNode == NULL || AnchorNode->IS_KIND_OF(SGDisplayGroup))) { // We are selecting a range of groups so deselect all items first ParentGallery->SelectItems(FALSE); // Deselect all items SelectRangeGroups((SGDisplayGroup *)PrimeNode, (SGDisplayGroup *)AnchorNode); } // And ensure the gallery updates itself appropriately ParentGallery->SelectionHasChanged(); }

void SGDisplayRoot::SetChild (  SGDisplayNode *  NewChild  )  [protected, virtual]

Sets the child of this DisplayTree Node. Overrides to base class method to allow the child to be set. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/10/94 Parameters: A  pointer to the new first-child of this SGDisplayNode object [INPUTS] See also: SuperGallery; SGDisplayNode::GetParent; SGDisplayNode::GetNext; SGDisplayNode::GetPrevious Reimplemented from SGDisplayNode. Definition at line 2975 of file sgtree.cpp. { Child = NewChild; }

void SGDisplayRoot::SetScrollOffset (  INT32  NewOffset, SGMiscInfo *  MiscInfo )  [virtual]

Changes the scroll offset, and if necessary, redraws the scroll bar. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/1/95 Parameters: NewOffset  - The new scroll offset. [INPUTS] This is a number between 0 and LengthOfList, in MILLIPOINTs MiscInfo - the usual In the base class, no scrollbar is supplied; this method does nothing See also: SGDisplayRoot::GetScrollOffset; SGDisplayRootScroll::SetScrollOffset Reimplemented in SGDisplayRootScroll. Definition at line 3357 of file sgtree.cpp. { // Base class does nothing }

---

Member Data Documentation

SGDisplayNode* SGDisplayRoot::Child [protected]

Definition at line 1230 of file sgtree.h.

SuperGallery* SGDisplayRoot::ParentGallery [protected]

Definition at line 1232 of file sgtree.h.

INT32 SGDisplayRoot::ScrollExtent [protected]

Definition at line 1234 of file sgtree.h.

---

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

• Kernel/sgtree.h (r1785/r1139)
• Kernel/sgtree.cpp (r1785/r1282)

---