Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

fl7::faces::Scrollable Class Reference

#include <Scrollable.h>

Inheritance diagram for fl7::faces::Scrollable:
fl7::faces::Fusion fl7::faces::Collection fl7::faces::Face

List of all members.

Public Member Functions

 Scrollable (Shell *const shell)
virtual ~Scrollable (void)
float GetScrolledVertical () const
float GetScrolledHorizontal () const
float GetScrollMaxVertical () const
float GetScrollMaxHorizontal () const
bool CanScrollVertical () const
bool CanScrollHorizontal () const
void SetScrolledVertical (float scrolled_vertical)
void SetScrolledHorizontal (float scrolled_horizontal)

Public Attributes

events::EventHandler
< events::ScrollEventArgs
OnScrollVerticalEventHandler
events::EventHandler
< events::ScrollEventArgs
OnScrollHorizontalEventHandler
friend Shell

Protected Member Functions

 Scrollable (const unsigned face_class_id, Shell *const shell, const Config::Face &cfg)
void SetScrollMaxVertical (const float scroll_max_vertical)
void SetScrollMaxHorizontal (const float scroll_max_horizontal)

Protected Attributes

bool _can_scroll_vertical
bool _can_scroll_horizontal

Detailed Description

The base class for scrollable faces (windows, list boxes etc.).


Constructor & Destructor Documentation

fl7::faces::Scrollable::Scrollable ( const unsigned  face_class_id,
Shell *const   shell,
const Config::Face cfg 
) [explicit, protected]

Explicit constructor.

fl7::faces::Scrollable::Scrollable ( Shell *const   shell  ) 

Explicit constructor.

fl7::faces::Scrollable::~Scrollable ( void   )  [virtual]

Destructor.


Member Function Documentation

bool fl7::faces::Scrollable::CanScrollHorizontal (  )  const [inline]

Returns the flag specifying whether this face can be scrolled horizontally.

bool fl7::faces::Scrollable::CanScrollVertical (  )  const [inline]

Returns the flag specifying whether this face can be scrolled vertically.

float fl7::faces::Scrollable::GetScrolledHorizontal (  )  const [inline]

Returns the current amount this face has been scrolled horizontally.

float fl7::faces::Scrollable::GetScrolledVertical (  )  const [inline]

Returns the current amount this face has been scrolled vertically.

float fl7::faces::Scrollable::GetScrollMaxHorizontal (  )  const [inline]

Returns the maximum amount this face can be scrolled horizontally.

float fl7::faces::Scrollable::GetScrollMaxVertical (  )  const [inline]

Returns the maximum amount this face can be scrolled vertically.

void fl7::faces::Scrollable::SetScrolledHorizontal ( float  scrolled_horizontal  ) 

Sets the current amount this face has been scrolled horizontally.

void fl7::faces::Scrollable::SetScrolledVertical ( float  scrolled_vertical  ) 

Sets the current amount this face has been scrolled vertically.

void fl7::faces::Scrollable::SetScrollMaxHorizontal ( const float  scroll_max_horizontal  )  [protected]

Sets the maximum amount this face can be scrolled horizontally.

void fl7::faces::Scrollable::SetScrollMaxVertical ( const float  scroll_max_vertical  )  [protected]

Sets the maximum amount this face can be scrolled vertically.


Member Data Documentation

The flag specifying whether this face can be scrolled horizontally.

The flag specifying whether this face can be scrolled vertically.

Will be called after this face has been scrolled horizontally.

Will be called after this face has been scrolled vertically.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines