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

Search Toolkit Book for CCSSTableTooltipFormatter

tooltips using html tables with css classes from projects/sviewer/css/style.css and generated NCBI URLs are paths (recommended for SViewer) More...

#include <gui/objutils/tooltip.hpp>

+ Inheritance diagram for CCSSTableTooltipFormatter:
+ Collaboration diagram for CCSSTableTooltipFormatter:

Public Member Functions

virtual CIRef< ITooltipFormatterCreateInstance ()
 creates another instance of the same tooltip formatter More...
 
virtual void StartRow ()
 start a new table row More...
 
virtual void AddBulletCol (const string &sBulletSrc="")
 add a cell with an image More...
 
virtual void AddTagCol (const string &sContents="", const string &sBulletSrc="")
 adds a tag column to the row More...
 
virtual void AddValueCol (const string &sContents="", unsigned width=200, bool isNoWrap=false)
 adds a value column to the row More...
 
virtual void FinishRow ()
 finish the row (i.e. no other contents will be added to it) More...
 
virtual void AddDividerRow (unsigned colspan=2)
 add a horizontal divider between sections of the table More...
 
virtual void AddRow (const string &sContents="", unsigned colspan=2)
 add a row with a cell, spanning across all columns More...
 
virtual void AddRow (const string &sTag, const string &sValue, unsigned valueColWidth=200, bool=false)
 add a row with two columns More...
 
virtual void AddLinkRow (const string &sTag, const string &sValue, unsigned valueColWidth=200)
 add a row with two columns More...
 
virtual void AddLinkRow (const string &sTag, const string &sText, const string &sUrl, unsigned valueColWidth=200)
 add a row with two columns, the second containing a link More...
 
virtual void AddLinksTitle (const string &sTitle)
 add a row with the links title More...
 
virtual void AddSectionRow (const string &sContents)
 add a section row More...
 
virtual string Render ()
 returns the formatted tooltip text and resets the formatter for reuse More...
 
virtual bool IsEmpty () const
 Indicates if the tooltip is empty. More...
 
virtual string CreateLink (const string &sText, const string &sUrl) const
 construct the HTML code for a link from the displayed text label and supplied URL More...
 
virtual string CreateNcbiLink (const string &sText, const string &sUrl) const
 construct the HTML code for a link from the displayed text label and supplied NCBI URL path More...
 
virtual void AddPubmedLinksRow (const string &pmids, bool &isGoToPresent, bool isBulletColPresent)
 add a row containing all links to specified Pubmed IDs More...
 
virtual void MaybeAddGoToRow (bool &isGoToPresent, bool isBulletColPresent)
 conditionally add a Go To row More...
 
virtual void Append (const ITooltipFormatter &tooltip)
 appends another formatter to this one 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 ITooltipFormatter
virtual string CreateGenomicLink (const string &sText, const string &sUrl) const
 
virtual void SetTrustedData (bool trusted_data)
 indicates whether the data is coming from a trusted source More...
 
virtual bool IsTrustedData ()
 indicates whether the data is coming from a trusted source More...
 
virtual ~ITooltipFormatter ()
 

Static Public Member Functions

static CIRef< ITooltipFormatterCreateTooltipFormatter ()
 
- 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 Member Functions inherited from ITooltipFormatter
static CIRef< ITooltipFormatterCreateTooltipFormatter (ETooltipFormatters)
 factory for requested tooltip formatter creation More...
 

Private Member Functions

 CCSSTableTooltipFormatter ()
 
 CCSSTableTooltipFormatter (const CCSSTableTooltipFormatter &)
 
CCSSTableTooltipFormatteroperator= (const CCSSTableTooltipFormatter &)
 

Private Attributes

string m_sTooltipText
 
string m_sLinksText
 

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...
 
- Public Types inherited from ITooltipFormatter
enum  ETooltipFormatters { eTooltipFormatter_CSSTable , eTooltipFormatter_Html , eTooltipFormatter_Text }
 supported types of formatters 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...
 
- Protected Attributes inherited from ITooltipFormatter
bool m_TrustedData = true
 

Detailed Description

tooltips using html tables with css classes from projects/sviewer/css/style.css and generated NCBI URLs are paths (recommended for SViewer)

Definition at line 240 of file tooltip.hpp.


The documentation for this class was generated from the following files:
Modified on Mon Jun 17 05:11:03 2024 by modify_doxy.py rev. 669887