\brief The HbParameterLengthLimiter class provides support for localizing text strings, and for limiting the length of runtime values inserted into the strings.

    The HbParameterLengthLimiter class provides the same support for string 

    localization based on unique text IDs as the global hbTrId() function, and 

    the same support for inserting values based on the given arguments as 

    QString::arg(). In addition, %HbParameterLengthLimiter supports limiting the 

    length of values that are inserted into the translations using arguments. 

    You can use up to nine arguments to insert values, as supported by QString.

    In most cases, it is simpler to use hbTrId() for localization (see hbTrId() 

    documentation and examples). However, the number of characters in a text 

    string can vary widely from language to language. Sometimes when space is 

    limited, you may want to limit the number of characters that are inserted. 

    In this case, use the HbParameterLengthLimiter class instead of %hbTrId().

    Even if the inserted value does not require limiting at the time of coding, 

    there is one advantage in using HbParameterLengthLimiter right away: if you 

    later need to limit the value length for some languages, no code changes are 

    required. You only need to modify the <tt>.ts</tt> translation files for 

    those languages. However, if you already know that all translations will fit 

    without any limitations (for example, if you are using scrolling text with 

    HbMarqueeItem), use hbTrId().

    The text strings in .ts localization files can have placeholders, where you 

    insert values at runtime. HbParameterLengthLimiter supports the same 

    placeholder formats as hbTrId() (\c \%x, \c \%Lx and \c \%Ln), and the 

    following additional placeholder:

    <ul>

    <li><tt>%[y]x</tt> for inserting strings, where \c x is a number (1-9) that 

    indicates the order of placeholders in the source text string. This 

    corresponds to your argument inserting order when you use 

    HbParameterLengthLimiter. The order of placeholders may vary in different 

    translations, and the numbering ensures that values are inserted into the 

    correct placeholders. <tt>[y]</tt> is a number that indicates the maximum 

    length (in characters) for the inserted value.</li>

    </ul>

    For example, the text string \c "Downloading file %[10]1 from URL %2" has 

    two placeholders to insert two strings, a file name and a URL. The [] 

    notation in the first placeholder \c %[10]1 limits the length of the file 

    name to 10 characters.

    HbParameterLengthLimiter provides all the same %arg() variants as QString, 

    which means you can use it in place of QString::arg() when needed. The 

    following examples describe the most common use cases that you would use 

    %HbParameterLengthLimiter for. The other functions available can be used for 

    more complex cases, such as processing the localized text strings.

    \section _usecases_hbparameterlengthlimiter Using the HbParameterLengthLimiter class

    \subsection _uc_001_hbparameterlengthlimiter Limiting the length of values inserted using an argument

      This example shows how you get the translation based on a given text ID, 

      replace the two placeholders with values using runtime arguments, and 

      limit the length of both of the inserted values.

      \code

      // "Download file %1 from URL %2?"

      // fileName = "test_application_data_file.txt"

      // urlName = "www.something.org"

      HbParameterLengthLimiter myTranslation("txt_browser_download_data");

      label->setPlainText(myTranslation.arg(fileName, urlName));

      \endcode

      The translation is defined in the <tt>.ts</tt> file in the following 

      format:

      \code

      <message id="txt_browser_download_data">

        <source>"Download file %1 from URL %2?</source>

        <translation variants="no">Download file %[10]1 from URL %[12]2?</translation>

      </message>

      \endcode

      This limits the length of the inserted values to 10 and 12 characters, 

      producing a text string such as \c "Download file test_appli... from URL 

      www.somethin...?".

      \subsection _uc_002_hbparameterlengthlimiter Inserting values using runtime arguments

      This example shows how you simply get a translation and replace the 

      placeholder with a runtime value. You can achieve the same result by using 

      hbTrId().

      \code

      // "Enter %L1-digit passcode"

      // int number = 4

      label->setPlainText(HbParameterLengthLimiter("txt_give_numeric_passcode").arg(number));

      \endcode

      This example also uses the 'L' notation in the placeholder in the text 

      string, which formats the number in the active locale's display format.

      \sa hbTrId(), QString::arg(), HbDirectoryNameLocalizer, HbTranslator

    Copy constructor.

    \param a The HbParameterLengthLimiter object to copy.

    Constructor for processing a string that has already been localized.

    \param a A localized string containing the placeholders for inserting values.

    Constructs an HbParameterLengthLimiter using a text ID. The functionality is 

    similar to what hbTrId() provides, except for the additional support for 

    limiting the length of the inserted values.

    \param a The text ID that identifies the localized string in the 

    <tt>.ts</tt> file.

    Constructs an HbParameterLengthLimiter using a text ID, and a numeric 

    parameter for handling singular and plural forms correctly. The 

    functionality is the same as provided by the hbTrId() function, except for 

    the additional support for limiting the length of the inserted values.

    \param a The text ID that identifies the localized string in the 

    <tt>.ts</tt> file.    

    \param n A numeric parameter that indicates quantity, used to determine 

    which singular or plural translation to use from the <tt>.ts</tt> file.

    Constructs an HbParameterLengthLimiter with a blank string.

    Destructor.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(qlonglong, int, int, const QChar &) const.

    \param a The number that is to be inserted to the output string.

    \param fieldwidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param base The number base.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(qulonglong, int, int, const QChar &) const.

    \param a The number that is to be inserted to the output string.    

    \param fieldwidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param base The number base.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(long, int, int, const QChar &) const.

    \param a The number that is to be inserted to the output string.    

    \param fieldwidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param base The number base.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(ulong, int, int, const QChar &) const.

    \param a The number that is to be inserted to the output string.    

    \param fieldwidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param base The number base.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(int, int, int, const QChar &) const.

    \param a The number that is to be inserted to the output string.    

    \param fieldWidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param base The number base.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(uint, int, int, const QChar &) const.

    \param a The number that is to be inserted to the output string.    

    \param fieldWidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param base The number base.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(short, int, int, const QChar &) const.

    \param a The number that is to be inserted to the output string.    

    \param fieldWidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param base The number base.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(ushort, int, int, const QChar &) const.

    \param a The number that is to be inserted to the output string.    

    \param fieldWidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param base The number base.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(double, int, char, int, const QChar &) const.

    \param a Value formatted according to the specified format and precision.    

    \param fieldWidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param fmt The format to be used.

    \param prec The precision to be used.

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(char, int, const QChar &) const.

    \param a The character that is to be inserted to the output string.    

    \param fieldWidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments.

    This function corresponds to QString::arg(QChar, int, const QChar &) const.

    \param a The character that is to be inserted to the output string.    

    \param fieldWidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param fillChar The fill character.

    Replaces the placeholders in the translation with runtime values using the 

    given parameters and arguments. Limits the length of the inserted value, if 

    this is specified in the placeholder using the [] notation.

    This function corresponds to QString::arg(const QString &, int, const QChar &) const.

    \param a The string that is to be inserted to the output string.    

    \param fieldWidth The minimum amount of space that \a a is padded to and 

    filled with the character \a fillChar.    

    \param fillChar The fill character.