NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CCommentGlyph Class Reference

Search Toolkit Book for CCommentGlyph

CCommentGlyph – utility class for having comments in graphical glyphs. More...

#include <gui/widgets/seq_graphic/comment_glyph.hpp>

+ Inheritance diagram for CCommentGlyph:
+ Collaboration diagram for CCommentGlyph:

Public Member Functions

 CCommentGlyph (const string &comment, CRef< CSeqGlyph > glyph)
 
 CCommentGlyph (const string &comment, const TModelPoint &pos, bool repeated=false)
 
const TModelPointGetTargetPos () const
 CCommentGlyph inline methods. More...
 
void SetTargetPos (const TModelPoint &pos)
 
void SetConfig (CConstRef< CCommentConfig > config)
 
CRef< CSeqGlyphGetLinkedGlyph ()
 
CSeqGlyph virtual methods.
virtual bool NeedTooltip (const TModelPoint &p, ITooltipFormatter &tt, string &t_title) const
 Check if need to show tooltip. More...
 
virtual void GetTooltip (const TModelPoint &p, ITooltipFormatter &tt, string &t_title) const
 Get the tooltip if available. More...
 
- Public Member Functions inherited from CSeqGlyph
 CSeqGlyph ()
 
virtual ~CSeqGlyph ()
 
virtual CRef< CSeqGlyphHitTest (const TModelPoint &p)
 Hit testing. More...
 
virtual bool HitTestHor (TSeqPos x, const CObject *obj)
 
virtual bool Intersects (const TModelRect &rect, TConstObjects &objs) const
 Intersect testing. More...
 
virtual void GetHTMLActiveAreas (TAreaVector *) const
 Get html active areas. More...
 
virtual void Update (bool)
 Update content and layout including the bounding box. More...
 
virtual TSeqRange GetRange (void) const
 get the total range of this object. More...
 
virtual bool Accept (IGlyphVisitor *visitor)
 Interface for accepting an IGlyphVisitor. More...
 
virtual bool SetSelected (bool flag)
 Select or deselect this glyph. More...
 
virtual void SetHideLabel (bool)
 Force to hide label. More...
 
virtual bool HasSideLabel () const
 Query if there is label and label is on the side. More...
 
virtual bool IsClickable () const
 Query if this glyph is clickable. More...
 
virtual bool LessBySeqPos (const CSeqGlyph &obj) const
 compare this object to another based on glyph sequence position. More...
 
bool LessByPos (const CSeqGlyph &obj) const
 compare this object to another, based on glyph geometry position. More...
 
bool LessBySeqSize (const CSeqGlyph &obj) const
 compare this object to another, based on sequence size. More...
 
bool LessBySize (const CSeqGlyph &obj) const
 compare this object to another, based on geometry size. More...
 
void Draw () const
 render the layout. More...
 
TModelRect GetModelRect () const
 get the bounding box. More...
 
bool IsIn (const TModelPoint &p) const
 Hit test for points in PARENT COORD. More...
 
bool IsIn (TModelUnit x, TModelUnit y) const
 
bool IsInHor (TModelUnit x) const
 
void SetRender (IGlyphRenderer *renderer)
 set customized renderer for this layout objects. More...
 
void SetRenderingContext (CRenderingContext *context)
 Set the rendering context. More...
 
const CRenderingContextGetRenderingContext () const
 Get the rendering context. More...
 
void SetTearline (size_t Tearline)
 tearline factor – used to limit a list of glyphs More...
 
size_t GetTearline () const
 
void SetTearlineText (const string &sTearlineText)
 tearline text – if set, is appended to the glyph name (does not naffect processing otherwise) More...
 
string GetTearlineText () const
 
void SetRowNum (size_t cur_row)
 
size_t GetRowNum () const
 
void SetVisible (size_t v)
 
size_t GetVisible () const
 
int GetLevel () const
 
void SetLevel (int Level)
 
virtual string GetPName () const
 persistent name of the glyph should not depend on the instance of the glyph, but should uniquely reflect its contents so two glyphs having the same contents will have the same name currently used to track isDrawn() status for expandable glyphs default implementation returns an empty string implementations exist for CFeatGlyph (name of the contained feature) and CLayoutGroup (concatenation of all sorted children names) More...
 
float GetFadeFactor () const
 
virtual bool OnLeftDown (const TModelPoint &)
 
virtual bool OnLeftUp (const TModelPoint &)
 
virtual bool OnLeftDblClick (const TModelPoint &)
 
virtual bool OnContextMenu (wxContextMenuEvent &event)
 
bool IsSelected () const
 
bool IsHighlighted () const
 
CRgbaColorGetHighlightsColor () const
 
virtual TModelUnit GetHeight () const
 
virtual TModelUnit GetWidth () const
 
virtual TModelUnit GetLeft () const
 
virtual TModelUnit GetTop () const
 
virtual TModelUnit GetRight () const
 
virtual TModelUnit GetBottom () const
 
const TModelPointGetPos () const
 
void GetPosInWorld (TModelPoint &pos) const
 Get top left position in world coordinate. More...
 
const CSeqGlyphGetParent (void) const
 
CSeqGlyphGetParent (void)
 
ENeighbours GetNeighbours () const
 
void SetHighlighted (bool flag)
 
void SetHighlightsColor (const CRgbaColor &hl_color)
 
void SetHighlightsColor (const string &hl_color_str)
 
virtual void SetWidth (TModelUnit w)
 
virtual void SetHeight (TModelUnit h)
 
virtual void SetLeft (TModelUnit l)
 
virtual void SetTop (TModelUnit b)
 
virtual void SetPos (const TModelPoint &upper_left)
 
void SetParent (CSeqGlyph *p)
 
CSeqGlyphSetParent (void)
 
void SetNeighbours (ENeighbours neighbours)
 
- Public Member Functions inherited from CObjectEx
 CObjectEx (void)
 
virtual ~CObjectEx (void)
 
- 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 CWeakObject
 CWeakObject (void)
 
virtual ~CWeakObject (void)
 
CPtrToObjectProxyGetPtrProxy (void) const
 Get pointer to proxy object containing pointer to this object. More...
 

Protected Member Functions

virtual void x_Draw () const
 for the case where the linked glyph is a object-based glyph More...
 
virtual void x_UpdateBoundingBox ()
 Update the bounding box assuming children's sizes are fixed if any. More...
 
- Protected Member Functions inherited from CSeqGlyph
virtual void x_DrawHighlight () const
 
void x_DrawInnerLabelColumns (TModelUnit base, const string &label, const CRgbaColor &color, const CGlTextureFont &font, bool side_label_visible) const
 
void x_DrawInnerLabels (TModelUnit base, const string &label, const CRgbaColor &color, const CGlTextureFont &font, bool side_label_visible, bool inside_only, vector< TModelRange > *labels_ranges=nullptr, TSeqRange *interval=nullptr, bool XOR_mode=false) const
 
void x_DrawTruncatedLabel (const string &label, const CGlTextureFont &font, TModelUnit width, TModelUnit x, TModelUnit y, vector< TModelRange > *labels_ranges=nullptr) const
 
void x_DrawException () const
 Draw a shading background to indicate exception. More...
 
virtual void x_OnLayoutChanged ()
 update the layout. More...
 
void x_Parent2Local (TModelPoint &pnt) const
 Transform the coordiante from parent coord. to local coord. More...
 
void x_Parent2Local (TModelUnit &, TModelUnit &y) const
 Transform the coordiante from parent coord. to local coord. More...
 
void x_Parent2Local (TModelRect &rect) const
 Transform the coordiante from parent coord. to local coord. More...
 
void x_World2Local (TModelPoint &p) const
 Transform the coordiante from world coord. to local coord. More...
 
void x_World2Local (TModelUnit &x, TModelUnit &y) const
 
void x_Local2World (TModelPoint &p) const
 Transform the coordiantes from local coord. to world coord. More...
 
void x_Local2World (TModelUnit &x, TModelUnit &y) const
 
void x_InitHTMLActiveArea (CHTMLActiveArea &area) const
 initialize the basic information for a given active area. More...
 
bool x_Visible_V () const
 is this glyph visible in vertical direction? More...
 
template<class T >
bool x_IntersectVisible (const CRange< T > &SeqRange, T &from, T &to) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from CWeakObject
void CleanWeakRefs (void) const
 Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
 

Protected Attributes

CRef< CSeqGlyphm_LinkedGlyph
 associated glyph More...
 
string m_Comment
 label More...
 
TModelPoint m_TargetPos
 target position (if glyph not set) More...
 
bool m_Repeated
 
CConstRef< CCommentConfigm_Config
 
- Protected Attributes inherited from CSeqGlyph
CSeqGlyphm_Parent
 parent/child relationships for this feature More...
 
CRenderingContextm_Context
 the rendering context More...
 
unique_ptr< CRgbaColorm_HighlightsColor
 Highlight color. More...
 
ENeighbours m_Neighbours
 Indicates whether the glyph has neighbours. More...
 

Additional Inherited Members

- Public Types inherited from CSeqGlyph
enum  ENeighbours { eNghbrs_None = 0x0 , eNghbrs_Left = 0x1 , eNghbrs_Right = 0x2 , eNghbrs_Both = 0x3 }
 
typedef vector< CHTMLActiveAreaTAreaVector
 
typedef list< CRef< CSeqGlyph > > TObjects
 
typedef list< CConstRef< CSeqGlyph > > TConstObjects
 
- 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 CSeqGlyph
static bool PointInRect (const TModelPoint &p, const TModelRect &rc)
 
static bool PointInRect (TModelUnit x, TModelUnit y, const TModelRect &rc)
 
- 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

CCommentGlyph – utility class for having comments in graphical glyphs.

For most of cases, a comment glyph may serve as a label for another glyph. In those cases, a comment will be linked to a glyph, and the comment will behave like a delegate of that linked glyph. Since the linked glyph can be a object-based glyph, so is the comment.

Definition at line 53 of file comment_glyph.hpp.

Constructor & Destructor Documentation

◆ CCommentGlyph() [1/2]

CCommentGlyph::CCommentGlyph ( const string comment,
CRef< CSeqGlyph glyph 
)

Definition at line 43 of file comment_glyph.cpp.

◆ CCommentGlyph() [2/2]

CCommentGlyph::CCommentGlyph ( const string comment,
const TModelPoint pos,
bool  repeated = false 
)

Definition at line 51 of file comment_glyph.cpp.

Member Function Documentation

◆ GetLinkedGlyph()

CRef< CSeqGlyph > CCommentGlyph::GetLinkedGlyph ( )
inline

Definition at line 160 of file comment_glyph.hpp.

References m_LinkedGlyph.

◆ GetTargetPos()

const TModelPoint & CCommentGlyph::GetTargetPos ( ) const
inline

CCommentGlyph inline methods.

Definition at line 141 of file comment_glyph.hpp.

References m_TargetPos.

Referenced by CGlyphContainer::x_UpdateComments().

◆ GetTooltip()

void CCommentGlyph::GetTooltip ( const TModelPoint ,
ITooltipFormatter tt,
string t_title 
) const
virtual

Get the tooltip if available.

The x and y are in 'world' coord system which is the coord. system for the uppermost layout object.

Reimplemented from CSeqGlyph.

Definition at line 71 of file comment_glyph.cpp.

References CSeqGlyph::GetTooltip(), and m_LinkedGlyph.

◆ NeedTooltip()

bool CCommentGlyph::NeedTooltip ( const TModelPoint ,
ITooltipFormatter ,
string t_title 
) const
virtual

Check if need to show tooltip.

If the tooltip retrieval is trivial, the derived glyph may decide to fill out the tooltip (info object) in this call.

Reimplemented from CSeqGlyph.

Definition at line 61 of file comment_glyph.cpp.

References m_LinkedGlyph.

◆ SetConfig()

void CCommentGlyph::SetConfig ( CConstRef< CCommentConfig config)
inline

◆ SetTargetPos()

void CCommentGlyph::SetTargetPos ( const TModelPoint pos)
inline

Definition at line 147 of file comment_glyph.hpp.

References m_TargetPos.

Referenced by CGeneModelFeatJob::x_ProcessLandMarkFeatures().

◆ x_Draw()

void CCommentGlyph::x_Draw ( ) const
protectedvirtual

◆ x_UpdateBoundingBox()

void CCommentGlyph::x_UpdateBoundingBox ( )
protectedvirtual

Member Data Documentation

◆ m_Comment

string CCommentGlyph::m_Comment
protected

label

Definition at line 91 of file comment_glyph.hpp.

Referenced by x_Draw(), and x_UpdateBoundingBox().

◆ m_Config

CConstRef<CCommentConfig> CCommentGlyph::m_Config
protected

Definition at line 95 of file comment_glyph.hpp.

Referenced by SetConfig(), x_Draw(), and x_UpdateBoundingBox().

◆ m_LinkedGlyph

CRef<CSeqGlyph> CCommentGlyph::m_LinkedGlyph
protected

associated glyph

Definition at line 90 of file comment_glyph.hpp.

Referenced by GetLinkedGlyph(), GetTooltip(), NeedTooltip(), and x_UpdateBoundingBox().

◆ m_Repeated

bool CCommentGlyph::m_Repeated
protected

Definition at line 93 of file comment_glyph.hpp.

Referenced by x_Draw(), and x_UpdateBoundingBox().

◆ m_TargetPos

TModelPoint CCommentGlyph::m_TargetPos
protected

target position (if glyph not set)

Definition at line 92 of file comment_glyph.hpp.

Referenced by GetTargetPos(), SetTargetPos(), x_Draw(), and x_UpdateBoundingBox().


The documentation for this class was generated from the following files:
Modified on Thu Feb 22 17:10:41 2024 by modify_doxy.py rev. 669887