ISLEman
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
DocSymbol Class Reference

Node representing a special symbol. More...

#include <docparser.h>

Inheritance diagram for DocSymbol:
DocNode

Classes

struct  PerlSymb
 

Public Types

enum  SymType {
  Sym_Unknown = -1, Sym_nbsp, Sym_iexcl, Sym_cent,
  Sym_pound, Sym_curren, Sym_yen, Sym_brvbar,
  Sym_sect, Sym_uml, Sym_copy, Sym_ordf,
  Sym_laquo, Sym_not, Sym_shy, Sym_reg,
  Sym_macr, Sym_deg, Sym_plusmn, Sym_sup2,
  Sym_sup3, Sym_acute, Sym_micro, Sym_para,
  Sym_middot, Sym_cedil, Sym_sup1, Sym_ordm,
  Sym_raquo, Sym_frac14, Sym_frac12, Sym_frac34,
  Sym_iquest, Sym_Agrave, Sym_Aacute, Sym_Acirc,
  Sym_Atilde, Sym_Auml, Sym_Aring, Sym_AElig,
  Sym_Ccedil, Sym_Egrave, Sym_Eacute, Sym_Ecirc,
  Sym_Euml, Sym_Igrave, Sym_Iacute, Sym_Icirc,
  Sym_Iuml, Sym_ETH, Sym_Ntilde, Sym_Ograve,
  Sym_Oacute, Sym_Ocirc, Sym_Otilde, Sym_Ouml,
  Sym_times, Sym_Oslash, Sym_Ugrave, Sym_Uacute,
  Sym_Ucirc, Sym_Uuml, Sym_Yacute, Sym_THORN,
  Sym_szlig, Sym_agrave, Sym_aacute, Sym_acirc,
  Sym_atilde, Sym_auml, Sym_aring, Sym_aelig,
  Sym_ccedil, Sym_egrave, Sym_eacute, Sym_ecirc,
  Sym_euml, Sym_igrave, Sym_iacute, Sym_icirc,
  Sym_iuml, Sym_eth, Sym_ntilde, Sym_ograve,
  Sym_oacute, Sym_ocirc, Sym_otilde, Sym_ouml,
  Sym_divide, Sym_oslash, Sym_ugrave, Sym_uacute,
  Sym_ucirc, Sym_uuml, Sym_yacute, Sym_thorn,
  Sym_yuml, Sym_fnof, Sym_Alpha, Sym_Beta,
  Sym_Gamma, Sym_Delta, Sym_Epsilon, Sym_Zeta,
  Sym_Eta, Sym_Theta, Sym_Iota, Sym_Kappa,
  Sym_Lambda, Sym_Mu, Sym_Nu, Sym_Xi,
  Sym_Omicron, Sym_Pi, Sym_Rho, Sym_Sigma,
  Sym_Tau, Sym_Upsilon, Sym_Phi, Sym_Chi,
  Sym_Psi, Sym_Omega, Sym_alpha, Sym_beta,
  Sym_gamma, Sym_delta, Sym_epsilon, Sym_zeta,
  Sym_eta, Sym_theta, Sym_iota, Sym_kappa,
  Sym_lambda, Sym_mu, Sym_nu, Sym_xi,
  Sym_omicron, Sym_pi, Sym_rho, Sym_sigmaf,
  Sym_sigma, Sym_tau, Sym_upsilon, Sym_phi,
  Sym_chi, Sym_psi, Sym_omega, Sym_thetasym,
  Sym_upsih, Sym_piv, Sym_bull, Sym_hellip,
  Sym_prime, Sym_Prime, Sym_oline, Sym_frasl,
  Sym_weierp, Sym_image, Sym_real, Sym_trade,
  Sym_alefsym, Sym_larr, Sym_uarr, Sym_rarr,
  Sym_darr, Sym_harr, Sym_crarr, Sym_lArr,
  Sym_uArr, Sym_rArr, Sym_dArr, Sym_hArr,
  Sym_forall, Sym_part, Sym_exist, Sym_empty,
  Sym_nabla, Sym_isin, Sym_notin, Sym_ni,
  Sym_prod, Sym_sum, Sym_minus, Sym_lowast,
  Sym_radic, Sym_prop, Sym_infin, Sym_ang,
  Sym_and, Sym_or, Sym_cap, Sym_cup,
  Sym_int, Sym_there4, Sym_sim, Sym_cong,
  Sym_asymp, Sym_ne, Sym_equiv, Sym_le,
  Sym_ge, Sym_sub, Sym_sup, Sym_nsub,
  Sym_sube, Sym_supe, Sym_oplus, Sym_otimes,
  Sym_perp, Sym_sdot, Sym_lceil, Sym_rceil,
  Sym_lfloor, Sym_rfloor, Sym_lang, Sym_rang,
  Sym_loz, Sym_spades, Sym_clubs, Sym_hearts,
  Sym_diams, Sym_quot, Sym_amp, Sym_lt,
  Sym_gt, Sym_OElig, Sym_oelig, Sym_Scaron,
  Sym_scaron, Sym_Yuml, Sym_circ, Sym_tilde,
  Sym_ensp, Sym_emsp, Sym_thinsp, Sym_zwnj,
  Sym_zwj, Sym_lrm, Sym_rlm, Sym_ndash,
  Sym_mdash, Sym_lsquo, Sym_rsquo, Sym_sbquo,
  Sym_ldquo, Sym_rdquo, Sym_bdquo, Sym_dagger,
  Sym_Dagger, Sym_permil, Sym_lsaquo, Sym_rsaquo,
  Sym_euro, Sym_tm, Sym_apos, Sym_BSlash,
  Sym_At, Sym_Less, Sym_Greater, Sym_Amp,
  Sym_Dollar, Sym_Hash, Sym_DoubleColon, Sym_Percent,
  Sym_Pipe, Sym_Quot, Sym_Minus, Sym_Plus,
  Sym_Dot
}
 
enum  PerlType {
  Perl_unknown = 0, Perl_string, Perl_char, Perl_symbol,
  Perl_umlaut, Perl_acute, Perl_grave, Perl_circ,
  Perl_slash, Perl_tilde, Perl_cedilla, Perl_ring
}
 
typedef struct DocSymbol::PerlSymb PerlSymb
 
- Public Types inherited from DocNode
enum  Kind {
  Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,
  Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,
  Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,
  Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,
  Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,
  Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,
  Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,
  Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,
  Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,
  Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,
  Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,
  Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,
  Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,
  Kind_DiaFile = 52
}
 

Public Member Functions

 DocSymbol (DocNode *parent, SymType s)
 
SymType symbol () const
 
Kind kind () const
 
void accept (DocVisitor *v)
 
- Public Member Functions inherited from DocNode
 DocNode ()
 
virtual ~DocNode ()
 
DocNode * parent () const
 
void setParent (DocNode *parent)
 
bool isPreformatted () const
 

Static Public Member Functions

static SymType decodeSymbol (const QCString &symName)
 

Additional Inherited Members

- Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)
 
- Protected Attributes inherited from DocNode
DocNode * m_parent
 

Detailed Description

Node representing a special symbol.

Member Function Documentation

§ accept()

void DocSymbol::accept ( DocVisitor *  v)
inlinevirtual

Acceptor function for node visitors. Part of the visitor pattern.

Parameters
vAbstract visitor.

Implements DocNode.

§ kind()

Kind DocSymbol::kind ( ) const
inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.12