NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | List of all members
CwxTreeCtrlEx Class Reference

Search Toolkit Book for CwxTreeCtrlEx

#include <gui/widgets/wx/treectrl_ex.hpp>

+ Inheritance diagram for CwxTreeCtrlEx:
+ Collaboration diagram for CwxTreeCtrlEx:

Public Types

enum  TTreeState { TREE_EX_UNDEF =-1 , TREE_EX_UNCHECKED = 0 , TREE_EX_THREESTATE = 1 , TREE_EX_CHECKED = 2 }
 

Public Member Functions

 CwxTreeCtrlEx (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=wxTreeCtrlNameStr)
 
 ~CwxTreeCtrlEx ()
 
void CheckAll (bool bcheck=true)
 
void SetCheck (const wxTreeItemId &item, bool bcheck=true)
 
bool GetCheck (const wxTreeItemId &item)
 
size_t GetCheckedMultiple (wxArrayTreeItemIds &ids) const
 
void SetCheckMultiple (const wxArrayTreeItemIds &ids)
 

Protected Member Functions

void OnLeftDown (wxMouseEvent &event)
 
void OnKeyDown (wxKeyEvent &event)
 
void OnFocus (wxFocusEvent &event)
 
void x_SetState (const wxTreeItemId &id, TTreeState state=TREE_EX_UNDEF)
 
TTreeState x_ModifyState (const wxTreeItemId &id, TTreeState state=TREE_EX_UNDEF)
 
TTreeState x_ValidateState (const wxTreeItemId &id, TTreeState state=TREE_EX_UNDEF)
 
TTreeState x_ProcessDownstream (const wxTreeItemId &id, TTreeState state=TREE_EX_UNDEF)
 
TTreeState x_ProcessUpstream (const wxTreeItemId &id, TTreeState state=TREE_EX_UNDEF)
 
void x_GetCheckedMultiple (wxArrayTreeItemIds &ids, wxTreeItemId &item) const
 
 DECLARE_EVENT_TABLE ()
 

Detailed Description

Definition at line 44 of file treectrl_ex.hpp.

Member Enumeration Documentation

◆ TTreeState

Enumerator
TREE_EX_UNDEF 
TREE_EX_UNCHECKED 
TREE_EX_THREESTATE 
TREE_EX_CHECKED 

Definition at line 47 of file treectrl_ex.hpp.

Constructor & Destructor Documentation

◆ CwxTreeCtrlEx()

CwxTreeCtrlEx::CwxTreeCtrlEx ( 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 = wxTreeCtrlNameStr 
)

◆ ~CwxTreeCtrlEx()

CwxTreeCtrlEx::~CwxTreeCtrlEx ( )

Definition at line 97 of file treectrl_ex.cpp.

Member Function Documentation

◆ CheckAll()

void CwxTreeCtrlEx::CheckAll ( bool  bcheck = true)

Definition at line 216 of file treectrl_ex.cpp.

References TREE_EX_CHECKED, TREE_EX_UNCHECKED, and x_SetState().

Referenced by CFeatureCheckPanel::x_InitTree().

◆ DECLARE_EVENT_TABLE()

CwxTreeCtrlEx::DECLARE_EVENT_TABLE ( )
protected

◆ GetCheck()

bool CwxTreeCtrlEx::GetCheck ( const wxTreeItemId &  item)

◆ GetCheckedMultiple()

size_t CwxTreeCtrlEx::GetCheckedMultiple ( wxArrayTreeItemIds &  ids) const

Definition at line 238 of file treectrl_ex.cpp.

References x_GetCheckedMultiple().

◆ OnFocus()

void CwxTreeCtrlEx::OnFocus ( wxFocusEvent &  event)
protected

Definition at line 210 of file treectrl_ex.cpp.

◆ OnKeyDown()

void CwxTreeCtrlEx::OnKeyDown ( wxKeyEvent &  event)
protected

Definition at line 114 of file treectrl_ex.cpp.

References x_SetState().

◆ OnLeftDown()

void CwxTreeCtrlEx::OnLeftDown ( wxMouseEvent &  event)
protected

Definition at line 102 of file treectrl_ex.cpp.

References flags, and x_SetState().

◆ SetCheck()

void CwxTreeCtrlEx::SetCheck ( const wxTreeItemId &  item,
bool  bcheck = true 
)

◆ SetCheckMultiple()

void CwxTreeCtrlEx::SetCheckMultiple ( const wxArrayTreeItemIds &  ids)

Definition at line 231 of file treectrl_ex.cpp.

References TREE_EX_CHECKED, and x_SetState().

◆ x_GetCheckedMultiple()

void CwxTreeCtrlEx::x_GetCheckedMultiple ( wxArrayTreeItemIds &  ids,
wxTreeItemId &  item 
) const
protected

Definition at line 246 of file treectrl_ex.cpp.

References TREE_EX_CHECKED.

Referenced by GetCheckedMultiple().

◆ x_ModifyState()

CwxTreeCtrlEx::TTreeState CwxTreeCtrlEx::x_ModifyState ( const wxTreeItemId &  id,
TTreeState  state = TREE_EX_UNDEF 
)
protected

Definition at line 128 of file treectrl_ex.cpp.

References TREE_EX_CHECKED, TREE_EX_THREESTATE, TREE_EX_UNCHECKED, and TREE_EX_UNDEF.

Referenced by x_ProcessDownstream(), and x_SetState().

◆ x_ProcessDownstream()

CwxTreeCtrlEx::TTreeState CwxTreeCtrlEx::x_ProcessDownstream ( const wxTreeItemId &  id,
TTreeState  state = TREE_EX_UNDEF 
)
protected

Definition at line 166 of file treectrl_ex.cpp.

References TREE_EX_CHECKED, TREE_EX_UNCHECKED, and x_ModifyState().

Referenced by x_ValidateState().

◆ x_ProcessUpstream()

CwxTreeCtrlEx::TTreeState CwxTreeCtrlEx::x_ProcessUpstream ( const wxTreeItemId &  id,
TTreeState  state = TREE_EX_UNDEF 
)
protected

Definition at line 180 of file treectrl_ex.cpp.

References TREE_EX_CHECKED, TREE_EX_THREESTATE, and TREE_EX_UNCHECKED.

Referenced by x_ValidateState().

◆ x_SetState()

void CwxTreeCtrlEx::x_SetState ( const wxTreeItemId &  id,
TTreeState  state = TREE_EX_UNDEF 
)
protected

Definition at line 123 of file treectrl_ex.cpp.

References x_ModifyState(), and x_ValidateState().

Referenced by CheckAll(), OnKeyDown(), OnLeftDown(), SetCheck(), and SetCheckMultiple().

◆ x_ValidateState()

CwxTreeCtrlEx::TTreeState CwxTreeCtrlEx::x_ValidateState ( const wxTreeItemId &  id,
TTreeState  state = TREE_EX_UNDEF 
)
protected

Definition at line 159 of file treectrl_ex.cpp.

References x_ProcessDownstream(), and x_ProcessUpstream().

Referenced by x_SetState().


The documentation for this class was generated from the following files:
Modified on Sat May 04 13:16:46 2024 by modify_doxy.py rev. 669887