Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Related Pages

ScrollPane: A Scrollable Viewing Area

Provides a scrollable area for viewing large sets of widgets in a smaller viewable region. More...

Data Structures

struct  Ewl_ScrollPane
 Inherits from Ewl_Container and extends it to enclose a single widget in vertical and horizontal scrollbars for panning around displaying different regions of the enclosed widget. More...

struct  Ewl_ScrollPane
 Inherits from Ewl_Container and extends it to enclose a single widget in vertical and horizontal scrollbars for panning around displaying different regions of the enclosed widget. More...


Defines

#define EWL_SCROLLPANE(scrollpane)   ((Ewl_ScrollPane *) scrollpane)
 Typecasts a pointer to an Ewl_ScrollPane pointer.


Typedefs

typedef Ewl_ScrollPane Ewl_ScrollPane
 The scrollpane provides a way to pan around large collections of images.


Functions

Ewl_Widgetewl_scrollpane_new (void)
 Create a new scrollpane.

int ewl_scrollpane_init (Ewl_ScrollPane *s)
 Initialize the fields of a scrollpane.

void ewl_scrollpane_hscrollbar_flag_set (Ewl_ScrollPane *s, Ewl_ScrollBar_Flags f)
 Set flags for horizontal scrollbar.

void ewl_scrollpane_vscrollbar_flag_set (Ewl_ScrollPane *s, Ewl_ScrollBar_Flags f)
 Set flags for vertical scrollbar.

Ewl_ScrollBar_Flags ewl_scrollpane_hscrollbar_flag_get (Ewl_ScrollPane *s)
 Get flags for horizontal scrollbar.

Ewl_ScrollBar_Flags ewl_scrollpane_vscrollbar_flag_get (Ewl_ScrollPane *s)
 Get flags for vertical scrollbar.

double ewl_scrollpane_hscrollbar_value_get (Ewl_ScrollPane *s)
 Retrieves the value of the horizontal scrollbar in s.

double ewl_scrollpane_vscrollbar_value_get (Ewl_ScrollPane *s)
 Retrieves the value of the vertical scrollbar in s.

void ewl_scrollpane_hscrollbar_value_set (Ewl_ScrollPane *s, double val)
 Set the value of the horizontal scrollbar in s to val.

void ewl_scrollpane_vscrollbar_value_set (Ewl_ScrollPane *s, double val)
 Set the value of the vertical scrollbar in s to val.

double ewl_scrollpane_hscrollbar_step_get (Ewl_ScrollPane *s)
 Retrives the value of the stepping of the vertical scrollbar in s.

double ewl_scrollpane_vscrollbar_step_get (Ewl_ScrollPane *s)
 Retrives the value of the stepping of the vertical scrollbar in s.


Detailed Description

Provides a scrollable area for viewing large sets of widgets in a smaller viewable region.


Function Documentation

Ewl_ScrollBar_Flags ewl_scrollpane_hscrollbar_flag_get Ewl_ScrollPane s  ) 
 

Get flags for horizontal scrollbar.

Parameters:
s: the scrollpane that contains the scrollbar to retrieve
Returns:
Returns the flags of the horizontal scrollbar, 0 on failure.

void ewl_scrollpane_hscrollbar_flag_set Ewl_ScrollPane s,
Ewl_ScrollBar_Flags  f
 

Set flags for horizontal scrollbar.

Parameters:
s: the scrollpane that contains the scrollbar to change
f: the flags to set on the horizontal scrollbar in s
Returns:
Returns no value.
The scrollbar flags for the horizontal scrollbar are set to f.

double ewl_scrollpane_hscrollbar_step_get Ewl_ScrollPane s  ) 
 

Retrives the value of the stepping of the vertical scrollbar in s.

Parameters:
s: the scrollpane to retrieve its vertical scrollbar stepping
Returns:
Returns the value of the stepping of the vertical scrollbar in s on success.

double ewl_scrollpane_hscrollbar_value_get Ewl_ScrollPane s  ) 
 

Retrieves the value of the horizontal scrollbar in s.

Parameters:
s: the scrollpane to retrieve it's horizontal scrollbar value
Returns:
Returns the value of the horizontal scrollbar in s on success.

void ewl_scrollpane_hscrollbar_value_set Ewl_ScrollPane s,
double  val
 

Set the value of the horizontal scrollbar in s to val.

Parameters:
s: the scrollpane to set the horizontal scrollbar value
val: the value to set the scrollbar too
Returns:
Returns nothing

int ewl_scrollpane_init Ewl_ScrollPane s  ) 
 

Initialize the fields of a scrollpane.

Parameters:
s: the scrollpane to initialize
Returns:
Returns no value.
Sets up default callbacks and field values for the scrollpane s.

Ewl_Widget* ewl_scrollpane_new void   ) 
 

Create a new scrollpane.

Returns:
Returns a new scrollpane on success, NULL on failure.

Ewl_ScrollBar_Flags ewl_scrollpane_vscrollbar_flag_get Ewl_ScrollPane s  ) 
 

Get flags for vertical scrollbar.

Parameters:
s: the scrollpane that contains the scrollbar to retrieve
Returns:
Returns the flags of the vertical scrollbar on success, 0 on failure.

void ewl_scrollpane_vscrollbar_flag_set Ewl_ScrollPane s,
Ewl_ScrollBar_Flags  f
 

Set flags for vertical scrollbar.

Parameters:
s: the scrollpane that contains the scrollbar to change
f: the flags to set on the vertical scrollbar in s
Returns:
Returns no value.
The scrollbar flags for the vertical scrollbar are set to f.

double ewl_scrollpane_vscrollbar_step_get Ewl_ScrollPane s  ) 
 

Retrives the value of the stepping of the vertical scrollbar in s.

Parameters:
s: the scrollpane to retrieve its vertical scrollbar stepping
Returns:
Returns the value of the stepping of the vertical scrollbar in s on success.

double ewl_scrollpane_vscrollbar_value_get Ewl_ScrollPane s  ) 
 

Retrieves the value of the vertical scrollbar in s.

Parameters:
s: the scrollpane to retrieve it's vertical scrollbar value
Returns:
Returns the value of the vertical scrollbar in s on success.

void ewl_scrollpane_vscrollbar_value_set Ewl_ScrollPane s,
double  val
 

Set the value of the vertical scrollbar in s to val.

Parameters:
s: the scrollpane to set the vertical scrollbar value
val: the value to set the scrollbar too
Returns:
Returns nothing