company logo

String :: alignText - Aling text in block format

The function allows aligning text in a block with a given line width and a defined alignment type.
Return value:   - internal feature (   )

Implementation overview

Implementation details

  1. Align text without indenting
    odaba::String String  :: alignText ( int32 iSize, odaba::AlignTypes eAlignType )

    The text in the string will be aligned using the complete size passed in iSize for the string. The way of alignment depends on the alignment type passed in eAlignType.
    • iSize - Size

      Size of the instance or property area. For string objects, the size is usually measured in units.
    • eAlignType - Alignment type
    2. to list
  2. Align text with indenting
    odaba::String String  :: alignText ( int32 iSize, int32 iIndent, odaba::AlignTypes eAlignType )

    Each line starts with a number of spaces as passed in iIndent. The line size passed in iSize includes this value. The way of alignment depends on the alignment type passed in eAlignType.
    • iSize - Size

      Size of the instance or property area. For string objects, the size is usually measured in units.
    • iIndent - Indent count

      The indent count defines a number of characters for text indent.
    • eAlignType - Alignment type
    3. to list
  3. Align text with preceeding text intent
    odaba::String String  :: alignText ( int32 iSize, odaba::String &sIndent, odaba::AlignTypes eAlignType )

    Each line starts with the string passed in sIndent. The line size passed in iSize includes this value. The way of alignment depends on the alignment type passed in eAlignType.
    • iSize - Size

      Size of the instance or property area. For string objects, the size is usually measured in units.
    • sIndent - Indent string
    • eAlignType - Alignment type
    4. to list
to top previous next upper table of contents Comment