CGroupMapWidget Class Reference

Search Toolkit Book for CGroupMapWidget

#include <group_map_widget.hpp>

Collaboration diagram for CGroupMapWidget:

[legend]List of all members.

---

Detailed Description

CGroupMapWidget.

Definition at line 48 of file group_map_widget.hpp.

Public Types
typedef CMapControl::TItemRef	TItemRef
typedef vector< TItemRef >	TMapItems
Definitions of data exchange elements
typedef vector< SItemDescr >	TItemDescrVector
typedef vector< SGroupDescr >	TGroupDescrVector
Public Member Functions
	CGroupMapWidget (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL, const wxString &name=_T("groupmapwidget"))
virtual	~CGroupMapWidget ()
virtual void	Init (const TGroupDescrVector &groups)
virtual void	Clear ()
virtual void	AddGroup (const string &label, bool expand=true)
virtual void	AddItem (const string &group_label, const string &label, const string &icon_alias)
virtual void	GetGroupLabels (vector< string > &groups) const
virtual bool	IsExpanded (const string &group) const
virtual string	GetSelectedItem () const
virtual void	ExpandGroup (const string &label)
virtual CMapControl *	GetMapControl ()
Protected Types
typedef vector< SGroup * >	TGroups
Protected Member Functions
int	x_GetGroupIndex (const string &label) const
void	x_OnToggleGroup (CGroupItem &item)
void	x_OnSelectItem (CGroupItem &item)
Protected Attributes
TGroups	m_Groups
CMapControl *	m_Control
wxBitmap	m_OpenIcon
wxBitmap	m_ClosedIcon
Static Protected Attributes
static bool	m_IconsRegistered = 0
	CGroupMapWidget.
Private Types
typedef wxPanel	TParent
Friends
class	CGroupMapWidget::CGroupItem
Classes
class	CGroupItem
	CGroupItem ////////////////////////////////////////////////////////////. More...
struct	SGroup
struct	SGroupDescr
struct	SItemDescr

---

Member Typedef Documentation

typedef vector<SGroupDescr> CGroupMapWidget::TGroupDescrVector

Definition at line 71 of file group_map_widget.hpp.

typedef vector<SGroup*> CGroupMapWidget::TGroups [protected]

Definition at line 141 of file group_map_widget.hpp.

typedef vector<SItemDescr> CGroupMapWidget::TItemDescrVector

Definition at line 61 of file group_map_widget.hpp.

typedef CMapControl::TItemRef CGroupMapWidget::TItemRef

Definition at line 132 of file group_map_widget.hpp.

typedef vector<TItemRef> CGroupMapWidget::TMapItems

Definition at line 133 of file group_map_widget.hpp.

typedef wxPanel CGroupMapWidget::TParent [private]

Definition at line 51 of file group_map_widget.hpp.

---

Constructor & Destructor Documentation

CGroupMapWidget::CGroupMapWidget (  wxWindow *  parent, wxWindowID  id = wxID_ANY, const wxPoint &  pos = wxDefaultPosition, const wxSize &  size = wxDefaultSize, long  style = wxTAB_TRAVERSAL, const wxString &  name = _T("groupmapwidget") )

Definition at line 48 of file group_map_widget.cpp. References _T, CMapControl::eAdjustVertSize, CSelectionControl::fSingleSelection, GetDefaultFileArtProvider(), CMapControl::GetMapItemProperties(), CMapControl::GetProperties(), SwxMapItemProperties::m_BackColor, m_ClosedIcon, CMapControl::SProperties::m_ColumnWidth, m_Control, SwxMapItemProperties::m_HorzMargin, m_IconsRegistered, CMapControl::SProperties::m_ItemOffsetX, CMapControl::SProperties::m_ItemOffsetY, m_OpenIcon, CMapControl::SProperties::m_SeparateGroups, CMapControl::SProperties::m_SepLineWidth, CMapControl::SProperties::m_SingleColumn, CMapControl::SProperties::m_SizePolicy, SwxMapItemProperties::m_TextColor, SwxMapItemProperties::m_VertMargin, wxFileArtProvider::RegisterFileAlias(), and CSelectionControl::SetStyle().

CGroupMapWidget::~CGroupMapWidget (   )  [virtual]

Definition at line 97 of file group_map_widget.cpp. References Clear().

---

Member Function Documentation

void CGroupMapWidget::AddGroup (  const string &  label, bool  expand = true )  [virtual]

Definition at line 138 of file group_map_widget.cpp. References CMapControl::AddItem(), eUnknown, CRef< C, Locker >::GetPointer(), m_ClosedIcon, m_Control, CGroupMapWidget::SGroup::m_GroupItem, m_Groups, m_OpenIcon, NCBI_THROW, and x_GetGroupIndex(). Referenced by Init(), and CwxMainFrame::OnCreateGroupMapWidgetClick().

void CGroupMapWidget::AddItem (  const string &  group_label, const string &  label, const string &  icon_alias )  [virtual]

Definition at line 159 of file group_map_widget.cpp. References CMapControl::GetItemIndex(), CRef< C, Locker >::GetPointer(), CMapControl::InsertItem(), m_Control, CGroupMapWidget::SGroup::m_GroupItem, m_Groups, CGroupMapWidget::SGroup::m_Items, ToWxString(), and x_GetGroupIndex(). Referenced by Init(), and CwxMainFrame::OnCreateGroupMapWidgetClick().

void CGroupMapWidget::Clear (   )  [virtual]

Definition at line 127 of file group_map_widget.cpp. References CMapControl::DeleteAllItems(), m_Control, and m_Groups. Referenced by Init(), and ~CGroupMapWidget().

void CGroupMapWidget::ExpandGroup (  const string &  label  )  [virtual]

Definition at line 222 of file group_map_widget.cpp. References _ASSERT.

void CGroupMapWidget::GetGroupLabels (  vector< string > &  groups  )  const [virtual]

Definition at line 184 of file group_map_widget.cpp. References m_Groups. Referenced by CItemSelectionPanel::SaveSettings().

CMapControl * CGroupMapWidget::GetMapControl (   )  [virtual]

Definition at line 228 of file group_map_widget.cpp. References m_Control. Referenced by CItemSelectionPanel::CreateControls(), CRunToolDlg::CreateControls(), and COpenViewDlg::CreateControls().

string CGroupMapWidget::GetSelectedItem (   )  const [virtual]

Definition at line 207 of file group_map_widget.cpp. References _ASSERT, CMapControl::GetItem(), CMapItem::GetLabel(), CConstRef< C, Locker >::GetPointer(), CMapControl::GetSelectedIndex(), CMapItem::IsGroupSeparator(), and m_Control. Referenced by CItemSelectionPanel::GetSelectedItemRef(), and CItemSelectionPanel::OnItemSelected().

void CGroupMapWidget::Init (  const TGroupDescrVector &  groups  )  [virtual]

Definition at line 104 of file group_map_widget.cpp. References AddGroup(), AddItem(), and Clear().

bool CGroupMapWidget::IsExpanded (  const string &  group  )  const [virtual]

Definition at line 193 of file group_map_widget.cpp. References eUnknown, CGroupMapWidget::SGroup::m_GroupItem, m_Groups, NCBI_THROW, and x_GetGroupIndex(). Referenced by CItemSelectionPanel::SaveSettings().

int CGroupMapWidget::x_GetGroupIndex (  const string &  label  )  const [protected]

Definition at line 234 of file group_map_widget.cpp. References m_Groups. Referenced by AddGroup(), AddItem(), IsExpanded(), and x_OnToggleGroup().

void CGroupMapWidget::x_OnSelectItem (  CGroupItem &  item  )  [protected]

Definition at line 276 of file group_map_widget.cpp. References GetId(), CMapItem::GetLabel(), and ToWxString(). Referenced by CGroupMapWidget::CGroupItem::OnDefaultAction().

void CGroupMapWidget::x_OnToggleGroup (  CGroupItem &  item  )  [protected]

Definition at line 246 of file group_map_widget.cpp. References _ASSERT, CMapControl::DeleteItem(), CGroupMapWidget::CGroupItem::Expand(), CMapControl::GetItemIndex(), CMapItem::GetLabel(), CRef< C, Locker >::GetPointer(), CMapControl::InsertItem(), CGroupMapWidget::CGroupItem::IsExpanded(), CMapControl::LockUpdates(), m_ClosedIcon, m_Control, m_Groups, m_OpenIcon, CMapItem::SetIcon(), and x_GetGroupIndex(). Referenced by CGroupMapWidget::CGroupItem::OnDefaultAction().

---

Friends And Related Function Documentation

friend class CGroupMapWidget::CGroupItem [friend]

Definition at line 130 of file group_map_widget.hpp.

---

Member Data Documentation

wxBitmap CGroupMapWidget::m_ClosedIcon [protected]

Definition at line 155 of file group_map_widget.hpp. Referenced by AddGroup(), CGroupMapWidget(), and x_OnToggleGroup().

CMapControl* CGroupMapWidget::m_Control [protected]

Definition at line 152 of file group_map_widget.hpp. Referenced by AddGroup(), AddItem(), CGroupMapWidget(), Clear(), GetMapControl(), GetSelectedItem(), and x_OnToggleGroup().

TGroups CGroupMapWidget::m_Groups [protected]

Definition at line 150 of file group_map_widget.hpp. Referenced by AddGroup(), AddItem(), Clear(), GetGroupLabels(), IsExpanded(), x_GetGroupIndex(), and x_OnToggleGroup().

bool CGroupMapWidget::m_IconsRegistered = 0 [static, protected]

CGroupMapWidget. Definition at line 148 of file group_map_widget.hpp. Referenced by CGroupMapWidget().

wxBitmap CGroupMapWidget::m_OpenIcon [protected]

Definition at line 154 of file group_map_widget.hpp. Referenced by AddGroup(), CGroupMapWidget(), and x_OnToggleGroup().

---

The documentation for this class was generated from the following files:

• include/gui/widgets/wx/group_map_widget.hpp
• src/gui/widgets/wx/group_map_widget.cpp

---