/////////////////////////////////////////////////////////////////////////////
-// Name: treectrl.h
+// Name: wx/generic/treectlg.h
// Purpose: wxTreeCtrl class
// Author: Robert Roebling
// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) 1997,1998 Robert Roebling
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _GENERIC_TREECTRL_H_
#define _GENERIC_TREECTRL_H_
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "treectlg.h"
#endif
#if wxUSE_TREECTRL
-#include "wx/defs.h"
-#include "wx/string.h"
-#include "wx/object.h"
-#include "wx/event.h"
#include "wx/scrolwin.h"
-#include "wx/textctrl.h"
#include "wx/pen.h"
-#include "wx/dynarray.h"
-#include "wx/timer.h"
-#include "wx/treebase.h"
+#include "wx/imaglist.h"
// -----------------------------------------------------------------------------
// forward declaration
// -----------------------------------------------------------------------------
-class WXDLLEXPORT wxImageList;
class WXDLLEXPORT wxGenericTreeItem;
class WXDLLEXPORT wxTreeItemData;
class WXDLLEXPORT wxTreeRenameTimer;
+class WXDLLEXPORT wxTreeFindTimer;
class WXDLLEXPORT wxTreeTextCtrl;
+class WXDLLEXPORT wxTextCtrl;
// -----------------------------------------------------------------------------
// wxGenericTreeCtrl - the tree control
// --------
wxGenericTreeCtrl() { Init(); }
- wxGenericTreeCtrl(wxWindow *parent, wxWindowID id = -1,
+ wxGenericTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
-#ifdef __WXMAC__
- long style = wxTR_MAC_BUTTONS | wxTR_NO_LINES | wxTR_ROW_LINES,
-#else
- long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
-#endif
+ long style = wxTR_DEFAULT_STYLE,
const wxValidator &validator = wxDefaultValidator,
const wxString& name = wxTreeCtrlNameStr)
{
virtual ~wxGenericTreeCtrl();
- bool Create(wxWindow *parent, wxWindowID id = -1,
+ bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
-#ifdef __WXMAC__
- long style = wxTR_MAC_BUTTONS | wxTR_NO_LINES | wxTR_ROW_LINES,
-#else
- long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
-#endif
+ long style = wxTR_DEFAULT_STYLE,
const wxValidator &validator = wxDefaultValidator,
const wxString& name = wxTreeCtrlNameStr);
void SetSpacing(unsigned int spacing);
// image list: these functions allow to associate an image list with
- // the control and retrieve it. Note that when assigned with
+ // the control and retrieve it. Note that when assigned with
// SetImageList, 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. If you use
+ // lists to be shared between different controls. If you use
// AssignImageList, the control _does_ delete the image list.
//
// The normal image list is for the icons which correspond to the
// 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;
+ virtual wxImageList *GetImageList() const;
+ virtual wxImageList *GetStateImageList() const;
+ virtual wxImageList *GetButtonsImageList() const;
- void SetImageList(wxImageList *imageList);
- void SetStateImageList(wxImageList *imageList);
- void AssignImageList(wxImageList *imageList);
- void AssignStateImageList(wxImageList *imageList);
+ virtual void SetImageList(wxImageList *imageList);
+ virtual void SetStateImageList(wxImageList *imageList);
+ virtual void SetButtonsImageList(wxImageList *imageList);
+ virtual void AssignImageList(wxImageList *imageList);
+ virtual void AssignStateImageList(wxImageList *imageList);
+ virtual void AssignButtonsImageList(wxImageList *imageList);
+
+ virtual void SetDropEffectAboveItem( bool above = false ) { m_dropEffectAboveItem = above; }
+ virtual bool GetDropEffectAboveItem() const { return m_dropEffectAboveItem; }
// Functions to work with tree ctrl items.
// accessors
// ---------
- // retrieve items label
+ // retrieve item's label
wxString GetItemText(const wxTreeItemId& item) const;
// get one of the images associated with the item (normal by default)
- int GetItemImage(const wxTreeItemId& item,
+ virtual int GetItemImage(const wxTreeItemId& item,
wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
// get the data associated with the item
wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
+ // get the item's text colour
+ wxColour GetItemTextColour(const wxTreeItemId& item) const;
+
+ // get the item's background colour
+ wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
+
+ // get the item's font
+ wxFont GetItemFont(const wxTreeItemId& item) const;
+
// modifiers
// ---------
- // set items label
+ // set item's label
void SetItemText(const wxTreeItemId& item, const wxString& text);
// get one of the images associated with the item (normal by default)
- void SetItemImage(const wxTreeItemId& item, int image,
+ virtual void SetItemImage(const wxTreeItemId& item, int image,
wxTreeItemIcon which = wxTreeItemIcon_Normal);
// associate some data with the item
void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
// allow the user to expand the items which don't have any children now
// - but instead add them only when needed, thus minimizing memory
// usage and loading time.
- void SetItemHasChildren(const wxTreeItemId& item, bool has = TRUE);
+ void SetItemHasChildren(const wxTreeItemId& item, bool has = true);
// the item will be shown in bold
- void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
+ void SetItemBold(const wxTreeItemId& item, bool bold = true);
- // set the items text colour
+ // the item will be shown with a drop highlight
+ void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = true);
+
+ // set the item's text colour
void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
- // set the items background colour
+ // set the item's background colour
void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
- // set the items font (should be of the same height for all items)
+ // set the item's font (should be of the same height for all items)
void SetItemFont(const wxTreeItemId& item, const wxFont& font);
// set the window font
virtual bool SetFont( const wxFont &font );
+ // set the styles. No need to specify a GetWindowStyle here since
+ // the base wxWindow member function will do it for us
+ void SetWindowStyle(const long styles);
+
// item status inquiries
// ---------------------
bool IsSelected(const wxTreeItemId& item) const;
// is item text in bold font?
bool IsBold(const wxTreeItemId& item) const;
+ // does the layout include space for a button?
// number of children
// ------------------
- // if 'recursively' is FALSE, only immediate children count, otherwise
+ // if 'recursively' is false, only immediate children count, otherwise
// the returned number is the number of all items in this branch
- size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
+ size_t GetChildrenCount(const wxTreeItemId& item,
+ bool recursively = true) const;
// navigation
// ----------
- // wxTreeItemId.IsOk() will return FALSE if there is no such item
+ // wxTreeItemId.IsOk() will return false if there is no such item
// get the root tree item
wxTreeItemId GetRootItem() const { return m_anchor; }
size_t GetSelections(wxArrayTreeItemIds&) const;
// get the parent of this item (may return NULL if root)
- wxTreeItemId GetParent(const wxTreeItemId& item) const;
+ wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
+
+#if WXWIN_COMPATIBILITY_2_2
+ // deprecated: Use GetItemParent instead.
+ wxDEPRECATED( wxTreeItemId GetParent(const wxTreeItemId& item) const);
+
+ // Expose the base class method hidden by the one above. Not deprecatable.
+ wxWindow *GetParent() const { return wxScrolledWindow::GetParent(); }
+#endif // WXWIN_COMPATIBILITY_2_2
// for this enumeration function you must pass in a "cookie" parameter
// which is opaque for the application but is necessary for the library
// the same!
// get the first child of this item
- wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& cookie) const;
+ wxTreeItemId GetFirstChild(const wxTreeItemId& item,
+ wxTreeItemIdValue& cookie) const;
// get the next child
- wxTreeItemId GetNextChild(const wxTreeItemId& item, long& cookie) const;
+ wxTreeItemId GetNextChild(const wxTreeItemId& item,
+ wxTreeItemIdValue& cookie) const;
// get the last child of this item - this method doesn't use cookies
wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
// Only for internal use right now, but should probably be public
wxTreeItemId GetNext(const wxTreeItemId& item) const;
- wxTreeItemId GetPrev(const wxTreeItemId& item) const;
// operations
// ----------
// add the root node to the tree
- wxTreeItemId AddRoot(const wxString& text,
+ virtual wxTreeItemId AddRoot(const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// insert a new item in as the first child of the parent
- wxTreeItemId PrependItem(const wxTreeItemId& parent,
+ virtual wxTreeItemId PrependItem(const wxTreeItemId& parent,
const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// insert a new item after a given one
- wxTreeItemId InsertItem(const wxTreeItemId& parent,
+ virtual wxTreeItemId InsertItem(const wxTreeItemId& parent,
const wxTreeItemId& idPrevious,
const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// insert a new item before the one with the given index
- wxTreeItemId InsertItem(const wxTreeItemId& parent,
+ virtual wxTreeItemId InsertItem(const wxTreeItemId& parent,
size_t index,
const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// insert a new item in as the last child of the parent
- wxTreeItemId AppendItem(const wxTreeItemId& parent,
+ virtual wxTreeItemId AppendItem(const wxTreeItemId& parent,
const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// remove the selection from currently selected item (if any)
void Unselect();
+ // or from the given one (multiselect mode only)
+ void UnselectItem(const wxTreeItemId& item) { SelectItem(item, false); }
+ // or from all
void UnselectAll();
// select this item
- void SelectItem(const wxTreeItemId& item, bool unselect_others=TRUE, bool extended_select=FALSE);
+ void SelectItem(const wxTreeItemId& item, bool select = true);
+ // toggle the item selection
+ void ToggleItemSelection(const wxTreeItemId& item)
+ {
+ SelectItem(item, !IsSelected(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);
+ void AdjustMyScrollbars();
// The first function is more portable (because easier to implement
// on other platforms), but the second one returns some extra info.
// get the bounding rectangle of the item (or of its label only)
bool GetBoundingRect(const wxTreeItemId& item,
wxRect& rect,
- bool textOnly = FALSE) const;
+ bool textOnly = false) const;
// 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.
void EditLabel( const wxTreeItemId& item ) { Edit( item ); }
void Edit( const wxTreeItemId& item );
+ // returns a pointer to the text edit control if the item is being
+ // edited, NULL otherwise (it's assumed that no more than one item may
+ // be edited simultaneously)
+ wxTextCtrl* GetEditControl() const;
// sorting
// this function is called to compare 2 items and should return -1, 0
// NB: this function is not reentrant and not MT-safe (FIXME)!
void SortChildren(const wxTreeItemId& item);
+#if WXWIN_COMPATIBILITY_2_4
// deprecated functions: use Set/GetItemImage directly
- // get the selected item image
- int GetItemSelectedImage(const wxTreeItemId& item) const
- { return GetItemImage(item, wxTreeItemIcon_Selected); }
- // set the selected item image
- void SetItemSelectedImage(const wxTreeItemId& item, int image)
- { SetItemImage(item, image, wxTreeItemIcon_Selected); }
+ wxDEPRECATED( int GetItemSelectedImage(const wxTreeItemId& item) const );
+ wxDEPRECATED( void SetItemSelectedImage(const wxTreeItemId& item, int image) );
+
+ // use the versions taking wxTreeItemIdValue cookies (note that
+ // GetNextChild() is not inside wxDEPRECATED on purpose, as otherwise we
+ // get twice as many warnings without any added benefit: it is always used
+ // with GetFirstChild() anyhow)
+ wxDEPRECATED( wxTreeItemId GetFirstChild(const wxTreeItemId& item,
+ long& cookie) const );
+ wxTreeItemId GetNextChild(const wxTreeItemId& item,
+ long& cookie) const;
+#endif // WXWIN_COMPATIBILITY_2_4
+
+ virtual bool ShouldInheritColours() const { return false; }
// implementation only from now on
+ // overridden base class virtuals
+ virtual bool SetBackgroundColour(const wxColour& colour);
+ virtual bool SetForegroundColour(const wxColour& colour);
+
+ virtual void Freeze();
+ virtual void Thaw();
+
// callbacks
void OnPaint( wxPaintEvent &event );
void OnSetFocus( wxFocusEvent &event );
void OnKillFocus( wxFocusEvent &event );
void OnChar( wxKeyEvent &event );
void OnMouse( wxMouseEvent &event );
- void OnIdle( wxIdleEvent &event );
+ void OnGetToolTip( wxTreeEvent &event );
+ void OnInternalIdle( );
- // implementation helpers
- void SendDeleteEvent(wxGenericTreeItem *itemBeingDeleted);
+ virtual wxSize DoGetBestSize() const;
- void DrawBorder(const wxTreeItemId& item);
- void DrawLine(const wxTreeItemId& item, bool below);
+ virtual wxVisualAttributes GetDefaultAttributes() const
+ {
+ return GetClassDefaultAttributes(GetWindowVariant());
+ }
+
+ static wxVisualAttributes
+ GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+ // implementation helpers
protected:
friend class wxGenericTreeItem;
friend class wxTreeRenameTimer;
+ friend class wxTreeFindTimer;
friend class wxTreeTextCtrl;
wxFont m_normalFont;
wxFont m_boldFont;
wxGenericTreeItem *m_anchor;
- wxGenericTreeItem *m_current, *m_key_current, *m_currentEdit;
- bool m_hasFocus;
- bool m_dirty;
- int m_xScroll,m_yScroll;
- unsigned int m_indent;
- unsigned int m_spacing;
+ wxGenericTreeItem *m_current,
+ *m_key_current,
+ // A hint to select a parent item after deleting a child
+ *m_select_me;
+ unsigned short m_indent;
+ unsigned short m_spacing;
int m_lineHeight;
wxPen m_dottedPen;
- wxBrush *m_hilightBrush;
+ wxBrush *m_hilightBrush,
+ *m_hilightUnfocusedBrush;
+ bool m_hasFocus;
+ bool m_dirty;
+ bool m_ownsImageListNormal,
+ m_ownsImageListState,
+ m_ownsImageListButtons;
+ bool m_isDragging; // true between BEGIN/END drag events
+ bool m_lastOnSame; // last click on the same item as prev
wxImageList *m_imageListNormal,
- *m_imageListState;
- bool m_ownsImageListNormal,
- m_ownsImageListState;
+ *m_imageListState,
+ *m_imageListButtons;
+ int m_freezeCount;
int m_dragCount;
wxPoint m_dragStart;
- bool m_isDragging; // true between BEGIN/END drag events
wxGenericTreeItem *m_dropTarget;
wxCursor m_oldCursor; // cursor is changed while dragging
wxGenericTreeItem *m_oldSelection;
+ wxGenericTreeItem *m_underMouse; // for visual effects
+ wxTreeTextCtrl *m_textCtrl;
wxTimer *m_renameTimer;
- bool m_renameAccept;
- bool m_lastOnSame; // last click on the same item as prev
- wxString m_renameRes;
+
+ // incremental search data
+ wxString m_findPrefix;
+ wxTimer *m_findTimer;
+
+ bool m_dropEffectAboveItem;
// the common part of all ctors
void Init();
// misc helpers
+ void SendDeleteEvent(wxGenericTreeItem *itemBeingDeleted);
+
+ void DrawBorder(const wxTreeItemId& item);
+ void DrawLine(const wxTreeItemId& item, bool below);
+ void DrawDropEffect(wxGenericTreeItem *item);
+
+ void DoSelectItem(const wxTreeItemId& id,
+ bool unselect_others = true,
+ bool extended_select = false);
+
wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
size_t previous,
const wxString& text,
int image, int selectedImage,
wxTreeItemData *data);
-public:
- void AdjustMyScrollbars();
-protected:
+ // called by wxTextTreeCtrl when it marks itself for deletion
+ void ResetTextControl();
+
+ // find the first item starting with the given prefix after the given item
+ wxTreeItemId FindItem(const wxTreeItemId& id, const wxString& prefix) const;
+
+ bool HasButtons() const { return HasFlag(wxTR_HAS_BUTTONS); }
+
+ void CalculateLineHeight();
int GetLineHeight(wxGenericTreeItem *item) const;
void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
void PaintItem( wxGenericTreeItem *item, wxDC& dc);
void RefreshSubtree( wxGenericTreeItem *item );
void RefreshLine( wxGenericTreeItem *item );
+ // redraw all selected items
+ void RefreshSelected();
+
+ // RefreshSelected() recursive helper
+ void RefreshSelectedUnder(wxGenericTreeItem *item);
+
void OnRenameTimer();
- void OnRenameAccept();
+ bool OnRenameAccept(wxGenericTreeItem *item, const wxString& value);
+ void OnRenameCancelled(wxGenericTreeItem *item);
void FillArray(wxGenericTreeItem*, wxArrayTreeItemIds&) const;
void SelectItemRange( wxGenericTreeItem *item1, wxGenericTreeItem *item2 );
bool TagAllChildrenUntilLast(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
bool TagNextChildren(wxGenericTreeItem *crt_item, wxGenericTreeItem *last_item, bool select);
void UnselectAllChildren( wxGenericTreeItem *item );
-
- void DrawDropEffect(wxGenericTreeItem *item);
+ void ChildrenClosing(wxGenericTreeItem* item);
private:
DECLARE_EVENT_TABLE()
DECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl)
+ DECLARE_NO_COPY_CLASS(wxGenericTreeCtrl)
};
-#if !defined(__WXMSW__) || defined(__WIN16__)
+#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
/*
* wxTreeCtrl has to be a real class or we have problems with
* the run-time information.
class WXDLLEXPORT wxTreeCtrl: public wxGenericTreeCtrl
{
-public:
DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
+public:
wxTreeCtrl() {}
- wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
+ wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
+ long style = wxTR_DEFAULT_STYLE,
const wxValidator &validator = wxDefaultValidator,
const wxString& name = wxTreeCtrlNameStr)
+ : wxGenericTreeCtrl(parent, id, pos, size, style, validator, name)
{
- Create(parent, id, pos, size, style, validator, name);
}
-
};
-
-#endif
+#endif // !__WXMSW__ || __WXUNIVERSAL__
#endif // wxUSE_TREECTRL
projects / wxWidgets.git / blobdiff