NovaTK::Scrollbar Class Reference

Inheritance diagram for NovaTK::Scrollbar:
Collaboration diagram for NovaTK::Scrollbar:

List of all members.


Detailed Description

Provides a bar with a slider that indicates the what part of the document is visible to the user and allows the user to drag their view of the document by dragging the slider.

Public Types

enum  Direction { Vertical, Horizontal }

Public Member Functions

virtual NOVATKAPI NStatus Create (Window *parent, int c_x, int c_y, int c_length, Direction c_direction)
virtual NOVATKAPI void Destroy ()
virtual NOVATKAPI void Resize (uint r_length)
NOVATKAPI void SetPosition (double position)
NOVATKAPI void SetUnits (double numUnits)
NOVATKAPI double GetPosition ()
NOVATKAPI double GetNumUnits ()

Member Enumeration Documentation

Indicates the upon which axis the scrollbar is based.

Enumerator:
Vertical  The scrollbar will run vertically.
Horizontal  The scrollbar will run horizontally.


Member Function Documentation

NStatus NovaTK::Scrollbar::Create ( Window parent,
int  c_x,
int  c_y,
int  c_length,
Direction  c_direction 
) [virtual]

Initializes the widget. This works just like Widget::Create except that is specifies only the length of the bar and its direction because the thickness/width is static.

void NovaTK::Scrollbar::Destroy (  )  [virtual]

Destroys the widget.

Reimplemented from NovaTK::Widget.

void NovaTK::Scrollbar::Resize ( uint  r_length  )  [virtual]

Changes the length of the width. Note that the width/thickness of the bar is static.

void NovaTK::Scrollbar::SetPosition ( double  position  ) 

Changes the position of the slider and therefore the view of the document.

void NovaTK::Scrollbar::SetUnits ( double  numUnits  ) 

Specifies the number of logical units that represent the length of the document. This will be equal to the maximum position minus one.

NOVATKAPI double NovaTK::Scrollbar::GetPosition (  )  [inline]

Returns:
The position of the view of the document.

NOVATKAPI double NovaTK::Scrollbar::GetNumUnits (  )  [inline]

Returns:
The number of logical units set by SetUnits.


The documentation for this class was generated from the following files:

Generated on Sat Sep 13 22:34:22 2008 for NovaTK by  doxygen 1.5.5