initial commit
Signed-off-by: Peter Siegmund <mars3142@noreply.mars3142.dev>
This commit is contained in:
365
libs/wxWidgets-3.3.1/include/wx/msw/treectrl.h
Normal file
365
libs/wxWidgets-3.3.1/include/wx/msw/treectrl.h
Normal file
@@ -0,0 +1,365 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: wx/msw/treectrl.h
|
||||
// Purpose: wxTreeCtrl class
|
||||
// Author: Julian Smart
|
||||
// Modified by: Vadim Zeitlin to be less MSW-specific on 10/10/98
|
||||
// Created: 01/02/97
|
||||
// Copyright: (c) Julian Smart
|
||||
// Licence: wxWindows licence
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifndef _WX_MSW_TREECTRL_H_
|
||||
#define _WX_MSW_TREECTRL_H_
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// headers
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
#if wxUSE_TREECTRL
|
||||
|
||||
#include "wx/textctrl.h"
|
||||
#include "wx/dynarray.h"
|
||||
#include "wx/treebase.h"
|
||||
|
||||
#include <memory>
|
||||
#include <unordered_map>
|
||||
|
||||
#ifdef __GNUWIN32__
|
||||
// Cygwin windows.h defines these identifiers
|
||||
#undef GetFirstChild
|
||||
#undef GetNextSibling
|
||||
#endif // Cygwin
|
||||
|
||||
// fwd decl
|
||||
class WXDLLIMPEXP_FWD_CORE wxImageList;
|
||||
class WXDLLIMPEXP_FWD_CORE wxDragImage;
|
||||
struct WXDLLIMPEXP_FWD_CORE wxTreeViewItem;
|
||||
|
||||
class wxItemAttr;
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxTreeCtrl
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
class WXDLLIMPEXP_CORE wxTreeCtrl : public wxTreeCtrlBase
|
||||
{
|
||||
public:
|
||||
// creation
|
||||
// --------
|
||||
wxTreeCtrl();
|
||||
|
||||
wxTreeCtrl(wxWindow *parent, wxWindowID id = wxID_ANY,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
|
||||
const wxValidator& validator = wxDefaultValidator,
|
||||
const wxString& name = wxASCII_STR(wxTreeCtrlNameStr));
|
||||
|
||||
virtual ~wxTreeCtrl();
|
||||
|
||||
bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
|
||||
const wxValidator& validator = wxDefaultValidator,
|
||||
const wxString& name = wxASCII_STR(wxTreeCtrlNameStr));
|
||||
|
||||
// implement base class pure virtuals
|
||||
// ----------------------------------
|
||||
|
||||
virtual unsigned int GetCount() const override;
|
||||
|
||||
virtual unsigned int GetIndent() const override;
|
||||
virtual void SetIndent(unsigned int indent) override;
|
||||
|
||||
virtual void SetStateImages(const wxVector<wxBitmapBundle>& images) override;
|
||||
|
||||
virtual void SetImageList(wxImageList *imageList) override;
|
||||
virtual void SetStateImageList(wxImageList *imageList) override;
|
||||
|
||||
virtual wxString GetItemText(const wxTreeItemId& item) const override;
|
||||
virtual int GetItemImage(const wxTreeItemId& item,
|
||||
wxTreeItemIcon which = wxTreeItemIcon_Normal) const override;
|
||||
virtual wxTreeItemData *GetItemData(const wxTreeItemId& item) const override;
|
||||
virtual wxColour GetItemTextColour(const wxTreeItemId& item) const override;
|
||||
virtual wxColour GetItemBackgroundColour(const wxTreeItemId& item) const override;
|
||||
virtual wxFont GetItemFont(const wxTreeItemId& item) const override;
|
||||
|
||||
virtual void SetItemText(const wxTreeItemId& item, const wxString& text) override;
|
||||
virtual void SetItemImage(const wxTreeItemId& item, int image,
|
||||
wxTreeItemIcon which = wxTreeItemIcon_Normal) override;
|
||||
virtual void SetItemData(const wxTreeItemId& item, wxTreeItemData *data) override;
|
||||
virtual void SetItemHasChildren(const wxTreeItemId& item, bool has = true) override;
|
||||
virtual void SetItemBold(const wxTreeItemId& item, bool bold = true) override;
|
||||
virtual void SetItemDropHighlight(const wxTreeItemId& item,
|
||||
bool highlight = true) override;
|
||||
virtual void SetItemTextColour(const wxTreeItemId& item,
|
||||
const wxColour& col) override;
|
||||
virtual void SetItemBackgroundColour(const wxTreeItemId& item,
|
||||
const wxColour& col) override;
|
||||
virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font) override;
|
||||
|
||||
// item status inquiries
|
||||
// ---------------------
|
||||
|
||||
virtual bool IsVisible(const wxTreeItemId& item) const override;
|
||||
virtual bool ItemHasChildren(const wxTreeItemId& item) const override;
|
||||
virtual bool IsExpanded(const wxTreeItemId& item) const override;
|
||||
virtual bool IsSelected(const wxTreeItemId& item) const override;
|
||||
virtual bool IsBold(const wxTreeItemId& item) const override;
|
||||
|
||||
virtual size_t GetChildrenCount(const wxTreeItemId& item,
|
||||
bool recursively = true) const override;
|
||||
|
||||
// navigation
|
||||
// ----------
|
||||
|
||||
virtual wxTreeItemId GetRootItem() const override;
|
||||
virtual wxTreeItemId GetSelection() const override;
|
||||
virtual size_t GetSelections(wxArrayTreeItemIds& selections) const override;
|
||||
virtual wxTreeItemId GetFocusedItem() const override;
|
||||
|
||||
virtual void ClearFocusedItem() override;
|
||||
virtual void SetFocusedItem(const wxTreeItemId& item) override;
|
||||
|
||||
|
||||
virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const override;
|
||||
virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
|
||||
wxTreeItemIdValue& cookie) const override;
|
||||
virtual wxTreeItemId GetNextChild(const wxTreeItemId& item,
|
||||
wxTreeItemIdValue& cookie) const override;
|
||||
virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const override;
|
||||
|
||||
virtual wxTreeItemId GetNextSibling(const wxTreeItemId& item) const override;
|
||||
virtual wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const override;
|
||||
|
||||
virtual wxTreeItemId GetFirstVisibleItem() const override;
|
||||
virtual wxTreeItemId GetNextVisible(const wxTreeItemId& item) const override;
|
||||
virtual wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const override;
|
||||
|
||||
// operations
|
||||
// ----------
|
||||
|
||||
virtual wxTreeItemId AddRoot(const wxString& text,
|
||||
int image = -1, int selectedImage = -1,
|
||||
wxTreeItemData *data = nullptr) override;
|
||||
|
||||
virtual void Delete(const wxTreeItemId& item) override;
|
||||
virtual void DeleteChildren(const wxTreeItemId& item) override;
|
||||
virtual void DeleteAllItems() override;
|
||||
|
||||
virtual void Expand(const wxTreeItemId& item) override;
|
||||
virtual void Collapse(const wxTreeItemId& item) override;
|
||||
virtual void CollapseAndReset(const wxTreeItemId& item) override;
|
||||
virtual void Toggle(const wxTreeItemId& item) override;
|
||||
|
||||
virtual void Unselect() override;
|
||||
virtual void UnselectAll() override;
|
||||
virtual void SelectItem(const wxTreeItemId& item, bool select = true) override;
|
||||
virtual void SelectChildren(const wxTreeItemId& parent) override;
|
||||
|
||||
virtual void EnsureVisible(const wxTreeItemId& item) override;
|
||||
virtual void ScrollTo(const wxTreeItemId& item) override;
|
||||
|
||||
virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
|
||||
wxClassInfo* textCtrlClass = wxCLASSINFO(wxTextCtrl)) override;
|
||||
virtual wxTextCtrl *GetEditControl() const override;
|
||||
virtual void EndEditLabel(const wxTreeItemId& WXUNUSED(item),
|
||||
bool discardChanges = false) override
|
||||
{
|
||||
DoEndEditLabel(discardChanges);
|
||||
}
|
||||
|
||||
virtual void SortChildren(const wxTreeItemId& item) override;
|
||||
|
||||
virtual bool GetBoundingRect(const wxTreeItemId& item,
|
||||
wxRect& rect,
|
||||
bool textOnly = false) const override;
|
||||
|
||||
// implementation
|
||||
// --------------
|
||||
|
||||
virtual wxVisualAttributes GetDefaultAttributes() const override
|
||||
{
|
||||
return GetClassDefaultAttributes(GetWindowVariant());
|
||||
}
|
||||
|
||||
static wxVisualAttributes
|
||||
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
|
||||
|
||||
|
||||
virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) override;
|
||||
virtual WXLRESULT MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) override;
|
||||
virtual bool MSWCommand(WXUINT param, WXWORD id) override;
|
||||
virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) override;
|
||||
virtual bool MSWShouldPreProcessMessage(WXMSG* msg) override;
|
||||
|
||||
// override some base class virtuals
|
||||
virtual bool SetBackgroundColour(const wxColour &colour) override;
|
||||
virtual bool SetForegroundColour(const wxColour &colour) override;
|
||||
|
||||
// returns true if the platform should explicitly apply a theme border
|
||||
virtual bool CanApplyThemeBorder() const override { return false; }
|
||||
|
||||
virtual bool IsDoubleBuffered() const override;
|
||||
virtual void SetDoubleBuffered(bool on) override;
|
||||
|
||||
virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const override;
|
||||
|
||||
protected:
|
||||
// Implement "update locking" in a custom way for this control.
|
||||
virtual void DoFreeze() override;
|
||||
virtual void DoThaw() override;
|
||||
|
||||
virtual bool MSWShouldSetDefaultFont() const override { return false; }
|
||||
|
||||
virtual int MSWGetToolTipMessage() const override;
|
||||
|
||||
virtual void OnImagesChanged() override;
|
||||
|
||||
// SetImageList helper
|
||||
void SetAnyImageList(wxImageList *imageList, int which);
|
||||
|
||||
// refresh a single item
|
||||
void RefreshItem(const wxTreeItemId& item);
|
||||
|
||||
// end edit label
|
||||
void DoEndEditLabel(bool discardChanges = false);
|
||||
|
||||
virtual int DoGetItemState(const wxTreeItemId& item) const override;
|
||||
virtual void DoSetItemState(const wxTreeItemId& item, int state) override;
|
||||
|
||||
virtual wxTreeItemId DoInsertItem(const wxTreeItemId& parent,
|
||||
size_t pos,
|
||||
const wxString& text,
|
||||
int image, int selectedImage,
|
||||
wxTreeItemData *data) override;
|
||||
virtual wxTreeItemId DoInsertAfter(const wxTreeItemId& parent,
|
||||
const wxTreeItemId& idPrevious,
|
||||
const wxString& text,
|
||||
int image = -1, int selImage = -1,
|
||||
wxTreeItemData *data = nullptr) override;
|
||||
virtual wxTreeItemId DoTreeHitTest(const wxPoint& point, int& flags) const override;
|
||||
|
||||
// obtain the user data for the lParam member of TV_ITEM
|
||||
class wxTreeItemParam *GetItemParam(const wxTreeItemId& item) const;
|
||||
|
||||
// update the event to include the items client data and pass it to
|
||||
// HandleWindowEvent(), return true if it processed it
|
||||
bool HandleTreeEvent(wxTreeEvent& event) const;
|
||||
|
||||
// pass the event to HandleTreeEvent() and return true if the event was
|
||||
// either unprocessed or not vetoed
|
||||
bool IsTreeEventAllowed(wxTreeEvent& event) const
|
||||
{
|
||||
return !HandleTreeEvent(event) || event.IsAllowed();
|
||||
}
|
||||
|
||||
// generate a wxEVT_KEY_DOWN event from the specified WPARAM/LPARAM values
|
||||
// having the same meaning as for WM_KEYDOWN, return true if it was
|
||||
// processed
|
||||
bool MSWHandleTreeKeyDownEvent(WXWPARAM wParam, WXLPARAM lParam);
|
||||
|
||||
// handle a key event in a multi-selection control, should be only called
|
||||
// for keys which can be used to change the selection
|
||||
//
|
||||
// return true if the key was processed, false otherwise
|
||||
bool MSWHandleSelectionKey(unsigned vkey);
|
||||
|
||||
virtual void MSWUpdateFontOnDPIChange(const wxSize& newDPI) override;
|
||||
|
||||
// data used only while editing the item label:
|
||||
wxTextCtrl *m_textCtrl; // text control in which it is edited
|
||||
wxTreeItemId m_idEdited; // the item being edited
|
||||
|
||||
private:
|
||||
// the common part of all ctors
|
||||
void Init();
|
||||
|
||||
// helper functions
|
||||
bool DoGetItem(wxTreeViewItem *tvItem) const;
|
||||
void DoSetItem(wxTreeViewItem *tvItem);
|
||||
|
||||
void DoExpand(const wxTreeItemId& item, int flag);
|
||||
|
||||
void DoSelectItem(const wxTreeItemId& item, bool select = true);
|
||||
void DoUnselectItem(const wxTreeItemId& item);
|
||||
void DoToggleItemSelection(const wxTreeItemId& item);
|
||||
|
||||
void DoUnselectAll();
|
||||
void DoSelectChildren(const wxTreeItemId& parent);
|
||||
|
||||
void DeleteTextCtrl();
|
||||
|
||||
unsigned int DoGetIndent() const;
|
||||
void DoSetIndent();
|
||||
|
||||
// return true if the item is the hidden root one (i.e. it's the root item
|
||||
// and the tree has wxTR_HIDE_ROOT style)
|
||||
bool IsHiddenRoot(const wxTreeItemId& item) const;
|
||||
|
||||
|
||||
// check if the given flags (taken from TV_HITTESTINFO structure)
|
||||
// indicate a position "on item": this is less trivial than just checking
|
||||
// for TVHT_ONITEM because we consider that points to the left and right of
|
||||
// item text are also "on item" when wxTR_FULL_ROW_HIGHLIGHT is used as the
|
||||
// item visually spans the entire breadth of the window then
|
||||
bool MSWIsOnItem(unsigned flags) const;
|
||||
|
||||
// Delete the given item from the native control.
|
||||
bool MSWDeleteItem(const wxTreeItemId& item);
|
||||
|
||||
void OnDPIChanged(wxDPIChangedEvent& event);
|
||||
|
||||
|
||||
// Return guaranteed non-null non-owning pointer to the attribute for the
|
||||
// given item.
|
||||
wxItemAttr* DoGetAttrPtr(const wxTreeItemId& item);
|
||||
|
||||
// the hash storing the items attributes (indexed by item ids)
|
||||
std::unordered_map<void*, std::unique_ptr<wxItemAttr>> m_attrs;
|
||||
|
||||
#if wxUSE_DRAGIMAGE
|
||||
// used for dragging
|
||||
wxDragImage *m_dragImage;
|
||||
#endif
|
||||
|
||||
// Virtual root item, if wxTR_HIDE_ROOT is set.
|
||||
void* m_pVirtualRoot;
|
||||
|
||||
// Items to call EnsureVisible() on when the tree is thawed, if necessary.
|
||||
std::vector<wxTreeItemId> m_htEnsureVisibleOnThaw;
|
||||
|
||||
// the starting item for selection with Shift
|
||||
wxTreeItemId m_htSelStart, m_htClickedItem;
|
||||
wxPoint m_ptClick;
|
||||
|
||||
// whether dragging has started
|
||||
bool m_dragStarted;
|
||||
|
||||
// whether focus was lost between subsequent clicks of a single item
|
||||
bool m_focusLost;
|
||||
|
||||
// set when we are changing selection ourselves (only used in multi
|
||||
// selection mode)
|
||||
bool m_changingSelection;
|
||||
|
||||
// whether we need to trigger a state image click event
|
||||
bool m_triggerStateImageClick;
|
||||
|
||||
// whether we need to deselect other items on mouse up
|
||||
bool m_mouseUpDeselect;
|
||||
|
||||
friend class wxTreeItemIndirectData;
|
||||
friend class wxTreeSortHelper;
|
||||
|
||||
// indentation in DIP
|
||||
unsigned int m_indent;
|
||||
|
||||
wxDECLARE_DYNAMIC_CLASS(wxTreeCtrl);
|
||||
wxDECLARE_NO_COPY_CLASS(wxTreeCtrl);
|
||||
};
|
||||
|
||||
#endif // wxUSE_TREECTRL
|
||||
|
||||
#endif // _WX_MSW_TREECTRL_H_
|
||||
Reference in New Issue
Block a user