X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFTextUcs2Encoding.h;h=ed744bbe8fc9b7ac13bd1b3394a75f23f21114c6;hb=9b44315473e675bcd332e2f56fac1ce00f87a8a6;hp=535e13164c867147af66b1f958667f3d3db64f47;hpb=08cd4b841ccdef1cfc0ea1de06a2787cdcfa199f;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FTextUcs2Encoding.h b/inc/FTextUcs2Encoding.h index 535e131..ed744bb 100644 --- a/inc/FTextUcs2Encoding.h +++ b/inc/FTextUcs2Encoding.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2012 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -111,11 +110,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode + * @param[in] str The string to encode * @param[out] byteCount The total number of bytes required to encode the string * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str is an empty string. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str is an empty string. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of bytes * that are produced if the given string is encoded. @@ -132,8 +132,9 @@ public: * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @param[out] byteCount The total number of bytes required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of bytes * that are produced if the given array of characters is encoded. @@ -147,17 +148,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[out] byteCount The total number of bytes required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified inout parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of bytes * that are produced if the given array of characters is encoded. @@ -171,9 +175,9 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -189,11 +193,11 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] str A string to encode - * @exception E_SUCCESS The method is successful. + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] str The string to encode + * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c str is empty or invalid. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. @@ -211,19 +215,23 @@ public: * @return An error code * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method encodes a range of characters in a Tizen::Base::WcharBuffer into a range of bytes in a Tizen::Base::ByteBuffer. * @see GetChars() @@ -238,21 +246,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] str The string to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetString() */ @@ -266,10 +278,11 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance + * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of characters * that are produced if the given range of bytes is converted. @@ -284,16 +297,19 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of characters * that are produced if the given range of bytes is converted. @@ -302,14 +318,14 @@ public: virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, int& charCount) const; /** - *Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer. + * Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer. * * @since 2.0 * - * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c bytes is empty or invalid. @@ -327,20 +343,24 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes or @ chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c chars does not contain sufficient space to store the decoded bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes or @ chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c chars does not contain sufficient space to store the decoded bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -348,42 +368,46 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytesN() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] index The index from where decoding begins + * @param[in] index The index from where the decoding begins * @param[in] count The total number of bytes to decode * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytesN() */ @@ -391,15 +415,14 @@ public: /** - * Gets the maximum number of bytes required for encoding a given number of characters. + * Gets the maximum number of bytes required for encoding the given number of characters. * * @since 2.0 * * @return The maximum number of bytes required for encoding the given number of characters * @param[in] charCount The total number of characters to encode - * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. + * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. * @see GetByteCount() - * @see GetBytes() */ virtual int GetMaxByteCount(int charCount) const; @@ -411,10 +434,9 @@ public: * * @return The maximum number of characters generated by decoding the specified number of bytes * @param[in] byteCount The total number of bytes to encode - * @remarks This method determines an appropriate buffer size for the character arrays passed to - * GetChars() or a decoder for encoding. + * @remarks This method determines an appropriate buffer size for the character arrays passed to + * GetChars() or a decoder for encoding. * @see GetByteCount() - * @see GetChars() */ virtual int GetMaxCharCount(int byteCount) const; @@ -424,11 +446,11 @@ public: * * @since 2.0 * - * @return A pointer to the Encoder instance for the current encoding - * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into - * partial sequences of bytes by maintaining the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * @see GetBytes() + * @return A pointer to the Encoder instance for the current encoding + * @remarks + * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into + * partial sequences of bytes by maintaining the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Encoder* GetEncoderN(void) const; @@ -438,12 +460,11 @@ public: * * @since 2.0 * - * @return A pointer to the Decoder instance for the current encoding - * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes - * into partial sequences of characters by maintaining the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * - * @see GetChars() + * @return A pointer to the Decoder instance for the current encoding + * @remarks + * - Contrary to GetChars(), a decoder can convert partial sequences of bytes + * into partial sequences of characters by maintaining the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Decoder* GetDecoderN(void) const; @@ -452,7 +473,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const;