#include <gui/widgets/edit/macro_argument.hpp>

Inheritance diagram for CArgument:

Collaboration diagram for CArgument:

Public Member Functions
	CArgument (const macro::SArgMetaData &arg, bool enabled=true, bool shown=true)

const TStdStringPublisher &	GetValue () const

const string &	GetName () const

const macro::SArgMetaData &	GetArgMetaData () const

const TBoolPublisher &	GetEnabled () const

const TBoolPublisher &	GetShown () const

TStdStringPublisher &	SetValue ()

TBoolPublisher &	SetEnabled ()

TBoolPublisher &	SetShown ()

void	Attach (IArgumentSubscriber *subscriber) const

void	Detach (IArgumentSubscriber *subscriber) const

bool	IsTrue () const

bool	Empty () const

virtual	~CArgument ()

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (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

Protected Member Functions
void	Notify ()

void	Update (string const &value)

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Private Types
typedef vector< IArgumentSubscriber * >	TSubscribersVector

Private Attributes
TSubscribersVector	m_Subscribers

const macro::SArgMetaData	m_Arg

TStdStringPublisher	m_Value

TBoolPublisher	m_Enabled

TBoolPublisher	m_Shown

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< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

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)

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...

Detailed Description

Definition at line 50 of file macro_argument.hpp.

Member Typedef Documentation

◆ TSubscribersVector

typedef vector<IArgumentSubscriber*> CArgument::TSubscribersVector

private

Definition at line 84 of file macro_argument.hpp.

Constructor & Destructor Documentation

◆ CArgument()

CArgument::CArgument	(	const macro::SArgMetaData &	arg,
		bool	enabled = `true`,
		bool	shown = `true`
	)

◆ ~CArgument()

virtual CArgument::~CArgument ( )

inlinevirtual

Definition at line 73 of file macro_argument.hpp.

Member Function Documentation

◆ Attach()

void CArgument::Attach ( IArgumentSubscriber * subscriber ) const

Definition at line 44 of file macro_argument.cpp.

References assert, and m_Subscribers.

Referenced by CArgumentList::Add().

◆ Detach()

void CArgument::Detach ( IArgumentSubscriber * subscriber ) const

Definition at line 50 of file macro_argument.cpp.

References assert, and m_Subscribers.

◆ Empty()

bool CArgument::Empty ( void ) const

inline

Definition at line 71 of file macro_argument.hpp.

References CPublisherT< T >::get(), and m_Value.

◆ GetArgMetaData()

const macro::SArgMetaData& CArgument::GetArgMetaData ( ) const

inline

Definition at line 59 of file macro_argument.hpp.

References m_Arg.

◆ GetEnabled()

const TBoolPublisher& CArgument::GetEnabled ( void ) const

inline

Definition at line 60 of file macro_argument.hpp.

References m_Enabled.

Referenced by NMItemData::GetUpdatemRNADescription(), and NMItemData::OnSelectTable().

◆ GetName()

const string& CArgument::GetName ( void ) const

inline

Definition at line 58 of file macro_argument.hpp.

References m_Arg.

Referenced by NMItemData::OnAfterCheck(), NMItemData::OnAutodefCompleteSelected(), NMItemData::OnBeforeCheck(), NMItemData::OnControlsAddRNAPanelSelected(), NMItemData::OnConvertFeatFromCDS(), NMItemData::OnConvertFeatToChanged(), NMItemData::OnDOILookupModeChanged(), NMItemData::OnExistingTextChanged(), NMItemData::OnIllegalDbXrefSelected(), NMItemData::OnLeftDigitsLettersInParsePanels(), NMItemData::OnMiscFeatRuleSelected(), NMItemData::OnProductDouble(), NMItemData::OnProteinNameDouble(), NMItemData::OnProteinNameSingle(), NMItemData::OnRemoveFromParsedField(), NMItemData::OnRightDigitsLettersInParsePanels(), NMItemData::OnRnaTypeChanged(), NMItemData::OnSelectFeature(), NMItemData::OnSelectTable(), NMItemData::OnStructCommFieldChanged(), and NMItemData::OnStructCommFieldDblChanged().

◆ GetShown()

const TBoolPublisher& CArgument::GetShown ( void ) const

inline

Definition at line 61 of file macro_argument.hpp.

References m_Shown.

◆ GetValue()

const TStdStringPublisher& CArgument::GetValue ( void ) const

inline

◆ IsTrue()

bool CArgument::IsTrue ( void ) const

inline

Definition at line 70 of file macro_argument.hpp.

References CPublisherT< T >::get(), and m_Value.

Referenced by NMItemData::OnAutodefCompleteSelected(), NMItemData::OnDOILookupModeChanged(), NMItemData::OnIllegalDbXrefSelected(), NMItemData::OnMiscFeatRuleSelected(), and NMItemData::OnSelectTable().

◆ Notify()

void CArgument::Notify ( )

protected

Definition at line 63 of file macro_argument.cpp.

References m_Subscribers.

Referenced by Update().

◆ SetEnabled()

TBoolPublisher& CArgument::SetEnabled ( void )

inline

Definition at line 64 of file macro_argument.hpp.

References m_Enabled.

◆ SetShown()

TBoolPublisher& CArgument::SetShown ( void )

inline

Definition at line 65 of file macro_argument.hpp.

References m_Shown.

◆ SetValue()

TStdStringPublisher& CArgument::SetValue ( void )

inline

Definition at line 63 of file macro_argument.hpp.

References m_Value.

◆ Update()

void CArgument::Update ( string const & value )

inlineprotectedvirtual

Implements ISubscriberT< string >.

Definition at line 78 of file macro_argument.hpp.

References Notify().

Member Data Documentation

◆ m_Arg

const macro::SArgMetaData CArgument::m_Arg

private

Definition at line 88 of file macro_argument.hpp.

Referenced by GetArgMetaData(), and GetName().

◆ m_Enabled

TBoolPublisher CArgument::m_Enabled

private

Definition at line 90 of file macro_argument.hpp.

Referenced by GetEnabled(), and SetEnabled().

◆ m_Shown

TBoolPublisher CArgument::m_Shown

private

Definition at line 91 of file macro_argument.hpp.

Referenced by GetShown(), and SetShown().

◆ m_Subscribers

TSubscribersVector CArgument::m_Subscribers

mutableprivate

Definition at line 85 of file macro_argument.hpp.

Referenced by Attach(), Detach(), and Notify().

◆ m_Value

TStdStringPublisher CArgument::m_Value

private

Definition at line 89 of file macro_argument.hpp.

Referenced by Empty(), GetValue(), IsTrue(), and SetValue().

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

include/gui/widgets/edit/macro_argument.hpp
src/gui/widgets/edit/macro_argument.cpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TSubscribersVector

Constructor & Destructor Documentation

◆ CArgument()

◆ ~CArgument()

Member Function Documentation

◆ Attach()

◆ Detach()

◆ Empty()

◆ GetArgMetaData()

◆ GetEnabled()

◆ GetName()

◆ GetShown()

◆ GetValue()

◆ IsTrue()

◆ Notify()

◆ SetEnabled()

◆ SetShown()

◆ SetValue()

◆ Update()

Member Data Documentation

◆ m_Arg

◆ m_Enabled

◆ m_Shown

◆ m_Subscribers

◆ m_Value