NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Private Types | Private Attributes | List of all members
CStringListCtrl Class Reference

Search Toolkit Book for CStringListCtrl

#include "string_list_ctrl.hpp"
(Private to src/gui/widgets/edit.)

+ Inheritance diagram for CStringListCtrl:
+ Collaboration diagram for CStringListCtrl:

Classes

class  CConstIterator
 

Public Types

enum  { kStringIdBase = 10100 , kMaxStringsCount = 100 }
 

Public Member Functions

 CStringListCtrl ()
 Constructors. More...
 
 CStringListCtrl (wxWindow *parent, wxWindowID id=ID_CSTRINGSPANEL, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
 
bool Create (wxWindow *parent, wxWindowID id=ID_CSTRINGSPANEL, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
 Creation. More...
 
size_t GetMaxStringsCount () const
 
bool AddString (const string &value)
 
void Clear ()
 
 ~CStringListCtrl ()
 Destructor. More...
 
void Init ()
 Initialises member variables. More...
 
void CreateControls ()
 Creates the controls and sizers. More...
 
int GetCurrentStringId () const
 
void SetCurrentStringId (int value)
 
wxBitmap GetBitmapResource (const wxString &name)
 Retrieves bitmap resources. More...
 
wxIcon GetIconResource (const wxString &name)
 Retrieves icon resources. More...
 

Static Public Member Functions

static bool ShowToolTips ()
 Should we show tooltips? More...
 

Public Attributes

wxFlexGridSizer * m_GridSizer
 

Protected Member Functions

void OnTextCtrlUpdated (wxCommandEvent &event)
 
void OnDelete (wxHyperlinkEvent &event)
 
int FindSlot ()
 

Private Types

enum  { ID_CSTRINGSPANEL = 10016 }
 Control identifiers. More...
 

Private Attributes

int m_CurrentStringId
 

Detailed Description

CStringListCtrl class declaration

Definition at line 72 of file string_list_ctrl.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kStringIdBase 
kMaxStringsCount 

Definition at line 82 of file string_list_ctrl.hpp.

◆ anonymous enum

anonymous enum
private

Control identifiers.

Enumerator
ID_CSTRINGSPANEL 

Definition at line 141 of file string_list_ctrl.hpp.

Constructor & Destructor Documentation

◆ CStringListCtrl() [1/2]

CStringListCtrl::CStringListCtrl ( )

Constructors.

CStringListCtrl type definition

CStringListCtrl event table definition

CStringListCtrl constructors

Definition at line 79 of file string_list_ctrl.cpp.

References Init().

◆ CStringListCtrl() [2/2]

CStringListCtrl::CStringListCtrl ( wxWindow *  parent,
wxWindowID  id = ID_CSTRINGSPANEL,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(400, 300),
long  style = wxTAB_TRAVERSAL 
)

Definition at line 84 of file string_list_ctrl.cpp.

References Create(), Init(), and ncbi::grid::netcache::search::fields::size.

◆ ~CStringListCtrl()

CStringListCtrl::~CStringListCtrl ( )

Destructor.

CStringListCtrl destructor

Definition at line 118 of file string_list_ctrl.cpp.

Member Function Documentation

◆ AddString()

bool CStringListCtrl::AddString ( const string value)

◆ Clear()

void CStringListCtrl::Clear ( void  )

◆ Create()

bool CStringListCtrl::Create ( wxWindow *  parent,
wxWindowID  id = ID_CSTRINGSPANEL,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(400, 300),
long  style = wxTAB_TRAVERSAL 
)

Creation.

CStringListCtrl creator

Definition at line 95 of file string_list_ctrl.cpp.

References CreateControls(), and ncbi::grid::netcache::search::fields::size.

Referenced by CStringListCtrl().

◆ CreateControls()

void CStringListCtrl::CreateControls ( )

Creates the controls and sizers.

Control creation for CStringListCtrl

Definition at line 142 of file string_list_ctrl.cpp.

References m_GridSizer.

Referenced by Create().

◆ FindSlot()

int CStringListCtrl::FindSlot ( )
protected

Definition at line 217 of file string_list_ctrl.cpp.

References kMaxStringsCount, and kStringIdBase.

Referenced by AddString().

◆ GetBitmapResource()

wxBitmap CStringListCtrl::GetBitmapResource ( const wxString &  name)

Retrieves bitmap resources.

Get bitmap resources

Definition at line 172 of file string_list_ctrl.cpp.

◆ GetCurrentStringId()

int CStringListCtrl::GetCurrentStringId ( ) const
inline

Definition at line 123 of file string_list_ctrl.hpp.

References m_CurrentStringId.

◆ GetIconResource()

wxIcon CStringListCtrl::GetIconResource ( const wxString &  name)

Retrieves icon resources.

Get icon resources

Definition at line 185 of file string_list_ctrl.cpp.

◆ GetMaxStringsCount()

size_t CStringListCtrl::GetMaxStringsCount ( ) const
inline

◆ Init()

void CStringListCtrl::Init ( void  )

Initialises member variables.

Member initialisation

Definition at line 129 of file string_list_ctrl.cpp.

References m_CurrentStringId, m_GridSizer, and NULL.

Referenced by CStringListCtrl().

◆ OnDelete()

void CStringListCtrl::OnDelete ( wxHyperlinkEvent &  event)
protected

Definition at line 246 of file string_list_ctrl.cpp.

References AddString(), m_CurrentStringId, m_GridSizer, and rapidjson::value.

◆ OnTextCtrlUpdated()

void CStringListCtrl::OnTextCtrlUpdated ( wxCommandEvent &  event)
protected

Definition at line 229 of file string_list_ctrl.cpp.

References AddString(), m_CurrentStringId, and s_flagReentrancy.

◆ SetCurrentStringId()

void CStringListCtrl::SetCurrentStringId ( int  value)
inline

Definition at line 124 of file string_list_ctrl.hpp.

References m_CurrentStringId, and rapidjson::value.

◆ ShowToolTips()

bool CStringListCtrl::ShowToolTips ( )
static

Should we show tooltips?

Should we show tooltips?

Definition at line 163 of file string_list_ctrl.cpp.

Member Data Documentation

◆ m_CurrentStringId

int CStringListCtrl::m_CurrentStringId
private

◆ m_GridSizer

wxFlexGridSizer* CStringListCtrl::m_GridSizer

Definition at line 137 of file string_list_ctrl.hpp.

Referenced by AddString(), Clear(), CreateControls(), Init(), and OnDelete().


The documentation for this class was generated from the following files:
Modified on Tue Apr 16 20:10:34 2024 by modify_doxy.py rev. 669887