Search Toolkit Book for CEditObjectSeq_desc

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

Inheritance diagram for CEditObjectSeq_desc:

Collaboration diagram for CEditObjectSeq_desc:

Public Types
enum	EDescriptorType { eUnknown = 0 , eTPA , eStructuredComment , eRefGene , eDBLink , eUnverified , eUnreviewed , eAuthorizedAccess , eComment , eTitle , eName , eRegion , ePub , eMolinfo , eSource }

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

Public Member Functions
	CEditObjectSeq_desc (const CObject &object, const objects::CSeq_entry_Handle &seh, objects::CScope &scope, bool createMode)

virtual wxWindow *	CreateWindow (wxWindow *parent)
	creates a child (not top level) windows that can contain whatever controls/subwindows etc. More...

virtual IEditCommand *	GetEditCommand ()
	After placing the window in the Edit Object Dialog ShowModal() method of the dialog is called. More...

virtual void	LocationChange (objects::CSeq_entry_Handle seh, wxTopLevelWindow *gui_widget)

void	MolInfoLocationChange (objects::CSeq_entry_Handle seh, IDescEditorPanel edit, CMolInfoPanel molPanel)

CRef< CSerialObject >	GetEditObject (void)

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

Public Member Functions inherited from IEditObject
virtual	~IEditObject ()

virtual bool	CanClose ()

Static Public Member Functions
static pair< EDescriptorType, string >	GetDescriptorType (const objects::CSeqdesc &desc)

static objects::CSeqdesc::E_Choice	GetDescChoiceForType (EDescriptorType desc_type)

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
void	x_PopulateWindow (objects::CSeqdesc &desc)

bool	ReplaceAll (void)

Private Attributes
CConstRef< CObject >	m_Object

CConstRef< CObject >	m_Bioseq

CRef< objects::CScope >	m_Scope

objects::CSeq_entry_Handle	m_SEH

bool	m_CreateMode

CRef< CSerialObject >	m_EditedDescriptor

CRef< CSerialObject >	m_EditedBioseq

CIRef< IEditCommand >	m_EditAction

wxPanel *	m_Window

CDescPlacementPanel *	m_Placement

wxCheckBox *	m_ReplaceAll

Additional Inherited Members
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

Definition at line 51 of file edit_object_seq_desc.hpp.

Member Enumeration Documentation

◆ EDescriptorType

enum CEditObjectSeq_desc::EDescriptorType

Enumerator
eUnknown
eTPA
eStructuredComment
eRefGene
eDBLink
eUnverified
eUnreviewed
eAuthorizedAccess
eComment
eTitle
eName
eRegion
ePub
eMolinfo
eSource

Definition at line 64 of file edit_object_seq_desc.hpp.

Constructor & Destructor Documentation

◆ CEditObjectSeq_desc()

CEditObjectSeq_desc::CEditObjectSeq_desc	(	const CObject &	object,
		const objects::CSeq_entry_Handle &	seh,
		objects::CScope &	scope,
		bool	createMode
	)

inline

Definition at line 54 of file edit_object_seq_desc.hpp.

Member Function Documentation

◆ CreateWindow()

wxWindow * CEditObjectSeq_desc::CreateWindow ( wxWindow * parent )

virtual

creates a child (not top level) windows that can contain whatever controls/subwindows etc.

needed to edit an object. This window is placed in a placeholder of Edit Object Dialog (top level window). In the future we can present this window somewhere else (GBench view for example).

Implements IEditObject.

Definition at line 115 of file edit_object_seq_desc.cpp.

References _, CSerialObject::Assign(), eAuthorizedAccess, eComment, eDBLink, eMolinfo, eName, ePub, eRefGene, eRegion, eSource, eStructuredComment, eTitle, eTPA, CSeqdesc::eType, eUnknown, eUnreviewed, eUnverified, GetBioseqForSeqdesc(), GetDescriptorType(), CSeqdesc::GetLabel(), CConstRef< C, Locker >::GetNonNullPointer(), CRef< C, Locker >::GetPointer(), CSequencingTechnologyPanel::GetReplaceAll(), CSeqdesc_Base::IsMolinfo(), CSeq_entry_Handle::IsSeq(), LocationChange(), m_Bioseq, m_CreateMode, m_EditedBioseq, m_EditedDescriptor, m_Placement, m_ReplaceAll, m_Scope, m_SEH, m_Window, NCBI_THROW, NULL, CDescPlacementPanel::PopulateLocationChoices(), CRef< C, Locker >::Reset(), CConstRef< C, Locker >::Reset(), s_IsTpa(), CAssemblyTrackingPanel::SetBioseq(), CHolderPanel::SetEditor(), IHelpUrlClient::SetHelpUrl(), CSeqdesc_Base::SetMolinfo(), CDescPlacementPanel::SetNotify(), CSeqdesc_Base::SetPub(), CSeqdesc_Base::SetUser(), CAssemblyTrackingPanel::SetUser_object(), CAuthorizedAccessPanel::SetUser_object(), CRefGeneTrackingPanel::SetUser_object(), CUnreviewedPanel::SetUser_object(), CUnverifiedPanel::SetUser_object(), CDBLinkPanel::TransferDataToWindow(), and wxID_ANY.

◆ GetDescChoiceForType()

CSeqdesc::E_Choice CEditObjectSeq_desc::GetDescChoiceForType ( EDescriptorType desc_type )

static

Definition at line 890 of file edit_object_seq_desc.cpp.

References CSeqdesc_Base::e_Comment, CSeqdesc_Base::e_Molinfo, CSeqdesc_Base::e_Name, CSeqdesc_Base::e_not_set, CSeqdesc_Base::e_Pub, CSeqdesc_Base::e_Region, CSeqdesc_Base::e_Source, CSeqdesc_Base::e_Title, CSeqdesc_Base::e_User, eAuthorizedAccess, eComment, eDBLink, eMolinfo, eName, ePub, eRefGene, eRegion, eSource, eStructuredComment, eTitle, eTPA, eUnknown, eUnreviewed, and eUnverified.

Referenced by LocationChange().

◆ GetDescriptorType()

pair< CEditObjectSeq_desc::EDescriptorType, string > CEditObjectSeq_desc::GetDescriptorType ( const objects::CSeqdesc & desc )

static

Definition at line 932 of file edit_object_seq_desc.cpp.

References CSeqdesc_Base::e_Comment, CSeqdesc_Base::e_Molinfo, CSeqdesc_Base::e_Name, CSeqdesc_Base::e_Pub, CSeqdesc_Base::e_Region, CSeqdesc_Base::e_Source, CSeqdesc_Base::e_Title, CSeqdesc_Base::e_User, eAuthorizedAccess, eComment, eDBLink, eMolinfo, eName, CUser_object::eObjectType_DBLink, CUser_object::eObjectType_OriginalId, CUser_object::eObjectType_StructuredComment, CUser_object::eObjectType_Unreviewed, CUser_object::eObjectType_Unverified, ePub, NStr::Equal(), NStr::EqualNocase(), eRefGene, eRegion, eSource, eStructuredComment, eTitle, eTPA, eUnknown, eUnreviewed, eUnverified, CUser_object_Base::GetData(), CUser_object::GetObjectType(), CObject_id_Base::GetStr(), CUser_object_Base::GetType(), CSeqdesc_Base::GetUser(), CUser_object_Base::IsSetType(), CObject_id_Base::IsStr(), ITERATE, label, s_IsTpa(), and CSeqdesc_Base::Which().

Referenced by CreateEditorForObject(), CreateWindow(), CBioseqEditor::IsEditable(), and LocationChange().

◆ GetEditCommand()

IEditCommand * CEditObjectSeq_desc::GetEditCommand ( )

virtual

After placing the window in the Edit Object Dialog ShowModal() method of the dialog is called.

If OK button is called the second method of IEditObject dialog is called which returns object derived from IEditCommand. This object implements actual modifications of original object in the Project/Document via Execute() method.

Implements IEditObject.

Definition at line 571 of file edit_object_seq_desc.cpp.

References _TRACE, CCmdComposite::AddCommand(), AddDescToSeqEntry(), CSerialObject::Assign(), cmd, CreateMolInfoDesc(), CSeqdesc_Base::e_not_set, CSeqdesc_Base::e_Pub, CBioseq_set_Base::eClass_nuc_prot, CSerialObject::Equals(), Error(), eSerial_AsnText, CSeqdescTitleEdit::GetBioseq_Handle(), CBioseq_set_Handle::GetClass(), CBioseq_Handle::GetCompleteBioseq(), CBioseq_Base::GetInst(), CDescPlacementPanel::GetLocationChoice(), CException::GetMsg(), CConstRef< C, Locker >::GetNonNullPointer(), CRef< C, Locker >::GetObject(), CConstRef< C, Locker >::GetPointer(), CRef< C, Locker >::GetPointer(), CConstRef< C, Locker >::GetPointerOrNull(), CRef< C, Locker >::GetPointerOrNull(), CPubdesc_Base::GetPub(), CSeqdesc_Base::GetPub(), CSeq_entry_Handle::GetSeq(), CSeqdesc_CI::GetSeq_entry_Handle(), GetSeqEntryForSeqdesc(), CSeq_entry_Handle::GetSet(), CSeqdesc_Base::GetTitle(), CSeq_entry_Handle::GetTopLevelEntry(), CSeqdesc_Base::GetUser(), CSeqdesc_Base::IsMolinfo(), CRef< C, Locker >::IsNull(), CSeqdesc_Base::IsPub(), CSeq_entry_Handle::IsSeq(), CSeq_entry_Handle::IsSet(), CBioseq_set_Handle::IsSetClass(), CUser_object_Base::IsSetData(), CSeqdesc_Base::IsUser(), LOG_POST, m_Bioseq, m_CreateMode, m_EditAction, m_EditedBioseq, m_EditedDescriptor, m_Object, m_Placement, m_Scope, m_SEH, m_Window, NULL, CObjectOStream::Open(), out(), ReplaceAll(), CRef< C, Locker >::Reset(), CConstRef< C, Locker >::Reset(), s_IsTpa(), s_ReplaceAllMolinfo(), CPub_equiv::SameCitation(), CMolInfoPanel::SetBioseqValues(), TestForNonAsciiText(), CSeqdesc_Base::Which(), and wxT.