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

Search Toolkit Book for CEditObjectSet

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

+ Inheritance diagram for CEditObjectSet:
+ Collaboration diagram for CEditObjectSet:

Public Member Functions

 CEditObjectSet (const CObject &object, objects::CScope &scope)
 
virtual wxWindow * CreateWindow (wxWindow *parent)
 creates a child (not top level) windows that can contain whatever controls/subwindows etc. More...
 
virtual IEditCommandGetEditCommand ()
 After placing the window in the Edit Object Dialog ShowModal() method of the dialog is called. More...
 
- 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
 
- Public Member Functions inherited from IEditObject
virtual ~IEditObject ()
 
virtual bool CanClose ()
 

Private Types

enum  { ID_NOTEBOOK = 10015 }
 

Private Attributes

CConstRef< CObjectm_Object
 
CRef< objects::CScope > m_Scope
 
CIRef< IEditCommandm_EditAction
 
wxPanel * m_Window
 

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 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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 45 of file edit_object_set.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
ID_NOTEBOOK 

Definition at line 56 of file edit_object_set.hpp.

Constructor & Destructor Documentation

◆ CEditObjectSet()

CEditObjectSet::CEditObjectSet ( const CObject object,
objects::CScope &  scope 
)
inline

Definition at line 48 of file edit_object_set.hpp.

Member Function Documentation

◆ CreateWindow()

wxWindow * CEditObjectSet::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 56 of file edit_object_set.cpp.

References _, CBioseq_set_Base::eClass_not_set, eUnknown, m_Window, NCBI_THROW, and CSetClassPanel::SetClass().

◆ GetEditCommand()

IEditCommand * CEditObjectSet::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 74 of file edit_object_set.cpp.

References CSerialObject::Assign(), cmd, CSeq_descr_Base::Get(), CSetClassPanel::GetClass(), CBioseq_set_Base::GetClass(), CBioseq_set_Base::GetDescr(), CRef< C, Locker >::GetPointer(), CBioseq_set_Base::IsSetDescr(), m_EditAction, m_Scope, m_Window, CBioseq_set::NeedsDocsumTitle(), CRef< C, Locker >::Reset(), CBioseq_set_Base::ResetDescr(), CBioseq_set_Base::SetClass(), and CBioseq_set_Base::SetDescr().

Member Data Documentation

◆ m_EditAction

CIRef<IEditCommand> CEditObjectSet::m_EditAction
private

Definition at line 63 of file edit_object_set.hpp.

Referenced by GetEditCommand().

◆ m_Object

CConstRef<CObject> CEditObjectSet::m_Object
private

Definition at line 60 of file edit_object_set.hpp.

◆ m_Scope

CRef<objects::CScope> CEditObjectSet::m_Scope
mutableprivate

Definition at line 61 of file edit_object_set.hpp.

Referenced by GetEditCommand().

◆ m_Window

wxPanel* CEditObjectSet::m_Window
private

Definition at line 65 of file edit_object_set.hpp.

Referenced by CreateWindow(), and GetEditCommand().


The documentation for this class was generated from the following files:
Modified on Sat Dec 09 04:46:03 2023 by modify_doxy.py rev. 669887