OpenSceneGraph/doc/doc++/osgText/EncodedText.html
2003-01-24 23:36:35 +00:00

189 lines
7.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class OSGTEXT_EXPORT osgText::EncodedText</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class OSGTEXT_EXPORT <A HREF="#DOC.DOCU">osgText::EncodedText</A></H2></H2><HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>
<param name=classes value="Mosg::Referenced,M,CEncodedText,MEncodedText.html">
<param name=before value="M,M">
<param name=after value="Md_,M">
<param name=indent value="0,1">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.1.2">EncodedText</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.3">setOverrideEncoding</A></B>(<!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> encoding)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> <B><A HREF="#DOC.2.1.4">getOverrideEncoding</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> <B><A HREF="#DOC.2.1.5">getEncoding</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.1.6">setText</A></B>(const unsigned char* text, int length = -1)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>std::vector&lt;int&gt; ::const_iterator <B><A HREF="#DOC.2.1.7">begin</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>std::vector&lt;int&gt; ::const_iterator <B><A HREF="#DOC.2.1.8">end</A></B>() const
</DL></P>
<P><DL>
<DT><H3>Public Members</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.2.1.1">Encoding</A></B>
<DD><I> Types of string encodings supported</I>
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> <B><A HREF="#DOC.2.1.11">_encoding</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> <B><A HREF="#DOC.2.1.12">_overrideEncoding</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>std::vector&lt;int&gt; <B><A HREF="#DOC.2.1.13">_unicodeText</A></B>
</DL></P>
<P><DL>
<DT><H3>Protected Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>int <B><A HREF="#DOC.2.1.9">getNextCharacter</A></B>(const unsigned char*&amp; charString) const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> <B><A HREF="#DOC.2.1.10">findEncoding</A></B>(const unsigned char*&amp; charString) const
<DD><I>This method will extract any ZWNBSP signature at the start of the string</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<DL>
<A NAME="Encoding"></A>
<A NAME="DOC.2.1.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>enum Encoding</B></TT>
<DD>
Types of string encodings supported
<DL><DT><DD></DL><P><DL>
<A NAME="ENCODING_UNDEFINED"></A>
<A NAME="DOC.2.1.1.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_UNDEFINED</B></TT>
<DL><DT><DD></DL><P>
<A NAME="ENCODING_ASCII"></A>
<A NAME="DOC.2.1.1.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_ASCII</B></TT>
<DD>not using Unicode
<DL><DT><DD></DL><P>
<A NAME="ENCODING_UTF8"></A>
<A NAME="DOC.2.1.1.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_UTF8</B></TT>
<DD>unsigned char ASCII
<DL><DT><DD></DL><P>
<A NAME="ENCODING_UTF16"></A>
<A NAME="DOC.2.1.1.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_UTF16</B></TT>
<DD>8-bit unicode transformation format
<DL><DT><DD></DL><P>
<A NAME="ENCODING_UTF16_BE"></A>
<A NAME="DOC.2.1.1.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_UTF16_BE</B></TT>
<DD>16-bit signature
<DL><DT><DD></DL><P>
<A NAME="ENCODING_UTF16_LE"></A>
<A NAME="DOC.2.1.1.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_UTF16_LE</B></TT>
<DD>16-bit big-endian
<DL><DT><DD></DL><P>
<A NAME="ENCODING_UTF32"></A>
<A NAME="DOC.2.1.1.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_UTF32</B></TT>
<DD>16-bit little-endian
<DL><DT><DD></DL><P>
<A NAME="ENCODING_UTF32_BE"></A>
<A NAME="DOC.2.1.1.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_UTF32_BE</B></TT>
<DD>32-bit signature
<DL><DT><DD></DL><P>
<A NAME="ENCODING_UTF32_LE"></A>
<A NAME="DOC.2.1.1.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_UTF32_LE</B></TT>
<DD>32-bit big-endian
<DL><DT><DD></DL><P>
<A NAME="ENCODING_SIGNATURE"></A>
<A NAME="DOC.2.1.1.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ENCODING_SIGNATURE</B></TT>
<DD>32-bit little-endian
<DL><DT><DD></DL><P>
<A NAME="detect encoding from signature"></A>
<A NAME="DOC.2.1.1.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> detect encoding from signature</B></TT>
<DD>detect encoding from signature
<DL><DT><DD></DL><P></DL>
<A NAME="EncodedText"></A>
<A NAME="DOC.2.1.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> EncodedText()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setOverrideEncoding"></A>
<A NAME="DOC.2.1.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setOverrideEncoding(<!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> encoding)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getOverrideEncoding"></A>
<A NAME="DOC.2.1.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> getOverrideEncoding() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="getEncoding"></A>
<A NAME="DOC.2.1.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> getEncoding() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="setText"></A>
<A NAME="DOC.2.1.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setText(const unsigned char* text, int length = -1)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="begin"></A>
<A NAME="DOC.2.1.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>std::vector&lt;int&gt; ::const_iterator begin() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="end"></A>
<A NAME="DOC.2.1.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>std::vector&lt;int&gt; ::const_iterator end() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="getNextCharacter"></A>
<A NAME="DOC.2.1.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>int getNextCharacter(const unsigned char*&amp; charString) const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="findEncoding"></A>
<A NAME="DOC.2.1.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> findEncoding(const unsigned char*&amp; charString) const </B></TT>
<DD>This method will extract any ZWNBSP signature at the start of the string
<DL><DT><DD></DL><P>
<A NAME="_encoding"></A>
<A NAME="DOC.2.1.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> _encoding</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_overrideEncoding"></A>
<A NAME="DOC.2.1.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="EncodedText.html#DOC.2.1.1">Encoding</A> _overrideEncoding</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_unicodeText"></A>
<A NAME="DOC.2.1.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>std::vector&lt;int&gt; _unicodeText</B></TT>
<DL><DT><DD></DL><P></DL>
<HR><DL><DT><B>This class has no child classes.</B></DL>
<DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>