CTreeView

Heritage

Description

Usage

Public Data Members

Enums

Protected Data Members

Public Methods

Constructor, Destructor, and Initializer Methods

View Methods

Root Node Methods.

Title Bar Methods

Transformation Methods

Selection and Focus Methods

Factory Methods

Protected Methods

Heritage

Subclass: None

Description

Usage

	aFrame = GetFrame();
	itsTree = new CTreeView(this, aFrame);

	// Set up images
	itsFileImage          	= new CImage("file.bmp");
	itsOpenDirectoryImage	= new CImage("open.bmp");
	itsClosedDirectoryImage	= new CImage("closed.bmp");
	itsCheckImage	= new CImage("check.bmp");
 
	// Set up tabs
	itsTbSet = new CTabSet;
	itsTabSet->AddTab(CTextTab(CTextTab::Left, (UNITS)180));
	itsTabSet->AddTab(CTextTab(CTextTab::LeftImage, (UNITS)250));
	itsTabSet->AddImage(itsCheckImage, "check");
 
	// Set title string
	itsTree->SetTitleString(
		"Name" + CTabSet::TabString() +
			"Size" + CTabSet::TabString() +
			"checked"
		);
	itsTree->ITreeView(&aFileSource);
	itsTree->SetGlue(ALLSTICKY);
	itsTree->GetRoot()->SetString("..");
	itsTree->GetRoot()->SetImage(itsFileImage);
	itsTree->GetRoot()->SetCollapsedImage(itsClosedDirectoryImage);
	itsTree->GetRoot()->SetExpandedImage(itsOpenDirectoryImage);
	// This will use the images above to recalc
	itsTree->GetRoot()->SetHeight(CTreeItem::kBestHeight);  
	itsTree->GetRoot()->SetTabSet(itsTabSet);
	itsTree->GetRoot()->SortChildren(&itsSorter);
	itsTree->GetRoot()->Expand();
	itsTree->SetThumbtracking(TRUE);
	itsTree->SetSelectionPolicy(CTreeView::SelectNone);
	itsTree->SetExpansionPolicy(CTreeView::ExpandRestore);

void CTreeWin::DoCommand(long theCommand,void* theData)
{
   // Handle tree events
   if(theCommand == TreeEventCmd)
   {
      CTreeEvent* anEvent = (CTreeEvent*)theData;
      CTreeItem* anItem = anEvent->GetTreeItem();
 
      if(anItem != NULL)
      {
         switch(anEvent->GetType())
         {
            case CTreeEvent::MouseClick:
               // If we hit the second tab, toggle the check mark
               if(anEvent->GetTabHit() == kCheckTab)
               {
                  anItem->SetString(
                     CTabSet::ToggleField(
                        anItem->GetString(),
                        kCheckTab,
                        "check",
                        ""
                     )
                  );
                  anEvent->GetTree()->InvalidateItem(anItem);
               }
               break;
 
            case CTreeEvent::FocusIn:
               {
                  CStringRW aPath;
 
                  do
                  {
                     CStringRW aDirectory = CTabSet::GetField(
                              anItem->GetString(),
                              0
                              );
                     if(aPath.isNull())
                        aPath = aDirectory.strip(
                           RWCString::both);
                        else
                           aPath = aDirectory.strip(
                              RWCString::both) +
                                 "/" + aPath;
                  } while((anItem = anItem->GetParent()) != NULL);

                  itsText->SetTitle(aPath);
               }
               break;
         }
      }
   } else CWindow::DoCommand(theCommand,theData);
}

Enums

Used as constants to the methods SetSelectionPolicy() and GetSelectionPolicy(). The selection policy controls how the user may select tree items with the mouse.

ExpansionPolicy

Used as constants to the methods SetExpansionPolicy() and GetExpansionPolicy(). The expansion policy controls what the tree view does when expanding or collapsing a node. ExpandOne expands only the current node, leaving all of its children collapsed. ExpandAll expands the current node and all of its children. ExpandRestore expands the current node and all of the children that where expanded when the current node was last collapsed by the user. Note that for ExpandRestore to work properly on a node, you must set the policy before the node is collapsed.

TreeStyle

Used as constants to the methods SetTreeStyle() and GetTreeStyle(). The tree view uses the current tree style to determine whether to draw the skeleton lines between nodes and whether the lines should be square or skewed. CTreView uses StyleOrthogonal by default.

Protected Data Members

Public Methods

CTreeView(CSubview *theEnclosure, const CRect& theRegion);

Constructs a new tree view.

virtual ~CTreeView(void);

Destructor.

BOOLEAN ITreeView(
	const CTreeSource* theSource	= NULL,
	COLOR theColor			= COLOR_BLACK,
	const CFont& theFont		= CFont::GetBestCtlFont(),
	UNITS theHeight			= CTreeItem::kBestHeight,
	UNITS theIndent			= CTreeItem::kBestIndent,
	const CImage* theImage		= NULL,
	const CImage* theCollapsedImage	= NULL,
	const CImage* theExpandedImage	= NULL,
	const CTabSet* theTabSet	= NULL,
	BOOLEAN hasHorizontalScrollBar	= TRUE,
	BOOLEAN hasVerticalScrollBar	= TRUE,
	BOOLEAN isThumbTracking		= FALSE,
	UNITS theLineIncrement		= 10,
	UNITS thePageIncrement		= 50,
	BOOLEAN isVisible		= TRUE,
	GLUETYPE theGlue		= NULLSTICKY);

Initializes the tree view.
• theSource provides data to a dynamic tree.
• theColor sets the text color of the root node and therefore the default color of all items. Equivalent to calling GetRoot()->SetColor(...).
• theFont sets the text font of the root node and therefore the default font of all items. Equivalent to calling
  GetRoot()->SetFont(...).
• theHeight sets the height of the root node and therefore the default height of all items. Equivalent to calling
  GetRoot()->SetHeight(...).
• theIndent sets the indentation of the root node's children and therefore the default indentation of all children. This is equivalent to calling GetRoot()->SetIndent(...).
• theImage sets the terminal image of the root node and therefore the terminal image of all items. Equivalent to calling GetRoot()->SetImage(...). The tree view uses the terminal image, if any, to display a picture to the left of terminal items (items that are not nodes).
• theCollapsedImage sets the collapsed image of the root node and therefore the collapsed image of all items. Equivalent to calling GetRoot()->SetCollapsedImage(...). The tree view uses the collapsed image, if any, to display a picture to the left of collapsed node items.
• theExpandedImage sets the expanded image of the root node and therefore the expanded image of all items. Equivalent to calling GetRoot()->SetExpandedImage(...). The tree view uses the expanded image, if any, to display a picture to the left of expanded node items.
• theTabSet sets the tab set of the root node and therefore the tab set of all items. Equivalent to calling GetRoot()->SetTabSet(...). The tree view uses an item's tab set to justify fields within tabbed text and to imbed images within an item.
• hasHorizontalScrollBar determines whether or not the tree view will have a horizontal scroll bar. Also see CScroller::IScroller.
• hasVerticalScrollBar determines whether or not the tree view will have a vertical scroll bar. Also see CScroller::IScroller.
• If isThumbTracking is TRUE, the tree view will scroll its contents while the user drags the thumb of a scrollbar. If FALSE, the view scrolls after the user releases the mouse button. Also see CScroller::IScroller.
• theLineIncrement provides the number of pixels to scroll in response to a line up or down click on the scroll bar. Note that the tree view will always attempt to display whole items at the top of the view and adjust the line increment to equal the height of the top item. Also see CScroller::IScroller.
• thePageIncrement provides the number of pixels to scroll in response to a page up or down click on the scroll bar. Also see CScroller::IScroller.
• isVisible determines whether the tree view is intially visible. Also see CView::IView
• theGlue sets the glue type between the tree view and its enclosure. Also see CView::IView

virtual void Key(const CKey& theKey);

Handles key events to the tree view.

virtual CRect GetInitialFrame(CSubview* theEnclosure,
	 const CRect& theRegion,
	 BOOLEAN hasHorizontalScrollBar,
	 BOOLEAN hasVerticalScrollBar) const;

Returns the interior rectangle, exclusive of ornaments such as scrollbars, as specified by hasHorizontalScrollBar and hasVerticalScrollBar.

virtual CRect GetInnerFrame() const;

Returns the interior rectangle, exclusive of ornaments such as scrollbars, as specified by the current tree view arrangement.

virtual CRect GetClippedFrame() const;

Returns the interior rectangle as appropriate for clipping during scrolling operations.

void SetDeleteUserData(BOOLEAN theDelete);
BOOLEAN GetDeleteUserData() const;

Set to TRUE if you want the tree to delete user data. The default is FALSE. For user data information see CTreeItem.

virtual void Draw(const CRect& theClippingRegion);

Draws the tree view.

virtual void VScroll(SCROLL_CONTROL theEventType, UNITS thePos);

Responds to vertical scroll requests.

virtual void HScroll(SCROLL_CONTROL theEventType, UNITS thePos);

Responds to horizontal scroll requests.

virtual void ScrollViews(const CPoint& theNewOrigin);

Scrolls the tree view such the the pixel point theNewOrigin is in the// upper left corner of the tree view.

virtual void MakeItemVisible(const CTreeItem* theItem);

Forces scrolling such that theItem becomes visible.

CTreeNodeItem* GetRoot();

Returns a pointer to the root node, which is always created by the tree view.

const CTreeNodeItem* GetRoot() const;

Returns a pointer to the root node, which is always created by the tree view.

virtual void SetTitleString(
	const CStringRW& theTitle,   
	COLOR theColor = COLOR_BLACK,   
	const CFont& theFont = STDFont);

Sets the title string, text color, and text font. Call CView::Invalidate() to redraw the tree view.

virtual CStringRW GetTitleString() const;

Returns the title string.

virtual const CFont& GetTitleFont() const;

Returns the title font.

virtual CRect GetTitleRect() const;

Returns the title rectangle in global coordinates.

virtual CRect  ItemToRect(
	const CTreeItem* theItem,   
	BOOLEAN theRecurse = FALSE) const;

Returns the rectangle bounding theItem in global coordinates. If theRecurse is TRUE, this rectangle includes theItem and all of its children.

virtual CTreeItem* PointToItem(const CPoint& thePoint);

Returns the item, NULL if none, that contains thePoint in global coordinates.

virtual const CTreeItem* PointToItem(const CPoint& thePoint) const;

Returns the item, NULL if none, that contains thePoint in global coordinates.

virtual void  InvalidateItem(
	const CTreeItem* theItem,   
	BOOLEAN theRecurse = FALSE);

Causes redrawing of theItem and, if theRecurse is TRUE, all of its children.

virtual const CTreeItem* TopItem() const;

Returns the first item visible in the tree view.

virtual CTreeItem* TopItem();

Returns the first item visible in the tree view.

virtual const RWOrdered& GetSelection() const;

Returns an ordered collection of CTreeItem pointers representing all of the tree items currently selected.

virtual void  SetSelection(
	const RWOrdered& theSelection,   
	BOOLEAN theUpdate = FALSE);

Sets the list of selected tree items. theSelection is an ordered collection of CTreeItem pointers representing all of the tree items in the selection. Each element of theSelection must be a pointer to a valid CTreeItem. If theUpdate is TRUE, the tree view redraws the affected items.

virtual void  AddToSelection(CTreeItem* theItem,   
	BOOLEAN theUpdate = FALSE);

Add theItem to the list of selected tree items. If theUpdate is TRUE, the tree view redraws the item.

virtual void  RemoveFromSelection(CTreeItem* theItem,  
 	BOOLEAN theUpdate = FALSE);

Remove theItem to the list of selected tree items. If theUpdate if TRUE, the tree view redraws the item.

virtual void  ClearSelection(BOOLEAN theUpdate = FALSE);

Clear the list of selected tree items. If theUpdate is TRUE, the tree view redraws the affected area.

virtual BOOLEAN  SelectionContains(const CTreeItem* theItem);

Returns TRUE if the list of selected items contains theItem.

virtual void  InvalidateSelection();

Redraw all of the items in the list of selected items.

virtual void  SetFocusItem(CTreeItem* theItem,   
	BOOLEAN theUpdate = FALSE);

Sets theItem to have keyboard focus. If theUpdate is TRUE, the tree view redraws the item.

virtual const CTreeItem* GetFocusItem() const;

Returns the focus item or NULL if no tree item currently has focus.

virtual CTreeItem* GetFocusItem();

Returns the focus item or NULL if no tree item currently has focus.

virtual void  SetSelectionPolicy(SelectionPolicy thePolicy);

Sets the selection policy. See SelectionPolicy under Enums.

virtual SelectionPolicy GetSelectionPolicy() const;

Returns the selection policy. See SelectionPolicy under Enums.

virtual void  SetExpansionPolicy(ExpansionPolicy thePolicy);

Set the expansion policy. See ExpansionPolicy under Enums.

virtual ExpansionPolicy GetExpansionPolicy() const;

Returns the expansion policy. See ExpansionPolicy under Enums.

virtual void  SetTreeStyle(TreeStyle theStyle);

Set the tree style. See TreeStyle under Enums.

virtual TreeStyle GetTreeStyle() const;

Returns the tree style. See TreeStyle under Enums.

virtual void  SetDrawRoot(BOOLEAN theDrawRoot);

If theDrawRoot is TRUE, draw the root item, otherwise starts drawing with the children of the root item. When using the tree view as a list, you should call SetDrawRoot(FALSE);.

virtual BOOLEAN  GetDrawRoot() const;

Returns TRUE if the tree view draws the root node.

virtual const CTreeAttributes* GetAttributes(
	COLOR theColor,  
	const CFont& theFont,   
	UNITS theHeight,   
	UNITS theIndent,   
	const CImage* theImage,   
	const CImage* theCollapsedImage,  
	const CImage* theExpandedImage,   
	const CTabSet* theTabSet,   
	const CTreeSource* theSource);

Factory method that returns a CTreeAttributes (internal object), possibly shared, with the given attributes.

virtual CTreeItem* CreateTerminal(
	CTreeNodeItem* theParent,   
	const CTreeAttributes* theAttributes);

Factory method that creates a terminal item with the given attributes.

virtual CTreeNodeItem* CreateNode(
	CTreeNodeItem* theParent,   
	const CTreeAttributes* theAttributes);

Factory method that creates a node item with the given attributes.

virtual CRect DrawTitle(const CRect& theClippingRegion);

Internal draw method to draw the title bar.

virtual void DrawItem(
	const CTreeItem* theItem,
	CDrawingContext& theContext,
	const CRect& theClippingRegion);

Internal draw method to draw an item.

virtual void DrawSingleItem(
	const CTreeItem* theItem,
	CDrawingContext& theContext,
	const CRect& theClippingRegion);

Internal draw method to draw the string portion of an item.

virtual CPoint DrawImagePart(
	const CPoint& theStart,
	const CTreeItem* theItem,						
	CDrawingContext& theContext,
	const CRect& theClippingRegion);

Internal draw method to draw the image portion of an item.

virtual void DrawSelectionPart(
	const CPoint& theStart,
	UNITS theTextLength,
	const CTreeItem* theItem,
	const CRect& theClippingRegion);

Internal draw method to draw the selection/focus box portion of an item.

virtual void DrawTreePart(
	const CTreeItem* theItem,
	const CRect& theClippingRegion);

Internal draw method to draw the skeleton portion of an item.

virtual CTreeMouseHandler* CreateMouseHandler();

Internal factory method that creates the mouse handler for this tree view. By default, CreateMouseHandler() instantiates a CTreeMouseHandler.

CTreeView(const CTreeView& theTree) : CScroller(theTree);
CTreeView& operator=(const CTreeView& theTree);

Copy construction and assignment are disabled.