OpenSceneGraph/doc/doc++/osgText/String.html
Robert Osfield ed10594139 Updated docs
2004-08-06 06:53:36 +00:00

178 lines
7.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class OSGTEXT_EXPORT osgText::String</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.6">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class OSGTEXT_EXPORT <A HREF="#DOC.DOCU">osgText::String</A></H2></H2><HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=95>
<param name=classes value="MVectorUInt,M,Mosg::Referenced,M,CString,MString.html">
<param name=before value="M,M,M">
<param name=after value="Ml_,MD_,M">
<param name=indent value="0,0,1">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Classes</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.6.6.1">Encoding</A></B>
<DD><I> Types of string encodings supported</I>
</DL></P>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.6.6.2">String</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.6.6.3">String</A></B>(const <!1><A HREF="String.html#DOC.6.6.3">String</A>&amp; str)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.6.6.4">String</A></B>(const std::string&amp; str)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.6.6.5">String</A></B>(const wchar_t* text)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.6.6.6">String</A></B>(const std::string&amp; text, <!1><A HREF="String.html#DOC.6.6.1">Encoding</A> encoding)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.6.6.7">~String</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="String.html">String</A>&amp; <B><A HREF="#DOC.6.6.8">operator = </A></B>(const <!1><A HREF="String.html">String</A>&amp; str)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.6.6.9">set</A></B>(const std::string&amp; str)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.6.6.10">set</A></B>(const wchar_t* text)
<DD><I>Set the text using a wchar_t string, which is converted to an internal TextString</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.6.6.11">set</A></B>(const std::string&amp; text, <!1><A HREF="String.html#DOC.6.6.1">Encoding</A> encoding)
<DD><I>Set the text using a Unicode encoded std::string, which is converted to an internal TextString.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>std::string <B><A HREF="#DOC.6.6.12">createUTF8EncodedString</A></B>() const
<DD><I>returns a UTF8 encoded version of this osgText::String</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<DL>
<A NAME="Encoding"></A>
<A NAME="DOC.6.6.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.6.6.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.6.6.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.6.6.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.6.6.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.6.6.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.6.6.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.6.6.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.6.6.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.6.6.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.6.6.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></DL>
<A NAME="String"></A>
<A NAME="DOC.6.6.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> String()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="String"></A>
<A NAME="DOC.6.6.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> String(const <!1><A HREF="String.html#DOC.6.6.3">String</A>&amp; str)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="String"></A>
<A NAME="DOC.6.6.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> String(const std::string&amp; str)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="String"></A>
<A NAME="DOC.6.6.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> String(const wchar_t* text)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="String"></A>
<A NAME="DOC.6.6.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> String(const std::string&amp; text, <!1><A HREF="String.html#DOC.6.6.1">Encoding</A> encoding)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="~String"></A>
<A NAME="DOC.6.6.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~String()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator = "></A>
<A NAME="DOC.6.6.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="String.html">String</A>&amp; operator = (const <!1><A HREF="String.html">String</A>&amp; str)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="set"></A>
<A NAME="DOC.6.6.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void set(const std::string&amp; str)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="set"></A>
<A NAME="DOC.6.6.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void set(const wchar_t* text)</B></TT>
<DD>Set the text using a wchar_t string,
which is converted to an internal TextString
<DL><DT><DD></DL><P>
<A NAME="set"></A>
<A NAME="DOC.6.6.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void set(const std::string&amp; text, <!1><A HREF="String.html#DOC.6.6.1">Encoding</A> encoding)</B></TT>
<DD>Set the text using a Unicode encoded std::string, which is converted to an internal TextString.
The encoding parameter specificies which Unicode encodeding is used in the std::string.
<DL><DT><DD></DL><P>
<A NAME="createUTF8EncodedString"></A>
<A NAME="DOC.6.6.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>std::string createUTF8EncodedString() const </B></TT>
<DD>returns a UTF8 encoded version of this osgText::String
<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://www.linuxsupportline.com/~doc++">DOC++</A>.
</BODY>
</HTML>