X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2ecf902bc836f2808444b34eff48cdb12f289460..763163a80ae0d5a0684633e72f928302578c1214:/include/wx/treebase.h diff --git a/include/wx/treebase.h b/include/wx/treebase.h index c7c9aef476..a3a75922a5 100644 --- a/include/wx/treebase.h +++ b/include/wx/treebase.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: treebase.h +// Name: wx/treebase.h // Purpose: wxTreeCtrl base classes and types // Author: Julian Smart et al // Modified by: @@ -12,10 +12,6 @@ #ifndef _WX_TREEBASE_H_ #define _WX_TREEBASE_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "treebase.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- @@ -28,6 +24,19 @@ #include "wx/event.h" #include "wx/dynarray.h" +#if WXWIN_COMPATIBILITY_2_6 + +// flags for deprecated `Expand(int action)', will be removed in next versions +enum +{ + wxTREE_EXPAND_EXPAND, + wxTREE_EXPAND_COLLAPSE, + wxTREE_EXPAND_COLLAPSE_RESET, + wxTREE_EXPAND_TOGGLE +}; + +#endif // WXWIN_COMPATIBILITY_2_6 + // ---------------------------------------------------------------------------- // wxTreeItemId identifies an element of the tree. In this implementation, it's // just a trivial wrapper around Win32 HTREEITEM or a pointer to some private @@ -38,7 +47,7 @@ // Using this typedef removes an ambiguity when calling Remove() typedef void *wxTreeItemIdValue; -class WXDLLEXPORT wxTreeItemId +class WXDLLIMPEXP_CORE wxTreeItemId { friend bool operator==(const wxTreeItemId&, const wxTreeItemId&); public: @@ -61,13 +70,7 @@ public: // invalidate the item void Unset() { m_pItem = 0; } -#if WXWIN_COMPATIBILITY_2_4 - // deprecated: only for compatibility, don't work on 64 bit archs - wxTreeItemId(long item) { m_pItem = wxUIntToPtr(item); } - operator long() const { return (long)wxPtrToUInt(m_pItem); } -#else // !WXWIN_COMPATIBILITY_2_4 operator bool() const { return IsOk(); } -#endif // WXWIN_COMPATIBILITY_2_4/!WXWIN_COMPATIBILITY_2_4 wxTreeItemIdValue m_pItem; }; @@ -96,10 +99,10 @@ inline bool operator!=(const wxTreeItemId& i1, const wxTreeItemId& i2) // always be allocated on the heap! // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTreeItemData: public wxClientData +class WXDLLIMPEXP_CORE wxTreeItemData: public wxClientData { -friend class WXDLLEXPORT wxTreeCtrl; -friend class WXDLLEXPORT wxGenericTreeCtrl; +friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl; +friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl; public: // creation/destruction // -------------------- @@ -118,11 +121,19 @@ protected: WX_DEFINE_EXPORTED_ARRAY_PTR(wxTreeItemIdValue, wxArrayTreeItemIdsBase); -class WXDLLEXPORT wxArrayTreeItemIds : public wxArrayTreeItemIdsBase +// this is a wrapper around the array class defined above which allow to wok +// with vaue of natural wxTreeItemId type instead of using wxTreeItemIdValue +// and does it without any loss of efficiency +class WXDLLIMPEXP_CORE wxArrayTreeItemIds : public wxArrayTreeItemIdsBase { public: void Add(const wxTreeItemId& id) { wxArrayTreeItemIdsBase::Add(id.m_pItem); } + void Insert(const wxTreeItemId& id, size_t pos) + { wxArrayTreeItemIdsBase::Insert(id.m_pItem, pos); } + wxTreeItemId Item(size_t i) const + { return wxTreeItemId(wxArrayTreeItemIdsBase::Item(i)); } + wxTreeItemId operator[](size_t i) const { return Item(i); } }; // ---------------------------------------------------------------------------- @@ -139,6 +150,11 @@ enum wxTreeItemIcon wxTreeItemIcon_Max }; +// special values for the 'state' parameter of wxTreeCtrl::SetItemState() +static const int wxTREE_ITEMSTATE_NONE = -1; // not state (no display state image) +static const int wxTREE_ITEMSTATE_NEXT = -2; // cycle to the next state +static const int wxTREE_ITEMSTATE_PREV = -3; // cycle to the previous state + // ---------------------------------------------------------------------------- // wxTreeCtrl flags // ---------------------------------------------------------------------------- @@ -151,7 +167,11 @@ enum wxTreeItemIcon #define wxTR_SINGLE 0x0000 // for convenience #define wxTR_MULTIPLE 0x0020 // can select multiple items -#define wxTR_EXTENDED 0x0040 // TODO: allow extended selection + +#if WXWIN_COMPATIBILITY_2_8 + #define wxTR_EXTENDED 0x0040 // deprecated, don't use +#endif // WXWIN_COMPATIBILITY_2_8 + #define wxTR_HAS_VARIABLE_ROW_HEIGHT 0x0080 // what it says #define wxTR_EDIT_LABELS 0x0200 // can edit item labels @@ -160,15 +180,22 @@ enum wxTreeItemIcon #define wxTR_FULL_ROW_HIGHLIGHT 0x2000 // highlight full horz space -#ifdef __WXGTK20__ -#define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_NO_LINES) +// make the default control appearance look more native-like depending on the +// platform +#if defined(__WXGTK20__) + #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_NO_LINES) +#elif defined(__WXMAC__) + #define wxTR_DEFAULT_STYLE \ + (wxTR_HAS_BUTTONS | wxTR_NO_LINES | wxTR_FULL_ROW_HIGHLIGHT) #else -#define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT) + #define wxTR_DEFAULT_STYLE (wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT) #endif +#if WXWIN_COMPATIBILITY_2_6 // deprecated, don't use #define wxTR_MAC_BUTTONS 0 #define wxTR_AQUA_BUTTONS 0 +#endif // WXWIN_COMPATIBILITY_2_6 // values for the `flags' parameter of wxTreeCtrl::HitTest() which determine @@ -203,13 +230,13 @@ static const int wxTREE_HITTEST_ONITEM = wxTREE_HITTEST_ONITEMICON | wxTREE_HITTEST_ONITEMLABEL; // tree ctrl default name -extern WXDLLEXPORT_DATA(const wxChar*) wxTreeCtrlNameStr; +extern WXDLLIMPEXP_DATA_CORE(const char) wxTreeCtrlNameStr[]; // ---------------------------------------------------------------------------- // wxTreeItemAttr: a structure containing the visual attributes of an item // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTreeItemAttr +class WXDLLIMPEXP_CORE wxTreeItemAttr { public: // ctors @@ -246,11 +273,16 @@ private: // descriptions below // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTreeEvent : public wxNotifyEvent +class WXDLLIMPEXP_FWD_CORE wxTreeCtrlBase; + +class WXDLLIMPEXP_CORE wxTreeEvent : public wxNotifyEvent { public: + wxTreeEvent(wxEventType commandType, + wxTreeCtrlBase *tree, + const wxTreeItemId &item = wxTreeItemId()); wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0); - wxTreeEvent(const wxTreeEvent & event); + wxTreeEvent(const wxTreeEvent& event); virtual wxEvent *Clone() const { return new wxTreeEvent(*this); } @@ -287,11 +319,6 @@ public: void SetToolTip(const wxString& toolTip) { m_label = toolTip; } wxString GetToolTip() { return m_label; } -#if WXWIN_COMPATIBILITY_2_2 - // for compatibility only, don't use - wxDEPRECATED( int GetCode() const); -#endif // WXWIN_COMPATIBILITY_2_2 - private: // not all of the members are used (or initialized) for all events wxKeyEvent m_evtKey; @@ -301,8 +328,8 @@ private: wxString m_label; bool m_editCancelled; - friend class WXDLLEXPORT wxTreeCtrl; - friend class WXDLLEXPORT wxGenericTreeCtrl; + friend class WXDLLIMPEXP_FWD_CORE wxTreeCtrl; + friend class WXDLLIMPEXP_FWD_CORE wxGenericTreeCtrl; DECLARE_DYNAMIC_CLASS(wxTreeEvent) }; @@ -313,29 +340,27 @@ typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&); // tree control events and macros for handling them // ---------------------------------------------------------------------------- -BEGIN_DECLARE_EVENT_TYPES() - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_DRAG, 600) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_RDRAG, 601) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, 602) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_LABEL_EDIT, 603) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_DELETE_ITEM, 604) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_GET_INFO, 605) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SET_INFO, 606) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDED, 607) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_EXPANDING, 608) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSED, 609) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_COLLAPSING, 610) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGED, 611) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_SEL_CHANGING, 612) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_KEY_DOWN, 613) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_ACTIVATED, 614) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK, 615) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK, 616) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_END_DRAG, 617) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 618) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP, 619) - DECLARE_EVENT_TYPE(wxEVT_COMMAND_TREE_ITEM_MENU, 620) -END_DECLARE_EVENT_TYPES() +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_DRAG; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_RDRAG; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_END_LABEL_EDIT; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_DELETE_ITEM; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_GET_INFO; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SET_INFO; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDED; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_EXPANDING; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSED; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_COLLAPSING; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_KEY_DOWN; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_END_DRAG; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP; +extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREE_ITEM_MENU; #define wxTreeEventHandler(func) \ (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTreeEventFunction, &func) @@ -350,7 +375,7 @@ END_DECLARE_EVENT_TYPES() #define EVT_TREE_BEGIN_DRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_DRAG, id, fn) #define EVT_TREE_BEGIN_RDRAG(id, fn) wx__DECLARE_TREEEVT(BEGIN_RDRAG, id, fn) -// GetItem() is the item on which the drop occured (if any) and GetPoint() the +// GetItem() is the item on which the drop occurred (if any) and GetPoint() the // current mouse coords #define EVT_TREE_END_DRAG(id, fn) wx__DECLARE_TREEEVT(END_DRAG, id, fn) @@ -405,4 +430,3 @@ END_DECLARE_EVENT_TYPES() #endif // wxUSE_TREECTRL #endif // _WX_TREEBASE_H_ -