new wxTreeCtrl files
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@870 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
1195ec4251
commit
08b7c251c4
@ -2,297 +2,522 @@
|
||||
// Name: treectrl.h
|
||||
// Purpose: wxTreeCtrl class
|
||||
// Author: Julian Smart
|
||||
// Modified by:
|
||||
// Modified by: Vadim Zeitlin to be less MSW-specific on 10/10/98
|
||||
// Created: 01/02/97
|
||||
// RCS-ID: $Id$
|
||||
// Copyright: (c) Julian Smart and Markus Holzem
|
||||
// Licence: wxWindows license
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifndef _WX_TREECTRL_H_
|
||||
#define _WX_TREECTRL_H_
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// headers
|
||||
// ----------------------------------------------------------------------------
|
||||
#ifdef __GNUG__
|
||||
#pragma interface "treectrl.h"
|
||||
#pragma interface "treectrl.h"
|
||||
#endif
|
||||
|
||||
#include "wx/control.h"
|
||||
#include "wx/event.h"
|
||||
#include "wx/imaglist.h"
|
||||
|
||||
// WXDLLEXPORT_DATA(extern const char*) wxTreeNameStr;
|
||||
// the type for "untyped" data
|
||||
typedef long wxDataType;
|
||||
|
||||
#define wxTREE_MASK_HANDLE 0x0001
|
||||
#define wxTREE_MASK_STATE 0x0002
|
||||
#define wxTREE_MASK_TEXT 0x0004
|
||||
#define wxTREE_MASK_IMAGE 0x0008
|
||||
#define wxTREE_MASK_SELECTED_IMAGE 0x0010
|
||||
#define wxTREE_MASK_CHILDREN 0x0020
|
||||
#define wxTREE_MASK_DATA 0x0040
|
||||
// fwd decl
|
||||
class wxImageList;
|
||||
struct wxTreeViewItem;
|
||||
|
||||
#define wxTREE_STATE_BOLD 0x0001
|
||||
#define wxTREE_STATE_DROPHILITED 0x0002
|
||||
#define wxTREE_STATE_EXPANDED 0x0004
|
||||
#define wxTREE_STATE_EXPANDEDONCE 0x0008
|
||||
#define wxTREE_STATE_FOCUSED 0x0010
|
||||
#define wxTREE_STATE_SELECTED 0x0020
|
||||
#define wxTREE_STATE_CUT 0x0040
|
||||
// a callback function used for sorting tree items, it should return -1 if the
|
||||
// first item precedes the second, +1 if the second precedes the first or 0 if
|
||||
// they're equivalent
|
||||
class wxTreeItemData;
|
||||
typedef int (*wxTreeItemCmpFunc)(wxTreeItemData *item1, wxTreeItemData *item2);
|
||||
|
||||
#define wxTREE_HITTEST_ABOVE 0x0001 // Above the client area.
|
||||
#define wxTREE_HITTEST_BELOW 0x0002 // Below the client area.
|
||||
#define wxTREE_HITTEST_NOWHERE 0x0004 // In the client area but below the last item.
|
||||
#define wxTREE_HITTEST_ONITEMBUTTON 0x0010 // On the button associated with an item.
|
||||
#define wxTREE_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item.
|
||||
#define wxTREE_HITTEST_ONITEMINDENT 0x0040 // In the indentation associated with an item.
|
||||
#define wxTREE_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item.
|
||||
#define wxTREE_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item.
|
||||
#define wxTREE_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state.
|
||||
#define wxTREE_HITTEST_TOLEFT 0x0400 // To the right of the client area.
|
||||
#define wxTREE_HITTEST_TORIGHT 0x0800 // To the left of the client area.
|
||||
// ----------------------------------------------------------------------------
|
||||
// constants
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
#define wxTREE_HITTEST_ONITEM (wxTREE_HITTEST_ONITEMICON | wxTREE_HITTEST_ONITEMLABEL | wxTREE_HITTEST_ONITEMSTATEICON)
|
||||
// values for the `flags' parameter of wxTreeCtrl::HitTest() which determine
|
||||
// where exactly the specified point is situated:
|
||||
// above the client area.
|
||||
static const int wxTREE_HITTEST_ABOVE = 0x0001;
|
||||
// below the client area.
|
||||
static const int wxTREE_HITTEST_BELOW = 0x0002;
|
||||
// in the client area but below the last item.
|
||||
static const int wxTREE_HITTEST_NOWHERE = 0x0004;
|
||||
// on the button associated with an item.
|
||||
static const int wxTREE_HITTEST_ONITEMBUTTON = 0x0010;
|
||||
// on the bitmap associated with an item.
|
||||
static const int wxTREE_HITTEST_ONITEMICON = 0x0020;
|
||||
// in the indentation associated with an item.
|
||||
static const int wxTREE_HITTEST_ONITEMINDENT = 0x0040;
|
||||
// on the label (string) associated with an item.
|
||||
static const int wxTREE_HITTEST_ONITEMLABEL = 0x0080;
|
||||
// in the area to the right of an item.
|
||||
static const int wxTREE_HITTEST_ONITEMRIGHT = 0x0100;
|
||||
// on the state icon for a tree view item that is in a user-defined state.
|
||||
static const int wxTREE_HITTEST_ONITEMSTATEICON = 0x0200;
|
||||
// to the right of the client area.
|
||||
static const int wxTREE_HITTEST_TOLEFT = 0x0400;
|
||||
// to the left of the client area.
|
||||
static const int wxTREE_HITTEST_TORIGHT = 0x0800;
|
||||
// anywhere on the item
|
||||
static const int wxTREE_HITTEST_ONITEM = wxTREE_HITTEST_ONITEMICON |
|
||||
wxTREE_HITTEST_ONITEMLABEL |
|
||||
wxTREE_HITTEST_ONITEMSTATEICON;
|
||||
|
||||
// Flags for GetNextItem
|
||||
enum {
|
||||
wxTREE_NEXT_CARET, // Retrieves the currently selected item.
|
||||
wxTREE_NEXT_CHILD, // Retrieves the first child item. The hItem parameter must be NULL.
|
||||
wxTREE_NEXT_DROPHILITE, // Retrieves the item that is the target of a drag-and-drop operation.
|
||||
wxTREE_NEXT_FIRSTVISIBLE, // Retrieves the first visible item.
|
||||
wxTREE_NEXT_NEXT, // Retrieves the next sibling item.
|
||||
wxTREE_NEXT_NEXTVISIBLE, // Retrieves the next visible item that follows the specified item.
|
||||
wxTREE_NEXT_PARENT, // Retrieves the parent of the specified item.
|
||||
wxTREE_NEXT_PREVIOUS, // Retrieves the previous sibling item.
|
||||
wxTREE_NEXT_PREVIOUSVISIBLE, // Retrieves the first visible item that precedes the specified item.
|
||||
wxTREE_NEXT_ROOT // Retrieves the first child item of the root item of which the specified item is a part.
|
||||
};
|
||||
// NB: all the following flags are for compatbility only and will be removed in the
|
||||
// next versions
|
||||
|
||||
// Flags for ExpandItem
|
||||
enum {
|
||||
// flags for deprecated `Expand(int action)'
|
||||
enum
|
||||
{
|
||||
wxTREE_EXPAND_EXPAND,
|
||||
wxTREE_EXPAND_COLLAPSE,
|
||||
wxTREE_EXPAND_COLLAPSE_RESET,
|
||||
wxTREE_EXPAND_TOGGLE
|
||||
};
|
||||
|
||||
// Flags for InsertItem
|
||||
// flags for deprecated InsertItem() variant
|
||||
#define wxTREE_INSERT_FIRST 0xFFFF0001
|
||||
#define wxTREE_INSERT_LAST 0xFFFF0002
|
||||
#define wxTREE_INSERT_SORT 0xFFFF0003
|
||||
|
||||
class WXDLLEXPORT wxTreeItem: public wxObject
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxTreeItemId identifies an element of the tree. In this implementation, it's
|
||||
// just a trivial wrapper around Win32 HTREEITEM. It's opaque for the
|
||||
// application.
|
||||
// ----------------------------------------------------------------------------
|
||||
class WXDLLEXPORT wxTreeItemId
|
||||
{
|
||||
DECLARE_DYNAMIC_CLASS(wxTreeItem)
|
||||
public:
|
||||
long m_mask;
|
||||
long m_itemId;
|
||||
long m_state;
|
||||
long m_stateMask;
|
||||
wxString m_text;
|
||||
int m_image;
|
||||
int m_selectedImage;
|
||||
int m_children;
|
||||
long m_data;
|
||||
// ctors
|
||||
// 0 is invalid value for HTREEITEM
|
||||
wxTreeItemId() { m_itemId = 0; }
|
||||
|
||||
wxTreeItem();
|
||||
// default copy ctor/assignment operator are ok for us
|
||||
|
||||
// Accessors
|
||||
inline long GetMask() const { return m_mask; }
|
||||
inline long GetItemId() const { return m_itemId; }
|
||||
inline long GetState() const { return m_state; }
|
||||
inline long GetStateMask() const { return m_stateMask; }
|
||||
inline wxString GetText() const { return m_text; }
|
||||
inline int GetImage() const { return m_image; }
|
||||
inline int GetSelectedImage() const { return m_selectedImage; }
|
||||
inline int GetChildren() const { return m_children; }
|
||||
inline long GetData() const { return m_data; }
|
||||
// accessors
|
||||
// is this a valid tree item?
|
||||
bool IsOk() const { return m_itemId != 0; }
|
||||
|
||||
inline void SetMask(long mask) { m_mask = mask; }
|
||||
inline void SetItemId(long id) { m_itemId = m_itemId = id; }
|
||||
inline void SetState(long state) { m_state = state; }
|
||||
inline void SetStateMask(long stateMask) { m_stateMask = stateMask; }
|
||||
inline void GetText(const wxString& text) { m_text = text; }
|
||||
inline void SetImage(int image) { m_image = image; }
|
||||
inline void GetSelectedImage(int selImage) { m_selectedImage = selImage; }
|
||||
inline void SetChildren(int children) { m_children = children; }
|
||||
inline void SetData(long data) { m_data = data; }
|
||||
// conversion to/from either real (system-dependent) tree item id or
|
||||
// to "long" which used to be the type for tree item ids in previous
|
||||
// versions of wxWindows
|
||||
|
||||
#ifdef wxHTREEITEM_DEFINED
|
||||
// for wxTreeCtrl usage only
|
||||
wxTreeItemId(HTREEITEM itemId) { m_itemId = (long)itemId; }
|
||||
operator HTREEITEM() const { return (HTREEITEM)m_itemId; }
|
||||
#else // !wxHTREEITEM_DEFINED
|
||||
// deprecated: only for compatibility
|
||||
wxTreeItemId(long itemId) { m_itemId = itemId; }
|
||||
operator long() const { return m_itemId; }
|
||||
#endif // wxHTREEITEM_DEFINED
|
||||
|
||||
protected:
|
||||
long m_itemId;
|
||||
};
|
||||
|
||||
class WXDLLEXPORT wxTreeCtrl: public wxControl
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxTreeItemData is some (arbitrary) user class associated with some item. The
|
||||
// main advantage of having this class (compared to old untyped interface) is
|
||||
// that wxTreeItemData's are destroyed automatically by the tree and, as this
|
||||
// class has virtual dtor, it means that the memory will be automatically
|
||||
// freed. OTOH, we don't just use wxObject instead of wxTreeItemData because
|
||||
// the size of this class is critical: in any real application, each tree leaf
|
||||
// will have wxTreeItemData associated with it and number of leaves may be
|
||||
// quite big.
|
||||
//
|
||||
// Because the objects of this class are deleted by the tree, they should
|
||||
// always be allocated on the heap!
|
||||
// ----------------------------------------------------------------------------
|
||||
class WXDLLEXPORT wxTreeItemData
|
||||
{
|
||||
friend class wxTreeCtrl;
|
||||
public:
|
||||
// creation/destruction
|
||||
// --------------------
|
||||
// default ctor
|
||||
wxTreeItemData() { }
|
||||
|
||||
// default copy ctor/assignment operator are ok
|
||||
|
||||
// dtor is virtual and all the items are deleted by the tree control
|
||||
// when it's deleted, so you normally don't have to care about freeing
|
||||
// memory allocated in your wxTreeItemData-derived class
|
||||
virtual ~wxTreeItemData() { }
|
||||
|
||||
// accessor: get the item associated with us
|
||||
const wxTreeItemId& GetItemId() const { return m_itemId; }
|
||||
|
||||
protected:
|
||||
wxTreeItemId m_itemId;
|
||||
};
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxTreeCtrl
|
||||
// ----------------------------------------------------------------------------
|
||||
class WXDLLEXPORT wxTreeCtrl : public wxControl
|
||||
{
|
||||
public:
|
||||
/*
|
||||
* Public interface
|
||||
*/
|
||||
|
||||
// creation
|
||||
// --------
|
||||
wxTreeCtrl();
|
||||
|
||||
inline wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxTR_HAS_BUTTONS|wxTR_LINES_AT_ROOT,
|
||||
const wxValidator& validator = wxDefaultValidator,
|
||||
const wxString& name = "wxTreeCtrl")
|
||||
wxTreeCtrl() { Init(); }
|
||||
|
||||
wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
|
||||
const wxValidator& validator = wxDefaultValidator,
|
||||
const wxString& name = "wxTreeCtrl")
|
||||
{
|
||||
Create(parent, id, pos, size, style, validator, name);
|
||||
}
|
||||
~wxTreeCtrl();
|
||||
|
||||
|
||||
virtual ~wxTreeCtrl();
|
||||
|
||||
bool Create(wxWindow *parent, wxWindowID id = -1,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxTR_HAS_BUTTONS|wxTR_LINES_AT_ROOT,
|
||||
long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
|
||||
const wxValidator& validator = wxDefaultValidator,
|
||||
const wxString& name = "wxTreeCtrl");
|
||||
|
||||
|
||||
// accessors
|
||||
// ---------
|
||||
//
|
||||
int GetCount() const;
|
||||
|
||||
// indent
|
||||
int GetIndent() const;
|
||||
void SetIndent(int indent);
|
||||
// image list
|
||||
wxImageList *GetImageList(int which = wxIMAGE_LIST_NORMAL) const;
|
||||
void SetImageList(wxImageList *imageList, int which = wxIMAGE_LIST_NORMAL);
|
||||
// get the total number of items in the control
|
||||
size_t GetCount() const;
|
||||
|
||||
// navigation inside the tree
|
||||
long GetNextItem(long item, int code) const;
|
||||
bool ItemHasChildren(long item) const;
|
||||
long GetChild(long item) const;
|
||||
long GetParent(long item) const;
|
||||
long GetFirstVisibleItem() const;
|
||||
long GetNextVisibleItem(long item) const;
|
||||
long GetSelection() const;
|
||||
long GetRootItem() const;
|
||||
// indent is the number of pixels the children are indented relative to
|
||||
// the parents position. SetIndent() also redraws the control
|
||||
// immediately.
|
||||
unsigned int GetIndent() const;
|
||||
void SetIndent(unsigned int indent);
|
||||
|
||||
// generic function for (g|s)etting item attributes
|
||||
bool GetItem(wxTreeItem& info) const;
|
||||
bool SetItem(wxTreeItem& info);
|
||||
// item state
|
||||
int GetItemState(long item, long stateMask) const;
|
||||
bool SetItemState(long item, long state, long stateMask);
|
||||
// item image
|
||||
bool SetItemImage(long item, int image, int selImage);
|
||||
// item text
|
||||
wxString GetItemText(long item) const;
|
||||
void SetItemText(long item, const wxString& str);
|
||||
// custom data associated with the item
|
||||
long GetItemData(long item) const;
|
||||
bool SetItemData(long item, long data);
|
||||
// convenience function
|
||||
bool IsItemExpanded(long item)
|
||||
{
|
||||
return (GetItemState(item, wxTREE_STATE_EXPANDED) &
|
||||
wxTREE_STATE_EXPANDED) != 0;
|
||||
}
|
||||
// image list: these functions allow to associate an image list with
|
||||
// the control and retrieve it. Note that the control does _not_ delete
|
||||
// the associated image list when it's deleted in order to allow image
|
||||
// lists to be shared between different controls.
|
||||
//
|
||||
// The normal image list is for the icons which correspond to the
|
||||
// normal tree item state (whether it is selected or not).
|
||||
// Additionally, the application might choose to show a state icon
|
||||
// which corresponds to an app-defined item state (for example,
|
||||
// checked/unchecked) which are taken from the state image list.
|
||||
wxImageList *GetImageList() const;
|
||||
wxImageList *GetStateImageList() const;
|
||||
|
||||
void SetImageList(wxImageList *imageList);
|
||||
void SetStateImageList(wxImageList *imageList);
|
||||
|
||||
// Functions to work with tree ctrl items. Unfortunately, they can _not_ be
|
||||
// member functions of wxTreeItem because they must know the tree the item
|
||||
// belongs to for Windows implementation and storing the pointer to
|
||||
// wxTreeCtrl in each wxTreeItem is just too much waste.
|
||||
|
||||
// accessors
|
||||
// ---------
|
||||
|
||||
// retrieve items label
|
||||
wxString GetItemText(const wxTreeItemId& item) const;
|
||||
// get the normal item image
|
||||
int GetItemImage(const wxTreeItemId& item) const;
|
||||
// get the selected item image
|
||||
int GetItemSelectedImage(const wxTreeItemId& item) const;
|
||||
// get the data associated with the item
|
||||
wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
|
||||
|
||||
// modifiers
|
||||
// ---------
|
||||
|
||||
// set items label
|
||||
void SetItemText(const wxTreeItemId& item, const wxString& text);
|
||||
// set the normal item image
|
||||
void SetItemImage(const wxTreeItemId& item, int image);
|
||||
// set the selected item image
|
||||
void SetItemSelectedImage(const wxTreeItemId& item, int image);
|
||||
// associate some data with the item
|
||||
void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
|
||||
|
||||
// item status inquiries
|
||||
// ---------------------
|
||||
|
||||
// is the item visible (it might be outside the view or not expanded)?
|
||||
bool IsVisible(const wxTreeItemId& item) const;
|
||||
// does the item has any children?
|
||||
bool ItemHasChildren(const wxTreeItemId& item) const;
|
||||
// is the item expanded (only makes sense if HasChildren())?
|
||||
bool IsExpanded(const wxTreeItemId& item) const;
|
||||
// is this item currently selected (the same as has focus)?
|
||||
bool IsSelected(const wxTreeItemId& item) const;
|
||||
|
||||
// navigation
|
||||
// ----------
|
||||
|
||||
// wxTreeItemId.IsOk() will return FALSE if there is no such item
|
||||
|
||||
// get the root tree item
|
||||
wxTreeItemId GetRootItem() const;
|
||||
|
||||
// get the item currently selected (may return NULL if no selection)
|
||||
wxTreeItemId GetSelection() const;
|
||||
|
||||
// get the parent of this item (may return NULL if root)
|
||||
wxTreeItemId GetParent(const wxTreeItemId& item) const;
|
||||
|
||||
// for this enumeration function you must pass in a "cookie" parameter
|
||||
// which is opaque for the application but is necessary for the library
|
||||
// to make these functions reentrant (i.e. allow more than one
|
||||
// enumeration on one and the same object simultaneously). Of course,
|
||||
// the "cookie" passed to GetFirstChild() and GetNextChild() should be
|
||||
// the same!
|
||||
|
||||
// get the first child of this item
|
||||
wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& cookie) const;
|
||||
// get the next child
|
||||
wxTreeItemId GetNextChild(const wxTreeItemId& item, long& cookie) const;
|
||||
|
||||
// get the next sibling of this item
|
||||
wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
|
||||
// get the previous sibling
|
||||
wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
|
||||
|
||||
// get first visible item
|
||||
wxTreeItemId GetFirstVisibleItem() const;
|
||||
// get the next visible item: item must be visible itself!
|
||||
// see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
|
||||
wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
|
||||
// get the previous visible item: item must be visible itself!
|
||||
wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
|
||||
|
||||
// bounding rect
|
||||
bool GetItemRect(long item, wxRectangle& rect, bool textOnly = FALSE) const;
|
||||
//
|
||||
wxTextCtrl* GetEditControl() const;
|
||||
|
||||
// operations
|
||||
// ----------
|
||||
// adding/deleting items
|
||||
bool DeleteItem(long item);
|
||||
long InsertItem(long parent, wxTreeItem& info,
|
||||
long insertAfter = wxTREE_INSERT_LAST);
|
||||
// If image > -1 and selImage == -1, the same image is used for
|
||||
// both selected and unselected items.
|
||||
long InsertItem(long parent, const wxString& label,
|
||||
int image = -1, int selImage = -1,
|
||||
long insertAfter = wxTREE_INSERT_LAST);
|
||||
|
||||
// changing item state
|
||||
bool ExpandItem(long item) { return ExpandItem(item, wxTREE_EXPAND_EXPAND); }
|
||||
bool CollapseItem(long item) { return ExpandItem(item, wxTREE_EXPAND_COLLAPSE); }
|
||||
bool ToggleItem(long item) { return ExpandItem(item, wxTREE_EXPAND_TOGGLE); }
|
||||
// common interface for {Expand|Collapse|Toggle}Item
|
||||
bool ExpandItem(long item, int action);
|
||||
|
||||
//
|
||||
bool SelectItem(long item);
|
||||
bool ScrollTo(long item);
|
||||
bool DeleteAllItems();
|
||||
// add the root node to the tree
|
||||
wxTreeItemId AddRoot(const wxString& text,
|
||||
int image = -1, int selectedImage = -1,
|
||||
wxTreeItemData *data = NULL);
|
||||
|
||||
// Edit the label (tree must have the focus)
|
||||
wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
|
||||
// insert a new item in as the first child of the parent
|
||||
wxTreeItemId PrependItem(const wxTreeItemId& parent,
|
||||
const wxString& text,
|
||||
int image = -1, int selectedImage = -1,
|
||||
wxTreeItemData *data = NULL);
|
||||
|
||||
// End label editing, optionally cancelling the edit
|
||||
bool EndEditLabel(bool cancel);
|
||||
// insert a new item after a given one
|
||||
wxTreeItemId InsertItem(const wxTreeItemId& parent,
|
||||
const wxTreeItemId& idPrevious,
|
||||
const wxString& text,
|
||||
int image = -1, int selectedImage = -1,
|
||||
wxTreeItemData *data = NULL);
|
||||
|
||||
long HitTest(const wxPoint& point, int& flags);
|
||||
// wxImageList *CreateDragImage(long item);
|
||||
bool SortChildren(long item);
|
||||
bool EnsureVisible(long item);
|
||||
|
||||
// IMPLEMENTATION
|
||||
// insert a new item in as the last child of the parent
|
||||
wxTreeItemId AppendItem(const wxTreeItemId& parent,
|
||||
const wxString& text,
|
||||
int image = -1, int selectedImage = -1,
|
||||
wxTreeItemData *data = NULL);
|
||||
|
||||
// delete this item and associated data if any
|
||||
void Delete(const wxTreeItemId& item);
|
||||
// delete all items from the tree
|
||||
void DeleteAllItems();
|
||||
|
||||
// expand this item
|
||||
void Expand(const wxTreeItemId& item);
|
||||
// collapse the item without removing its children
|
||||
void Collapse(const wxTreeItemId& item);
|
||||
// collapse the item and remove all children
|
||||
void CollapseAndReset(const wxTreeItemId& item);
|
||||
// toggles the current state
|
||||
void Toggle(const wxTreeItemId& item);
|
||||
|
||||
// remove the selection from currently selected item (if any)
|
||||
void Unselect();
|
||||
// select this item
|
||||
void SelectItem(const wxTreeItemId& item);
|
||||
// make sure this item is visible (expanding the parent item and/or
|
||||
// scrolling to this item if necessary)
|
||||
void EnsureVisible(const wxTreeItemId& item);
|
||||
// scroll to this item (but don't expand its parent)
|
||||
void ScrollTo(const wxTreeItemId& item);
|
||||
|
||||
// start editing the item label: this (temporarily) replaces the item
|
||||
// with a one line edit control. The item will be selected if it hadn't
|
||||
// been before. textCtrlClass parameter allows you to create an edit
|
||||
// control of arbitrary user-defined class deriving from wxTextCtrl.
|
||||
wxTextCtrl* EditLabel(const wxTreeItemId& item,
|
||||
wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
|
||||
// returns the same pointer as StartEdit() if the item is being edited,
|
||||
// NULL otherwise (it's assumed that no more than one item may be
|
||||
// edited simultaneously)
|
||||
wxTextCtrl* GetEditControl() const;
|
||||
// end editing and accept or discard the changes to item label
|
||||
void EndEditLabel(const wxTreeItemId& item, bool discardChanges = FALSE);
|
||||
|
||||
// sort the children of this item using the specified callback function
|
||||
// (it should return -1, 0 or +1 as usual), if it's not specified
|
||||
// alphabetical comparaison is performed.
|
||||
//
|
||||
// NB: this function is not reentrant!
|
||||
void SortChildren(const wxTreeItemId& item,
|
||||
wxTreeItemCmpFunc *cmpFunction = NULL);
|
||||
|
||||
// helpers
|
||||
// -------
|
||||
|
||||
// @@@ do we really need to expose these functions to the application?
|
||||
|
||||
// get the bounding rectangle of the item (or of its label only)
|
||||
void GetBoundingRect(const wxTreeItemId& item,
|
||||
wxRectangle& rect,
|
||||
bool textOnly = FALSE) const;
|
||||
|
||||
// determine to which item (if any) belongs the given point (the
|
||||
// coordinates specified are relative to the client area of tree ctrl)
|
||||
// and fill the flags parameter with a bitmask of wxTREE_HITTEST_xxx
|
||||
// constants
|
||||
wxTreeItemId HitTest(const wxPoint& point, int& flags);
|
||||
|
||||
// deprecated
|
||||
// ----------
|
||||
|
||||
// these methods are deprecated and will be removed in future versions of
|
||||
// wxWindows, they're here for compatibility only, don't use them in new
|
||||
// code (the comments indicate why these methods are now useless and how to
|
||||
// replace them)
|
||||
|
||||
// use Expand, Collapse, CollapseAndReset or Toggle
|
||||
void ExpandItem(const wxTreeItemId& item, int action);
|
||||
|
||||
// use AddRoot, PrependItem or AppendItem
|
||||
wxTreeItemId InsertItem(const wxTreeItemId& parent,
|
||||
const wxString& text,
|
||||
int image = -1, int selImage = -1,
|
||||
long insertAfter = wxTREE_INSERT_LAST);
|
||||
|
||||
// use Set/GetImageList and Set/GetStateImageList
|
||||
wxImageList *GetImageList(int) const
|
||||
{ return GetImageList(); }
|
||||
void SetImageList(wxImageList *imageList, int)
|
||||
{ SetImageList(imageList); }
|
||||
|
||||
// implementation
|
||||
// --------------
|
||||
void Command(wxCommandEvent& event) { ProcessCommand(event); };
|
||||
bool MSWCommand(WXUINT param, WXWORD id);
|
||||
bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam);
|
||||
|
||||
|
||||
protected:
|
||||
wxTextCtrl* m_textCtrl;
|
||||
wxImageList* m_imageListNormal;
|
||||
wxImageList* m_imageListState;
|
||||
// SetImageList helper
|
||||
void SetAnyImageList(wxImageList *imageList, int which);
|
||||
|
||||
wxTextCtrl* m_textCtrl; // used while editing the item label
|
||||
wxImageList *m_imageListNormal, // images for tree elements
|
||||
*m_imageListState; // special images for app defined states
|
||||
|
||||
private:
|
||||
// the common part of all ctors
|
||||
void Init();
|
||||
|
||||
// helper functions
|
||||
inline bool DoGetItem(wxTreeViewItem *tvItem) const;
|
||||
inline void DoSetItem(wxTreeViewItem *tvItem);
|
||||
|
||||
inline void DoExpand(const wxTreeItemId& item, int flag);
|
||||
|
||||
wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
|
||||
wxTreeItemId hInsertAfter,
|
||||
const wxString& text,
|
||||
int image, int selectedImage,
|
||||
wxTreeItemData *data);
|
||||
|
||||
void DeleteTextCtrl();
|
||||
|
||||
DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
|
||||
};
|
||||
|
||||
/*
|
||||
wxEVT_COMMAND_TREE_BEGIN_DRAG,
|
||||
wxEVT_COMMAND_TREE_BEGIN_RDRAG,
|
||||
wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
|
||||
wxEVT_COMMAND_TREE_END_LABEL_EDIT,
|
||||
wxEVT_COMMAND_TREE_DELETE_ITEM,
|
||||
wxEVT_COMMAND_TREE_GET_INFO,
|
||||
wxEVT_COMMAND_TREE_SET_INFO,
|
||||
wxEVT_COMMAND_TREE_ITEM_EXPANDED,
|
||||
wxEVT_COMMAND_TREE_ITEM_EXPANDING,
|
||||
wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
|
||||
wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
|
||||
wxEVT_COMMAND_TREE_SEL_CHANGED,
|
||||
wxEVT_COMMAND_TREE_SEL_CHANGING,
|
||||
wxEVT_COMMAND_TREE_KEY_DOWN
|
||||
*/
|
||||
|
||||
class WXDLLEXPORT wxTreeEvent: public wxCommandEvent
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxTreeEvent is a special class for all events associated with tree controls
|
||||
//
|
||||
// NB: note that not all accessors make sense for all events, see the event
|
||||
// descriptions below
|
||||
// ----------------------------------------------------------------------------
|
||||
class WXDLLEXPORT wxTreeEvent : public wxCommandEvent
|
||||
{
|
||||
DECLARE_DYNAMIC_CLASS(wxTreeEvent)
|
||||
friend wxTreeCtrl;
|
||||
public:
|
||||
wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
|
||||
|
||||
public:
|
||||
wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
|
||||
// accessors
|
||||
// get the item on which the operation was performed or the newly
|
||||
// selected item for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events
|
||||
wxTreeItemId GetItem() const { return m_item; }
|
||||
|
||||
int m_code;
|
||||
wxTreeItem m_item;
|
||||
long m_oldItem;
|
||||
wxPoint m_pointDrag;
|
||||
// for wxEVT_COMMAND_TREE_SEL_CHANGED/ING events, get the previously
|
||||
// selected item
|
||||
wxTreeItemId GetOldItem() const { return m_itemOld; }
|
||||
|
||||
inline long GetOldItem() const { return m_oldItem; }
|
||||
inline wxTreeItem& GetItem() const { return (wxTreeItem&) m_item; }
|
||||
inline wxPoint GetPoint() const { return m_pointDrag; }
|
||||
inline int GetCode() const { return m_code; }
|
||||
// the point where the mouse was when the drag operation started (for
|
||||
// wxEVT_COMMAND_TREE_BEGIN_(R)DRAG events only)
|
||||
wxPoint GetPoint() const { return m_pointDrag; }
|
||||
|
||||
// keyboard code (for wxEVT_COMMAND_TREE_KEY_DOWN only)
|
||||
int GetCode() const { return m_code; }
|
||||
|
||||
// set return code for wxEVT_COMMAND_TREE_ITEM_{EXPAND|COLLAPS}ING events
|
||||
// call this to forbid the change in item status
|
||||
void Veto() { m_code = TRUE; }
|
||||
|
||||
private:
|
||||
// @@ we could save some space by using union here
|
||||
int m_code;
|
||||
wxTreeItemId m_item,
|
||||
m_itemOld;
|
||||
wxPoint m_pointDrag;
|
||||
|
||||
DECLARE_DYNAMIC_CLASS(wxTreeEvent)
|
||||
};
|
||||
|
||||
typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// macros for handling tree control events
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
// GetItem() returns the item being dragged, GetPoint() the mouse coords
|
||||
#define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
#define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
|
||||
// GetItem() returns the itme whose label is being edited
|
||||
#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
#define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
#define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
|
||||
// provide/update information about GetItem() item
|
||||
#define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
#define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
|
||||
// GetItem() is the item being expanded/collapsed, the "ING" versions can use
|
||||
#define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
#define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
#define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
#define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
|
||||
|
||||
// GetOldItem() is the item which had the selection previously, GetItem() is
|
||||
// the item which acquires selection
|
||||
#define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
|
||||
#define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
|
||||
|
||||
// GetCode() returns the key code
|
||||
// NB: this is the only message for which GetItem() is invalid (you may get the
|
||||
// item from GetSelection())
|
||||
#define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
|
||||
|
||||
// GetItem() returns the item being deleted, the associated data (if any) will
|
||||
// be deleted just after the return of this event handler (if any)
|
||||
#define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, (wxObject *) NULL },
|
||||
|
||||
#endif
|
||||
// _WX_TREECTRL_H_
|
||||
|
1545
src/msw/treectrl.cpp
1545
src/msw/treectrl.cpp
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user