PEAR Manual
Prev |  | Next

# Gtk_ScrollingLabel::startScroll

Gtk_ScrollingLabel::startScroll -- Begins scrolling the text from the start of the string.

## Synopsis

    require_once 'Gtk/ScrollingLabel.php';

``boolean Gtk_ScrollingLabel::startScroll` ()`

## Description

startScroll() will make the text begin scrolling in the direction given by calling setDirection(). If the text is scrolling left to right (`GTK_SCROLLINGLABEL_RIGHT`), the current character position is set to the end of the text. This means that the last character of the label will be the first character shown. If the text is scrolling right to left (`GTK_SCROLLINGLABEL_LEFT`), the current character position is set to zero. This means that first character shown will be a blank space.

This method is best used when connected to an event.

## Return value

returns `true` if the text has started scrolling. `false` otherwise.

## See

setStartSignal()

## Note

This function can not be called statically.

Prev | Home | Next
Gtk_ScrollingLabel::setStartSignal | Up | Gtk_ScrollingLabel::unPause