gui::scrollarea Class Reference

#include <scrollarea.hpp>

Inheritance diagram for gui::scrollarea:

Inheritance graph
[legend]
Collaboration diagram for gui::scrollarea:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 scrollarea (CVideo &video, bool auto_join=true)
 Create a zone with automatic handling of scrollbar.
virtual void hide (bool value=true)

Protected Member Functions

virtual handler_vector handler_members ()
virtual void update_location (SDL_Rect const &rect)
virtual void handle_event (const SDL_Event &event)
virtual void process_event ()
virtual void scroll (unsigned int pos)=0
virtual void set_inner_location (SDL_Rect const &rect)=0
SDL_Rect inner_location () const
unsigned scrollbar_width () const
unsigned get_position () const
unsigned get_max_position () const
void set_position (unsigned pos)
void adjust_position (unsigned pos)
void move_position (int dep)
void set_shown_size (unsigned h)
void set_full_size (unsigned h)
void set_scroll_rate (unsigned r)
bool has_scrollbar () const

Private Member Functions

void test_scrollbar ()

Private Attributes

scrollbar scrollbar_
int old_position_
bool recursive_
bool shown_scrollbar_
unsigned shown_size_
unsigned full_size_


Detailed Description

Definition at line 28 of file scrollarea.hpp.


Constructor & Destructor Documentation

gui::scrollarea::scrollarea ( CVideo video,
bool  auto_join = true 
)

Create a zone with automatic handling of scrollbar.

Todo:
FIXME: parameterlist ??

Definition at line 27 of file scrollarea.cpp.

References gui::scrollbar::hide(), and scrollbar_.


Member Function Documentation

void gui::scrollarea::hide ( bool  value = true  )  [virtual]

handler_vector gui::scrollarea::handler_members (  )  [protected, virtual]

Reimplemented from events::handler.

Reimplemented in gui::dialog_textbox.

Definition at line 40 of file scrollarea.cpp.

References scrollbar_.

Referenced by gui::dialog_textbox::handler_members().

void gui::scrollarea::update_location ( SDL_Rect const &  rect  )  [protected, virtual]

void gui::scrollarea::handle_event ( const SDL_Event &  event  )  [protected, virtual]

void gui::scrollarea::process_event (  )  [protected, virtual]

Reimplemented from events::handler.

Definition at line 129 of file scrollarea.cpp.

References gui::scrollbar::get_position(), old_position_, scroll(), and scrollbar_.

virtual void gui::scrollarea::scroll ( unsigned int  pos  )  [protected, pure virtual]

virtual void gui::scrollarea::set_inner_location ( SDL_Rect const &  rect  )  [protected, pure virtual]

SDL_Rect gui::scrollarea::inner_location (  )  const [protected]

unsigned gui::scrollarea::scrollbar_width (  )  const [protected]

Definition at line 146 of file scrollarea.cpp.

References scrollbar_, and gui::widget::width().

Referenced by gui::menu::update_size(), and gui::menu::wrap_words().

unsigned gui::scrollarea::get_position (  )  const [protected]

unsigned gui::scrollarea::get_max_position (  )  const [protected]

void gui::scrollarea::set_position ( unsigned  pos  )  [protected]

void gui::scrollarea::adjust_position ( unsigned  pos  )  [protected]

void gui::scrollarea::move_position ( int  dep  )  [protected]

Definition at line 105 of file scrollarea.cpp.

References gui::scrollbar::move_position(), and scrollbar_.

void gui::scrollarea::set_shown_size ( unsigned  h  )  [protected]

void gui::scrollarea::set_full_size ( unsigned  h  )  [protected]

void gui::scrollarea::set_scroll_rate ( unsigned  r  )  [protected]

bool gui::scrollarea::has_scrollbar (  )  const [protected]

void gui::scrollarea::test_scrollbar (  )  [private]


Member Data Documentation

Definition at line 62 of file scrollarea.hpp.

Referenced by process_event().

Definition at line 63 of file scrollarea.hpp.

Referenced by test_scrollbar().

Definition at line 63 of file scrollarea.hpp.

Referenced by hide(), inner_location(), test_scrollbar(), and update_location().

unsigned gui::scrollarea::shown_size_ [private]

Definition at line 64 of file scrollarea.hpp.

Referenced by has_scrollbar(), and set_shown_size().

unsigned gui::scrollarea::full_size_ [private]

Definition at line 65 of file scrollarea.hpp.

Referenced by has_scrollbar(), and set_full_size().


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

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs