Gtk_Styled_Adjustment (Constructor) [line 120]
void Gtk_Styled_Adjustment(
double
$value, double
$lower, double
$upper, double
$step_inc, double
$page_inc, double
$page_size)
|
|
Constructor.
The constructor should set the basic properties of the pseudo widget and then create the more advanced properties. The advanced properties include the bar and the track that it moves in.
Parameters:
changed [line 498]
Notify the system that a change has been made.
Parameters:
checkMouseBounds [line 691]
boolean checkMouseBounds(
none
0)
|
|
Check to see that the mouse is within the boundries of the bar.
Check the current mouse position to see if it is within the bounds of the adjustment bar. It is only necessary to check if the mouse is with in one direction of the bar's alloted space. For example, we only care if the mouse is within the y-range of a vertical adjustment.
Overridden in child classes as:
- Gtk_Styled_VAdjustment::checkMouseBounds()
- Check to see that the mouse is within the boundries of the bar.
- Gtk_Styled_HAdjustment::checkMouseBounds()
- Check to see that the mouse is within the boundries of the bar.
Parameters:
clamp_page [line 523]
void clamp_page(
double
$lower, double
$upper)
|
|
Prevent the bound of the track from being exceeded by the bar.
Parameters:
getLower [line 623]
Get the adjustments lower limit.
Parameters:
getPageIncrement [line 659]
double getPageIncrement(
none
0)
|
|
Get the adjustments page increment.
Parameters:
getPageSize [line 671]
double getPageSize(
none
0)
|
|
Get the adjustments page size.
Parameters:
getStepIncrement [line 647]
double getStepIncrement(
none
0)
|
|
Get the adjustments step increment.
Parameters:
getUpper [line 635]
Get the adjustments upper limit.
Parameters:
getValue [line 611]
Get the adjustments value.
Parameters:
getWidget [line 171]
&object &getWidget(
none
0)
|
|
Get the final product that the user can use.
To make things easier for the user, and to keep some consistency with other PEAR Gtk classes, the final usable object is called widget and is returned from the getWidget method.
Parameters:
setBarContents [line 595]
widget &setBarContents(
object
&$widget)
|
|
Set the contents of the bar to the given widget.
This method makes it possible to put a label, pixmap, or any other widget into the bar in order to alter the bar's appearance. When combined with setBarMask(), this method makes the style an shape of the adjustment bar completely controllable by the programmer.
The previous contents of the bar are returned after the new contents have been added.
Parameters:
setBarMask [line 574]
void setBarMask(
object
&$mask, [
$x = 0], [
$y = 0])
|
|
Set the pix mask for the bar.
Make the bar appear to be something other than a rectangle. This lets you create images for the bar so that it can be anything you want. This is the ultimate in adjustment customizatioin.
NOTE: I don't know what will happen if you change the size of the bar when a mask is applied. Changing the page size and upper and lower values could have undesired effects.
Parameters:
setLower [line 381]
void setLower(
double
$lower)
|
|
Set the lower limit of the adjustment.
Sets the lower limit of the adjustment widget. The lower limit affects the bar size and position.
Parameters:
setPageIncrement [line 454]
void setPageIncrement(
double
$increment)
|
|
Set the size of one page movement.
Sets the size of one page. One page is the amount a scroll bar will move when the space around the bar of a scroll bar is pressed.
Parameters:
setPageSize [line 477]
void setPageSize(
$pageSize, double
$increment)
|
|
Set the size of one page.
Sets the size of one page. One page is the size of the display area. Changing the page size has an affect on the bar size and position.
Parameters:
setStepIncrement [line 431]
void setStepIncrement(
double
$increment)
|
|
Set the size of one step.
Sets the size of one step. One step is the amount a scroll bar will move when the arrow at the begining or end of the scroll bar is pressed.
Parameters:
setStyle [line 549]
void setStyle(
string
$portion,
$style, widget
&$style)
|
|
Set the style for a portion of the adjustment.
Each portion of the adjustment is styleable. The style that is passed will be applied to the portion of the adjustment.
Parameters:
setUpper [line 405]
void setUpper(
double
$upper)
|
|
Set the upper limit of the adjustment.
Sets the upper limit of the adjustment widget. The upper limit affects the bar size and position.
Parameters:
setValue [line 349]
void setValue(
double
$value)
|
|
Set the current adjustment value.
Sets the value that the adjustment represents. The value has an impact on the bar position and size.
Parameters:
set_value [line 533]
Alias of setValue. Added for API consistency.
Parameters:
value_changed [line 510]
void value_changed(
none
0)
|
|
Notify the system that a value has changed.
Parameters: