NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
CQuickLaunchList Class Reference

Search Toolkit Book for CQuickLaunchList

CQuickLaunchList. More...

#include <gui/core/quick_launch_list.hpp>

+ Inheritance diagram for CQuickLaunchList:
+ Collaboration diagram for CQuickLaunchList:

Public Member Functions

bool IsEmpty () const
 
const list< string > & GetItems () const
 
void AddItem (const string &item)
 
void RemoveItem (const string &item)
 
string GetItemPath (const string &item) const
 
void UpdateMenu (wxMenu &menu, int cmdStart, int cmdEnd, size_t pos=(size_t) -1)
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Static Public Member Functions

static CQuickLaunchListGetInstance ()
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 

Private Member Functions

 CQuickLaunchList ()
 
 CQuickLaunchList (const CQuickLaunchList &)
 
CQuickLaunchListoperator= (const CQuickLaunchList &)
 
void x_Load ()
 
void x_Save () const
 

Private Attributes

CMRUList< stringm_ToolList
 

Additional Inherited Members

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

CQuickLaunchList.

Definition at line 48 of file quick_launch_list.hpp.

Constructor & Destructor Documentation

◆ CQuickLaunchList() [1/2]

CQuickLaunchList::CQuickLaunchList ( )
private

Definition at line 44 of file quick_launch_list.cpp.

Referenced by GetInstance().

◆ CQuickLaunchList() [2/2]

CQuickLaunchList::CQuickLaunchList ( const CQuickLaunchList )
private

Member Function Documentation

◆ AddItem()

void CQuickLaunchList::AddItem ( const string item)

Definition at line 122 of file quick_launch_list.cpp.

References CMRUList< T >::AddItem(), m_ToolList, and x_Save().

Referenced by CRunToolDlg::OnButtonClick().

◆ GetInstance()

CQuickLaunchList & CQuickLaunchList::GetInstance ( void  )
static

Definition at line 49 of file quick_launch_list.cpp.

References CQuickLaunchList(), and s_Instance.

Referenced by CRunToolDlg::OnButtonClick().

◆ GetItemPath()

string CQuickLaunchList::GetItemPath ( const string item) const

Definition at line 59 of file quick_launch_list.cpp.

References kQLPath.

Referenced by CRunToolDlg::OnButtonClick().

◆ GetItems()

const list< string > & CQuickLaunchList::GetItems ( ) const

Definition at line 117 of file quick_launch_list.cpp.

References CMRUList< T >::GetItems(), and m_ToolList.

◆ IsEmpty()

bool CQuickLaunchList::IsEmpty ( void  ) const

Definition at line 112 of file quick_launch_list.cpp.

References CMRUList< T >::GetItems(), and m_ToolList.

Referenced by UpdateMenu().

◆ operator=()

CQuickLaunchList& CQuickLaunchList::operator= ( const CQuickLaunchList )
private

◆ RemoveItem()

void CQuickLaunchList::RemoveItem ( const string item)

Definition at line 128 of file quick_launch_list.cpp.

References m_ToolList, CMRUList< T >::RemoveItem(), and x_Save().

◆ UpdateMenu()

void CQuickLaunchList::UpdateMenu ( wxMenu &  menu,
int  cmdStart,
int  cmdEnd,
size_t  pos = (size_t)-1 
)

◆ x_Load()

void CQuickLaunchList::x_Load ( )
private

◆ x_Save()

void CQuickLaunchList::x_Save ( ) const
private

Member Data Documentation

◆ m_ToolList

CMRUList<string> CQuickLaunchList::m_ToolList
private

Definition at line 70 of file quick_launch_list.hpp.

Referenced by AddItem(), GetItems(), IsEmpty(), RemoveItem(), UpdateMenu(), x_Load(), and x_Save().


The documentation for this class was generated from the following files:
Modified on Tue Dec 05 02:19:24 2023 by modify_doxy.py rev. 669887