bitmap_tree.h

Go to the documentation of this file.

#ifndef BITMAP_TREE_CLASS
#define BITMAP_TREE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : bitmap_tree                                                       *
*  Author : see article                                                       *
*  Mods   : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Provides a tree control that is specialized for displaying bitmaps at    *
*  the tree nodes.                                                            *
*                                                                             *
*******************************************************************************
* Copyright (c) 1998-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "mfc_dll.h"

#include <afxcmn.h>

// forward.
class bitmap_tree;

typedef bool (*TREE_CALLBACK)(bitmap_tree *, HTREEITEM, LPARAM);

class MFC_EXTENSIONS_CLASS_STYLE bitmap_tree : public CTreeCtrl
{
public:
  bitmap_tree();
  virtual ~bitmap_tree();

  // parameter setting...

  int  SetNormalImages(UINT bitmap, int number, COLORREF mask);
  int  SetOverlayImages(UINT bitmap, COLORREF mask);
  int  SetStateImages(UINT bitmap, int number, COLORREF mask);
  void SetSortFunction(PFNTVCOMPARE func, LPARAM l);
  void SetDocumentSortFunction(int offset);
  void SetExpandable(int base);
  void SetDraggable(int base);
  void SetDropTarget(int base);
  void SetMultiSelect(bool b = true);
  void SetDrag(TREE_CALLBACK func, UINT bitmap= 0, COLORREF mask= 0);
  void SetSelChange(bool b) { m_canChangeSel= b; }

  // parameter access

  int ItemOffset() const { return m_itemOffset; }

  int GetNormalImageCount()
      { return m_ilNormal.m_hImageList ? (m_ilNormal.GetImageCount()
            - m_numOverlays) : 0; }

  bool GetOverlayImageCount() { return m_numOverlays != 0; }

  int GetStateImageCount()
      { return m_ilState.m_hImageList? m_ilState.GetImageCount() : 0; }
  bool IsSelected(HTREEITEM h)
      { return TVIS_SELECTED & GetItemState(h, TVIS_SELECTED); }
  bool AreMultiSelected() { return m_multiSet && m_multiSelected;}
  bool IsExpandable(int base);
  virtual bool IsDraggable(HTREEITEM, int base);
  virtual bool IsDropTarget(HTREEITEM, int base);

  // operations
  void SetExpandImage(HTREEITEM hitem, bool expand);
  HTREEITEM GetItemUnderMouse(TV_HITTESTINFO *t= NULL);
  void ToggleTree(UINT code, HTREEITEM hitem= NULL);
  void SortTree(HTREEITEM hitem= NULL);

  // selection functions
  bool DoForAllSelected(TREE_CALLBACK func, HTREEITEM hitem, LPARAM l);
  bool DoForAll(TREE_CALLBACK func, HTREEITEM hitem, LPARAM l);
  void ClearMultiSelect();
  void SelectAnotherItem(HTREEITEM h, bool select);
  void SelectRange(HTREEITEM h1, HTREEITEM h2);

// ugly macros to be cleaned up.
  #define STATE_IMAGE_MASK_TO_INDEX(n) ((n) >> 12)
  #define OVERLAY_MASK_TO_INDEX(n) ((n) >> 8)

  // overlay info
  int GetOverlayInfo(HTREEITEM hitem)
      { return OVERLAY_MASK_TO_INDEX(GetItemState(hitem, TVIS_OVERLAYMASK)); }

  // state info
  int GetStateImageInfo(HTREEITEM hitem)
      { return STATE_IMAGE_MASK_TO_INDEX(GetItemState(hitem,
            TVIS_STATEIMAGEMASK)); }

  // starts and stops the "drag while scrolling" timer.
  void start_timer();
  void stop_timer();

  // handy callbacks that are provided by the bitmap_tree implementation.
  static bool MoveTreeItemCB(bitmap_tree *bt, HTREEITEM h, LPARAM l);
  static bool ClearSelection(bitmap_tree *bt, HTREEITEM h, LPARAM l);
  static bool PrepareDrag(bitmap_tree *bt, HTREEITEM h, LPARAM l);
  static int CALLBACK NodeTypeCompare(LPARAM lParam1, LPARAM lParam2,
           LPARAM lParamSort);

protected:
  DECLARE_MESSAGE_MAP()

  void SetOverlayInfo(HTREEITEM hitem, int image)
      { SetItemState(hitem, INDEXTOOVERLAYMASK(image), TVIS_OVERLAYMASK); }
  void SetStateImageInfo(HTREEITEM hi, int image)
      { SetItemState(hi, INDEXTOSTATEIMAGEMASK(image), TVIS_STATEIMAGEMASK); }

  virtual BOOL OnExpanded(NMHDR *pNMHDR, LRESULT *pResult);
  virtual BOOL OnSelChanging(NMHDR *pNMHDR, LRESULT *pResult);
  virtual BOOL OnClick(NMHDR *pNMHDR, LRESULT *pResult);
  virtual BOOL OnKey(NMHDR* pNMHDR, LRESULT* pResult);
//  virtual BOOL OnRClick(NMHDR *pNMHDR, LRESULT *pResult);
  virtual BOOL OnDoubleClick(NMHDR *pNMHDR, LRESULT *pResult);
  virtual BOOL OnBeginDrag(NMHDR* pNMHDR, LRESULT* pResult);
  virtual BOOL OnDelete(NMHDR* pNMHDR, LRESULT* pResult);
  afx_msg void OnLButtonUp(UINT nFlags, CPoint point);
  afx_msg void OnMouseMove(UINT nFlags, CPoint point);
  afx_msg void OnTimer(UINT nIDEvent);

private:
  enum OverlayImages { m_overlay1=1, m_overlay2, m_overlay3, m_overlay4 };
  int m_numOverlays;
  int m_itemOffset;

  // images
  CSize m_sNormalImage, m_sStateImage;
  CImageList m_ilNormal, m_ilState;
  int m_toggle;
  bool m_overlaySet, m_multiSet;

  // multiple selection
  bool m_multiSelected, m_canChangeSel;
  HTREEITEM m_lastSelected, m_postSelect;
  UINT m_firstKey;

  // sorting
  TV_SORTCB m_sortcb;

  // dragging
  CImageList m_ilDrag, *m_dragList;
  TREE_CALLBACK m_dragFunction;
  int m_draggable, m_dropTarget;
  int m_xDrag, m_docDrag, m_multiDrag;
};

#endif

---