GLabel

Class

Index

Class GLabel

GObject
   GLabel

The GLabel class is a graphical object whose appearance consists of a text string.

Constructor Summary
`GLabel(text)` Creates a new `GLabel` object initialized to contain the specified string.
`GLabel(text, x, y)` Creates a new `GLabel` object with its baseline origin at the specified position.

Method Summary
`getAscent()` Returns the distance this string extends above the baseline.
`getDescent()` Returns the distance this string descends below the baseline.
`getFont()` Returns the font in which the `GLabel` is displayed.
`getLabel()` Returns the string displayed by this object.
`setFont(font)` Changes the font used to display the `GLabel` as indicated by the string `str`, which is interpreted as a CSS font specification.
`setLabel(text)` Changes the string stored within the `GLabel` object, so that a new text string appears on the display.

Inherited Method Summary
`contains(x, y)` Checks to see whether a point is inside the object.
`getBounds()` Returns the bounding box for this object.
`getColor()` Returns the color used to display the text of the `GLabel`.
`getHeight()` Returns the height of this object, which is defined to be the height of the bounding box.
`getLocation()` Returns the location of the `GLabel` as a `GPoint` object.
`getSize()` Returns the size of the bounding box for this object.
`getWidth()` Returns the width of this object, which is defined to be the width of the bounding box.
`getX()` Returns the x-coordinate of the object.
`getY()` Returns the y-coordinate of the object.
`isVisible()` Checks to see whether the `GLabel` is visible.
`move(dx, dy)` Moves the object on the screen using the displacements `dx` and `dy`.
`movePolar(r, theta)` Moves the object using displacements given in polar coordinates.
`sendBackward()` Moves this object one step toward the back in the z dimension.
`sendForward()` Moves this object one step toward the front in the z dimension.
`sendToBack()` Moves this object to the back of the display in the z dimension.
`sendToFront()` Moves this object to the front of the display in the z dimension.
`setColor(color)` Sets the color used to display this object.
`setLocation(x, y)` Sets the location of the `GLabel` to the point (`x`, `y`). For a `GLabel`, the location is the point on the text baseline at which the text starts.
`setVisible(flag)` Sets the visibility status of the `GLabel`.

Constructor Detail

`GLabel(text) str)`

Creates a new GLabel object initialized to contain the specified string.

Usage: glabel = GLabel(str)

Parameter:

str The initial contents of the GLabel

`GLabel(text, x, y)`

Creates a new GLabel object with its baseline origin at the specified position.

Usage: glabel = GLabel(str, x, y)

Parameters:

`str`	The initial contents of the `GLabel`
`x`	The x-coordinate of the label origin
`y`	The y-coordinate of the baseline for the label

Method Detail

`getAscent()`

Returns the distance this string extends above the baseline.

Usage:	`ascent = glabel.getAscent()`
Returns:	The ascent of this string in pixels

`getDescent()`

Returns the distance this string descends below the baseline.

Usage:	`descent = glabel.getDescent()`
Returns:	The descent of this string in pixels

`getFont()`

Returns the font in which the GLabel is displayed.

Usage:	`font = glabel.getFont()`
Returns:	The font in use by this object

`getLabel()`

Returns the string displayed by this object.

Usage:	`str = glabel.getLabel()`
Returns:	The string displayed by this object

`setFont(font)`

Changes the font used to display the GLabel as indicated by the string font, which is interpreted in the style of CSS font specification.

Usage: glabel.setFont(str)

Parameter:

str A string specifying the new font

`setLabel(text) str)`

Changes the string stored within the GLabel object, so that a new text string appears on the display.

Usage: glabel.setLabel(str)

Parameter:

str The new string to display

Overview

Class

Index