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

Search Toolkit Book for CHTMLPlainText

#include <html/html.hpp>

+ Inheritance diagram for CHTMLPlainText:
+ Collaboration diagram for CHTMLPlainText:

Public Types

enum  EEncodeMode { eNoEncode = 0, eHTMLEncode = 1 << 0, eJSONEncode = 1 << 1 }
 
- Public Types inherited from CNCBINode
enum  EMode { eHTML = 0, ePlainText = 1, eXHTML = 2 }
 
enum  EExceptionFlags { fAddTrace = 0x1, fCatchAll = 0x2, fDisableCheckRecursion = 0x4 }
 Flags defining how to catch and process exceptions. More...
 
typedef list< CNodeRefTChildren
 
typedef auto_ptr< TChildrenTChildrenMember
 
typedef map< string, SAttributeValue, PNocaseTAttributes
 
typedef int TExceptionFlags
 Binary OR of "EExceptionFlags". More...
 
- 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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CHTMLPlainText (EEncodeMode encode_mode, const string &text)
 
 CHTMLPlainText (const char *text, bool noEncode=false)
 
 CHTMLPlainText (const string &text, bool noEncode=false)
 
 ~CHTMLPlainText (void)
 
const stringGetText (void) const
 
void SetText (const string &text)
 
bool NoEncode (void) const
 
void SetNoEncode (bool noEncode=true)
 
void SetEncodeMode (EEncodeMode encode_mode)
 
EEncodeMode GetEncodeMode () const
 
virtual CNcbiOstreamPrintBegin (CNcbiOstream &out, TMode mode)
 
- Public Member Functions inherited from CNCBINode
 CNCBINode (void)
 
 CNCBINode (const string &name)
 
 CNCBINode (const char *name)
 
virtual ~CNCBINode ()
 
CNCBINodeAppendChild (CNCBINode *child)
 
CNCBINodeAppendChild (CNodeRef &ref)
 
CNodeRef RemoveChild (CNCBINode *child)
 
CNodeRef RemoveChild (CNodeRef &child)
 
void RemoveAllChildren (void)
 
bool HaveChildren (void) const
 
TChildrenChildren (void)
 
const TChildrenChildren (void) const
 
TChildren::iterator ChildBegin (void)
 
TChildren::iterator ChildEnd (void)
 
TChildren::const_iterator ChildBegin (void) const
 
TChildren::const_iterator ChildEnd (void) const
 
virtual CNcbiOstreamPrint (CNcbiOstream &out, TMode mode=eHTML)
 
virtual CNcbiOstreamPrintChildren (CNcbiOstream &out, TMode mode)
 
virtual CNcbiOstreamPrintEnd (CNcbiOstream &out, TMode mode)
 
void SetRepeatCount (size_t count=0)
 
size_t GetRepeatCount (void)
 
virtual void CreateSubNodes (void)
 
void Initialize (void)
 
void ReInitialize (void)
 
virtual CNCBINodeMapTag (const string &tagname)
 
CNodeRef MapTagAll (const string &tagname, const TMode &mode)
 
void RepeatTag (bool enable=true)
 
bool NeedRepeatTag (void)
 
const stringGetName (void) const
 
bool HaveAttributes (void) const
 
TAttributesAttributes (void)
 
const TAttributesAttributes (void) const
 
bool HaveAttribute (const string &name) const
 
const stringGetAttribute (const string &name) const
 
bool AttributeIsOptional (const string &name) const
 
bool AttributeIsOptional (const char *name) const
 
void SetAttributeOptional (const string &name, bool optional=true)
 
void SetAttributeOptional (const char *name, bool optional=true)
 
const stringGetAttributeValue (const string &name) const
 
void SetAttribute (const string &name, const string &value)
 
void SetAttribute (const string &name)
 
void SetAttribute (const string &name, int value)
 
void SetOptionalAttribute (const string &name, const string &value)
 
void SetOptionalAttribute (const string &name, bool set)
 
void SetAttribute (const char *name, const string &value)
 
void SetAttribute (const char *name)
 
void SetAttribute (const char *name, int value)
 
void SetOptionalAttribute (const char *name, const string &value)
 
void SetOptionalAttribute (const char *name, bool set)
 
- 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
 

Private Types

typedef CNCBINode CParent
 

Private Attributes

string m_Text
 
EEncodeMode m_EncodeMode
 

Additional Inherited Members

- Static Public Member Functions inherited from CNCBINode
static CNCBINodeNode (TChildren::iterator i)
 
static const CNCBINodeNode (TChildren::const_iterator i)
 
static void SetExceptionFlags (TExceptionFlags flags)
 
static TExceptionFlags GetExceptionFlags (void)
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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 CNCBINode
virtual void DoAppendChild (CNCBINode *child)
 
virtual void DoSetAttribute (const string &name, const string &value, bool optional)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Attributes inherited from CNCBINode
bool m_CreateSubNodesCalled
 
TChildrenMember m_Children
 Child nodes. More...
 
string m_Name
 Node name. More...
 
size_t m_RepeatCount
 How many times repeat node. More...
 
bool m_RepeatTag
 
auto_ptr< TAttributesm_Attributes
 

Detailed Description

Definition at line 261 of file html.hpp.

Member Typedef Documentation

Definition at line 263 of file html.hpp.

Constructor & Destructor Documentation

CHTMLPlainText::CHTMLPlainText ( EEncodeMode  encode_mode,
const string text 
)

Definition at line 231 of file html.cpp.

CHTMLPlainText::CHTMLPlainText ( const char *  text,
bool  noEncode = false 
)

Definition at line 237 of file html.cpp.

References SetNoEncode().

CHTMLPlainText::CHTMLPlainText ( const string text,
bool  noEncode = false 
)

Definition at line 244 of file html.cpp.

References SetNoEncode().

CHTMLPlainText::~CHTMLPlainText ( void  )

Definition at line 251 of file html.cpp.

Member Function Documentation

EEncodeMode CHTMLPlainText::GetEncodeMode ( ) const
inline

Definition at line 291 of file html.hpp.

References m_EncodeMode.

const string& CHTMLPlainText::GetText ( void  ) const

Referenced by PrintBegin().

bool CHTMLPlainText::NoEncode ( void  ) const
inline

Definition at line 279 of file html.hpp.

References eHTMLEncode, and m_EncodeMode.

CNcbiOstream & CHTMLPlainText::PrintBegin ( CNcbiOstream out,
TMode  mode 
)
virtual
void CHTMLPlainText::SetEncodeMode ( EEncodeMode  encode_mode)
inline

Definition at line 287 of file html.hpp.

References m_EncodeMode.

void CHTMLPlainText::SetNoEncode ( bool  noEncode = true)
inline

Definition at line 283 of file html.hpp.

References eHTMLEncode, eNoEncode, and m_EncodeMode.

Referenced by CHTMLPlainText().

void CHTMLPlainText::SetText ( const string text)

Member Data Documentation

EEncodeMode CHTMLPlainText::m_EncodeMode
private

Definition at line 300 of file html.hpp.

Referenced by GetEncodeMode(), NoEncode(), PrintBegin(), SetEncodeMode(), and SetNoEncode().

string CHTMLPlainText::m_Text
private

Definition at line 299 of file html.hpp.


The documentation for this class was generated from the following files:
Modified on Thu Apr 28 18:13:23 2016 by modify_doxy.py rev. 426318