Labels

OBJECTS

  typedef control  label;

FUNCTIONS

  label   newlabel(char *text, rect r, int alignment);

CONSTANTS

  #define AlignTop      0x0000
  #define AlignBottom   0x0100
  #define VJustify      0x0200
  #define VCenter       0x0400
  #define VCentre       0x0400
  #define AlignLeft     0x0000
  #define AlignRight    0x1000
  #define Justify       0x2000
  #define Center        0x4000
  #define Centre        0x4000
  #define AlignCenter   0x4000
  #define AlignCentre   0x4000
  #define Underline     0x0800

NOTES

The newlabel function creates a text label which cannot be edited by the user. The text string is aligned within the rectangle according to the value of the alignment parameter. Values such as AlignLeft, AlightRight or Center can be specified. A value of zero corresponds to AlignLeft+AlignTop.

It can be seen from the list of possible alignments above, both American and British spellings of the the word 'Centre' are legal.

The vertical alignments are explained below:

• AlignTop (the default) means the label's text will be drawn starting from the top of the label's rectangle.
• AlignBottom draws the text so that it fills the label from the bottom of its rectangle.
• VJustify vertically justifies the text, so the inter-line spacing will be large enough for the text to fill the label's rectangle.
• VCenter or VCentre vertically centers the text.

• AlignLeft (the default) makes the text start at the left hand edge of the rectangle.
• AlignRight causes the text to appear at the rightmost edge of the rectangle. This is useful in fill-in forms.
• Justify is similar to AlignLeft, except if the text spans more than one line, in which case the spaces between words will be enlarged so each line fills the rectangle horizontally.
• Center, Centre, AlignCenter and AlignCentre all have the effect of horizontally centering the text within the rectangle.

• The Underline style makes each line of text underlined.

Either a vertical, or a horizontal alignment can be specified, or a combination of the two, using the plus or bitwise-or operators to combine the alignments. The Underline flag can also be added to the alignment to change the appearance of the label.