4a5de04ece
Revert8535cde836(Remove apparently unnecessary m_hasExplicitFont, 2020-07-14) and make9cd3ab5ebd(Improve wxGenericTreeCtrl colours/fonts updating on theme change, 2020-07-14) really work as expected by using not only m_hasExplicitFont, but also m_hasExplicit{Fg,Bg}Col in order to ensure that we only update the attributes if they hadn't been explicitly set. This is necessary because the hack with reusing m_has{Fg,Bg}Col didn't work under Mac where the colour wasn't used at all when they were false. This still seems to be a problem as the behaviour is different from that of the other ports, but fixing this in wxOSX doesn't seem to be simple, so don't rely on this working and use separate variables instead. Closes #18940.
411 lines
16 KiB
C++
411 lines
16 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/generic/treectlg.h
|
|
// Purpose: wxTreeCtrl class
|
|
// Author: Robert Roebling
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// Copyright: (c) 1997,1998 Robert Roebling
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _GENERIC_TREECTRL_H_
|
|
#define _GENERIC_TREECTRL_H_
|
|
|
|
#if wxUSE_TREECTRL
|
|
|
|
#include "wx/brush.h"
|
|
#include "wx/pen.h"
|
|
#include "wx/scrolwin.h"
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// forward declaration
|
|
// -----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxGenericTreeItem;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxTreeItemData;
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxTreeRenameTimer;
|
|
class WXDLLIMPEXP_FWD_CORE wxTreeFindTimer;
|
|
class WXDLLIMPEXP_FWD_CORE wxTreeTextCtrl;
|
|
class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// wxGenericTreeCtrl - the tree control
|
|
// -----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxGenericTreeCtrl : public wxTreeCtrlBase,
|
|
public wxScrollHelper
|
|
{
|
|
public:
|
|
// creation
|
|
// --------
|
|
|
|
wxGenericTreeCtrl() : wxTreeCtrlBase(), wxScrollHelper(this) { Init(); }
|
|
|
|
wxGenericTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxTR_DEFAULT_STYLE,
|
|
const wxValidator &validator = wxDefaultValidator,
|
|
const wxString& name = wxASCII_STR(wxTreeCtrlNameStr))
|
|
: wxTreeCtrlBase(),
|
|
wxScrollHelper(this)
|
|
{
|
|
Init();
|
|
Create(parent, id, pos, size, style, validator, name);
|
|
}
|
|
|
|
virtual ~wxGenericTreeCtrl();
|
|
|
|
bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxTR_DEFAULT_STYLE,
|
|
const wxValidator &validator = wxDefaultValidator,
|
|
const wxString& name = wxASCII_STR(wxTreeCtrlNameStr));
|
|
|
|
// implement base class pure virtuals
|
|
// ----------------------------------
|
|
|
|
virtual unsigned int GetCount() const wxOVERRIDE;
|
|
|
|
virtual unsigned int GetIndent() const wxOVERRIDE { return m_indent; }
|
|
virtual void SetIndent(unsigned int indent) wxOVERRIDE;
|
|
|
|
|
|
virtual void SetImageList(wxImageList *imageList) wxOVERRIDE;
|
|
virtual void SetStateImageList(wxImageList *imageList) wxOVERRIDE;
|
|
|
|
virtual wxString GetItemText(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual int GetItemImage(const wxTreeItemId& item,
|
|
wxTreeItemIcon which = wxTreeItemIcon_Normal) const wxOVERRIDE;
|
|
virtual wxTreeItemData *GetItemData(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual wxColour GetItemTextColour(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual wxFont GetItemFont(const wxTreeItemId& item) const wxOVERRIDE;
|
|
|
|
virtual void SetItemText(const wxTreeItemId& item, const wxString& text) wxOVERRIDE;
|
|
virtual void SetItemImage(const wxTreeItemId& item,
|
|
int image,
|
|
wxTreeItemIcon which = wxTreeItemIcon_Normal) wxOVERRIDE;
|
|
virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData *data) wxOVERRIDE;
|
|
|
|
virtual void SetItemHasChildren(const wxTreeItemId& item, bool has = true) wxOVERRIDE;
|
|
virtual void SetItemBold(const wxTreeItemId& item, bool bold = true) wxOVERRIDE;
|
|
virtual void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = true) wxOVERRIDE;
|
|
virtual void SetItemTextColour(const wxTreeItemId& item, const wxColour& col) wxOVERRIDE;
|
|
virtual void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col) wxOVERRIDE;
|
|
virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font) wxOVERRIDE;
|
|
|
|
virtual bool IsVisible(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual bool ItemHasChildren(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual bool IsExpanded(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual bool IsSelected(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual bool IsBold(const wxTreeItemId& item) const wxOVERRIDE;
|
|
|
|
virtual size_t GetChildrenCount(const wxTreeItemId& item,
|
|
bool recursively = true) const wxOVERRIDE;
|
|
|
|
// navigation
|
|
// ----------
|
|
|
|
virtual wxTreeItemId GetRootItem() const wxOVERRIDE { return m_anchor; }
|
|
virtual wxTreeItemId GetSelection() const wxOVERRIDE
|
|
{
|
|
wxASSERT_MSG( !HasFlag(wxTR_MULTIPLE),
|
|
wxT("must use GetSelections() with this control") );
|
|
|
|
return m_current;
|
|
}
|
|
virtual size_t GetSelections(wxArrayTreeItemIds&) const wxOVERRIDE;
|
|
virtual wxTreeItemId GetFocusedItem() const wxOVERRIDE { return m_current; }
|
|
|
|
virtual void ClearFocusedItem() wxOVERRIDE;
|
|
virtual void SetFocusedItem(const wxTreeItemId& item) wxOVERRIDE;
|
|
|
|
virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
|
|
wxTreeItemIdValue& cookie) const wxOVERRIDE;
|
|
virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
|
|
wxTreeItemIdValue& cookie) const wxOVERRIDE;
|
|
virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const wxOVERRIDE;
|
|
|
|
virtual wxTreeItemId GetFirstVisibleItem() const wxOVERRIDE;
|
|
virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const wxOVERRIDE;
|
|
|
|
|
|
// operations
|
|
// ----------
|
|
|
|
virtual wxTreeItemId AddRoot(const wxString& text,
|
|
int image = -1, int selectedImage = -1,
|
|
wxTreeItemData *data = NULL) wxOVERRIDE;
|
|
|
|
virtual void Delete(const wxTreeItemId& item) wxOVERRIDE;
|
|
virtual void DeleteChildren(const wxTreeItemId& item) wxOVERRIDE;
|
|
virtual void DeleteAllItems() wxOVERRIDE;
|
|
|
|
virtual void Expand(const wxTreeItemId& item) wxOVERRIDE;
|
|
virtual void Collapse(const wxTreeItemId& item) wxOVERRIDE;
|
|
virtual void CollapseAndReset(const wxTreeItemId& item) wxOVERRIDE;
|
|
virtual void Toggle(const wxTreeItemId& item) wxOVERRIDE;
|
|
|
|
virtual void Unselect() wxOVERRIDE;
|
|
virtual void UnselectAll() wxOVERRIDE;
|
|
virtual void SelectItem(const wxTreeItemId& item, bool select = true) wxOVERRIDE;
|
|
virtual void SelectChildren(const wxTreeItemId& parent) wxOVERRIDE;
|
|
|
|
virtual void EnsureVisible(const wxTreeItemId& item) wxOVERRIDE;
|
|
virtual void ScrollTo(const wxTreeItemId& item) wxOVERRIDE;
|
|
|
|
virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
|
|
wxClassInfo* textCtrlClass = wxCLASSINFO(wxTextCtrl)) wxOVERRIDE;
|
|
virtual wxTextCtrl *GetEditControl() const wxOVERRIDE;
|
|
virtual void EndEditLabel(const wxTreeItemId& item,
|
|
bool discardChanges = false) wxOVERRIDE;
|
|
|
|
virtual void EnableBellOnNoMatch(bool on = true) wxOVERRIDE;
|
|
|
|
virtual void SortChildren(const wxTreeItemId& item) wxOVERRIDE;
|
|
|
|
// items geometry
|
|
// --------------
|
|
|
|
virtual bool GetBoundingRect(const wxTreeItemId& item,
|
|
wxRect& rect,
|
|
bool textOnly = false) const wxOVERRIDE;
|
|
|
|
|
|
// this version specific methods
|
|
// -----------------------------
|
|
|
|
wxImageList *GetButtonsImageList() const { return m_imageListButtons; }
|
|
void SetButtonsImageList(wxImageList *imageList);
|
|
void AssignButtonsImageList(wxImageList *imageList);
|
|
|
|
void SetDropEffectAboveItem( bool above = false ) { m_dropEffectAboveItem = above; }
|
|
bool GetDropEffectAboveItem() const { return m_dropEffectAboveItem; }
|
|
|
|
wxTreeItemId GetNext(const wxTreeItemId& item) const;
|
|
|
|
// implementation only from now on
|
|
|
|
// overridden base class virtuals
|
|
virtual bool SetBackgroundColour(const wxColour& colour) wxOVERRIDE;
|
|
virtual bool SetForegroundColour(const wxColour& colour) wxOVERRIDE;
|
|
|
|
virtual void Refresh(bool eraseBackground = true, const wxRect *rect = NULL) wxOVERRIDE;
|
|
|
|
virtual bool SetFont( const wxFont &font ) wxOVERRIDE;
|
|
virtual void SetWindowStyleFlag(long styles) wxOVERRIDE;
|
|
|
|
// callbacks
|
|
void OnPaint( wxPaintEvent &event );
|
|
void OnSetFocus( wxFocusEvent &event );
|
|
void OnKillFocus( wxFocusEvent &event );
|
|
void OnKeyDown( wxKeyEvent &event );
|
|
void OnChar( wxKeyEvent &event );
|
|
void OnMouse( wxMouseEvent &event );
|
|
void OnGetToolTip( wxTreeEvent &event );
|
|
void OnSize( wxSizeEvent &event );
|
|
void OnInternalIdle( ) wxOVERRIDE;
|
|
|
|
virtual wxVisualAttributes GetDefaultAttributes() const wxOVERRIDE
|
|
{
|
|
return GetClassDefaultAttributes(GetWindowVariant());
|
|
}
|
|
|
|
static wxVisualAttributes
|
|
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
|
|
|
|
// implementation helpers
|
|
void AdjustMyScrollbars();
|
|
|
|
WX_FORWARD_TO_SCROLL_HELPER()
|
|
|
|
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,
|
|
// A hint to select a parent item after deleting a child
|
|
*m_select_me;
|
|
unsigned short m_indent;
|
|
int m_lineHeight;
|
|
wxPen m_dottedPen;
|
|
wxBrush m_hilightBrush,
|
|
m_hilightUnfocusedBrush;
|
|
bool m_hasFocus;
|
|
bool m_dirty;
|
|
bool m_ownsImageListButtons;
|
|
bool m_isDragging; // true between BEGIN/END drag events
|
|
bool m_lastOnSame; // last click on the same item as prev
|
|
wxImageList *m_imageListButtons;
|
|
|
|
int m_dragCount;
|
|
wxPoint m_dragStart;
|
|
wxGenericTreeItem *m_dropTarget;
|
|
wxCursor m_oldCursor; // cursor is changed while dragging
|
|
wxGenericTreeItem *m_oldSelection;
|
|
wxGenericTreeItem *m_underMouse; // for visual effects
|
|
|
|
enum { NoEffect, BorderEffect, AboveEffect, BelowEffect } m_dndEffect;
|
|
wxGenericTreeItem *m_dndEffectItem;
|
|
|
|
wxTreeTextCtrl *m_textCtrl;
|
|
|
|
|
|
wxTimer *m_renameTimer;
|
|
|
|
// incremental search data
|
|
wxString m_findPrefix;
|
|
wxTimer *m_findTimer;
|
|
// This flag is set to 0 if the bell is disabled, 1 if it is enabled and -1
|
|
// if it is globally enabled but has been temporarily disabled because we
|
|
// had already beeped for this particular search.
|
|
int m_findBell;
|
|
|
|
bool m_dropEffectAboveItem;
|
|
|
|
// the common part of all ctors
|
|
void Init();
|
|
|
|
// overridden wxWindow methods
|
|
virtual void DoThaw() wxOVERRIDE;
|
|
|
|
// 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);
|
|
|
|
virtual int DoGetItemState(const wxTreeItemId& item) const wxOVERRIDE;
|
|
virtual void DoSetItemState(const wxTreeItemId& item, int state) wxOVERRIDE;
|
|
|
|
virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
|
|
size_t previous,
|
|
const wxString& text,
|
|
int image,
|
|
int selectedImage,
|
|
wxTreeItemData *data) wxOVERRIDE;
|
|
virtual wxTreeItemId DoInsertAfter(const wxTreeItemId& parent,
|
|
const wxTreeItemId& idPrevious,
|
|
const wxString& text,
|
|
int image = -1, int selImage = -1,
|
|
wxTreeItemData *data = NULL) wxOVERRIDE;
|
|
virtual wxTreeItemId DoTreeHitTest(const wxPoint& point, int& flags) const wxOVERRIDE;
|
|
|
|
// 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 CalculateLevel( wxGenericTreeItem *item, wxDC &dc, int level, int &y );
|
|
void CalculatePositions();
|
|
|
|
void RefreshSubtree( wxGenericTreeItem *item );
|
|
void RefreshLine( wxGenericTreeItem *item );
|
|
|
|
// redraw all selected items
|
|
void RefreshSelected();
|
|
|
|
// RefreshSelected() recursive helper
|
|
void RefreshSelectedUnder(wxGenericTreeItem *item);
|
|
|
|
void OnRenameTimer();
|
|
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 ChildrenClosing(wxGenericTreeItem* item);
|
|
|
|
void DoDirtyProcessing();
|
|
|
|
virtual wxSize DoGetBestSize() const wxOVERRIDE;
|
|
|
|
private:
|
|
void OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event))
|
|
{
|
|
InitVisualAttributes();
|
|
}
|
|
|
|
// (Re)initialize colours, fonts, pens, brushes used by the control using
|
|
// the current system colours and font.
|
|
void InitVisualAttributes();
|
|
|
|
// Reset the state of the last find (i.e. keyboard incremental search)
|
|
// operation.
|
|
void ResetFindState();
|
|
|
|
|
|
// True if we're using custom colours/font, respectively, or false if we're
|
|
// using the default colours and should update them whenever system colours
|
|
// change.
|
|
bool m_hasExplicitFgCol:1,
|
|
m_hasExplicitBgCol:1,
|
|
m_hasExplicitFont:1;
|
|
|
|
wxDECLARE_EVENT_TABLE();
|
|
wxDECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl);
|
|
wxDECLARE_NO_COPY_CLASS(wxGenericTreeCtrl);
|
|
};
|
|
|
|
// Also define wxTreeCtrl to be wxGenericTreeCtrl on all platforms without a
|
|
// native version, i.e. all but MSW and Qt.
|
|
#if !(defined(__WXMSW__) || defined(__WXQT__)) || defined(__WXUNIVERSAL__)
|
|
/*
|
|
* wxTreeCtrl has to be a real class or we have problems with
|
|
* the run-time information.
|
|
*/
|
|
|
|
class WXDLLIMPEXP_CORE wxTreeCtrl: public wxGenericTreeCtrl
|
|
{
|
|
wxDECLARE_DYNAMIC_CLASS(wxTreeCtrl);
|
|
|
|
public:
|
|
wxTreeCtrl() {}
|
|
|
|
wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxTR_DEFAULT_STYLE,
|
|
const wxValidator &validator = wxDefaultValidator,
|
|
const wxString& name = wxASCII_STR(wxTreeCtrlNameStr))
|
|
: wxGenericTreeCtrl(parent, id, pos, size, style, validator, name)
|
|
{
|
|
}
|
|
};
|
|
#endif // !(__WXMSW__ || __WXQT__) || __WXUNIVERSAL__
|
|
|
|
#endif // wxUSE_TREECTRL
|
|
|
|
#endif // _GENERIC_TREECTRL_H_
|