inc/FText.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file                FText.h
  19  * @brief               This is the header file for the %Text namespace.
  20  *
  21  * This header file contains the declarations of the %Text namespace.
  22  */
  23
  24 #ifndef _FTEXT_H_
  25 #define _FTEXT_H_
  26
  27 #include <FTextEncoding.h>
  28 #include <FTextUtf8Encoding.h>
  29 #include <FTextAsciiEncoding.h>
  30 #include <FTextLatin1Encoding.h>
  31 #include <FTextGsmEncoding.h>
  32 #include <FTextUcs2Encoding.h>
  33 #include <FTextEncoder.h>
  34 #include <FTextDecoder.h>
  35 #include <FTextUtf8Encoder.h>
  36 #include <FTextUtf8Decoder.h>
  37
  38
  39 /**
  40  * @namespace   Tizen::Text
  41  * @brief               This namespace contains classes that encode and decode characters.
  42  *
  43  * @since                       2.0
  44  *
  45  * @remarks             @b Header @b %file: @b \#include @b <FText.h> @n
  46  *                              @b Library: @b osp-appfw
  47  *
  48  *
  49  * The %Text namespace contains the Encoding class, which is the base class for encoding and decoding different character encodings, such as UTF-8, UCS-2, Latin-1, GSM, and ASCII.
  50  * It also contains the Decoder and Encoder classes for converting text blocks. The main purpose of this namespace is to support inter-
  51  * operability between the various existing languages and scripts.
  52  * %Text is a data consisting of a sequence of characters.
  53  * It is also defined as a series of characters that can be displayed on a display terminal or printed on a paper for human reading.
  54  *
  55  * For more information on the %Text namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/text/text.htm">Text Guide</a>.
  56  *
  57  * The following diagram illustrates the relationships between the classes belonging to the %Text namespace.
  58  * @image html text_using_the_apis_classdiagram.png
  59  *
  60  *
  61  *
  62  */
  63
  64 namespace Tizen { namespace Text
  65 {
  66
  67 }} // Tizen::Text
  68
  69 #endif //_FTEXT_H_