dw::fltk::FltkViewport Class Reference

#include <fltkviewport.hh>

List of all members.

Public Types
enum	GadgetOrientation { GADGET_VERTICAL, GADGET_HORIZONTAL }
Public Member Functions
	FltkViewport (int x, int y, int w, int h, const char *label=0)
	~FltkViewport ()
void	resize (int x, int y, int w, int h)
void	draw ()
int	handle (int event)
void	setCanvasSize (int width, int ascent, int descent)
	Set the canvas size.
bool	usesViewport ()
	Return, whether this view uses a viewport.
int	getHScrollbarThickness ()
	Get the thickness of the horizontal scrollbar, when it is visible.
int	getVScrollbarThickness ()
	Get the thickness of the vertical scrollbar, when it is visible.
void	scroll (int dx, int dy)
void	scroll (dw::core::ScrollCommand cmd)
	Scroll the viewport as commanded.
void	scrollTo (int x, int y)
	Scroll the vieport to the given position.
void	setViewportSize (int width, int height, int hScrollbarThickness, int vScrollbarThickness)
	Set the viewport size.
void	setScrollStep (int step)
void	setGadgetOrientation (bool hscrollbarVisible, bool vscrollbarVisible, GadgetOrientation gadgetOrientation)
void	setDragScroll (bool enable)
void	addGadget (Fl_Widget *gadget)
Protected Member Functions
int	translateViewXToCanvasX (int x)
int	translateViewYToCanvasY (int y)
int	translateCanvasXToViewX (int x)
int	translateCanvasYToViewY (int y)
Private Types
enum	{ SCROLLBAR_THICKNESS = 15 }
Private Member Functions
void	adjustScrollbarsAndGadgetsAllocation ()
void	adjustScrollbarValues ()
void	hscrollbarChanged ()
void	vscrollbarChanged ()
void	positionChanged ()
void	updateCanvasWidgets (int oldScrollX, int oldScrollY)
Static Private Member Functions
static void	hscrollbarCallback (Fl_Widget *hscrollbar, void *viewportPtr)
static void	vscrollbarCallback (Fl_Widget *vscrollbar, void *viewportPtr)
static void	draw_area (void *data, int x, int y, int w, int h)
Private Attributes
int	scrollX
int	scrollY
int	scrollDX
int	scrollDY
int	hasDragScroll
int	dragScrolling
int	dragX
int	dragY
int	horScrolling
int	verScrolling
Fl_Scrollbar *	vscrollbar
Fl_Scrollbar *	hscrollbar
GadgetOrientation	gadgetOrientation [4]
lout::container::typed::List < lout::object::TypedPointer < Fl_Widget > > *	gadgets

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

SCROLLBAR_THICKNESS

enum dw::fltk::FltkViewport::GadgetOrientation

Enumerator:

GADGET_VERTICAL
GADGET_HORIZONTAL

---

Constructor & Destructor Documentation

dw::fltk::FltkViewport::FltkViewport	(	int	x,
		int	y,
		int	w,
		int	h,
		const char *	label = 0
	)

References dragScrolling, GADGET_HORIZONTAL, GADGET_VERTICAL, gadgetOrientation, gadgets, hasDragScroll, horScrolling, hscrollbar, hscrollbarCallback(), scrollDX, scrollDY, scrollX, scrollY, verScrolling, vscrollbar, and vscrollbarCallback().

dw::fltk::FltkViewport::~FltkViewport

(

)

References gadgets.

---

Member Function Documentation

void dw::fltk::FltkViewport::addGadget

(

Fl_Widget *

gadget

)

Bug:

Reparent?

References adjustScrollbarsAndGadgetsAllocation(), lout::container::typed::List< T >::append(), and gadgets.

void dw::fltk::FltkViewport::adjustScrollbarsAndGadgetsAllocation

(

)

[private]

References GADGET_HORIZONTAL, GADGET_VERTICAL, gadgetOrientation, gadgets, hscrollbar, lout::container::typed::Collection< T >::iterator(), SCROLLBAR_THICKNESS, lout::container::typed::List< T >::size(), and vscrollbar.

Referenced by addGadget(), resize(), setGadgetOrientation(), and setViewportSize().

void dw::fltk::FltkViewport::adjustScrollbarValues

(

)

[private]

References dw::fltk::FltkViewBase::canvasHeight, dw::fltk::FltkViewBase::canvasWidth, hscrollbar, scrollX, scrollY, and vscrollbar.

Referenced by scrollTo(), and setCanvasSize().

void dw::fltk::FltkViewport::draw

(

)

Reimplemented from dw::fltk::FltkViewBase.

References draw_area(), hscrollbar, SCROLLBAR_THICKNESS, scrollDX, scrollDY, and vscrollbar.

void dw::fltk::FltkViewport::draw_area	(	void *	data,
		int	x,
		int	y,
		int	w,
		int	h
	)			[static, private]

References gadgets, and lout::container::typed::Collection< T >::iterator().

Referenced by draw().

int dw::fltk::FltkViewport::getHScrollbarThickness

(

)

[virtual]

Get the thickness of the horizontal scrollbar, when it is visible.

Does not have to be implemented, when usesViewport returns false.

Implements dw::core::View.

References SCROLLBAR_THICKNESS.

int dw::fltk::FltkViewport::getVScrollbarThickness

(

)

[virtual]

Get the thickness of the vertical scrollbar, when it is visible.

Does not have to be implemented, when usesViewport returns false.

Implements dw::core::View.

References SCROLLBAR_THICKNESS.

int dw::fltk::FltkViewport::handle

(

int

event

)

Bug:

Draw focus box.

Bug:

Undraw focus box.

Reimplemented from dw::fltk::FltkViewBase.

References dw::core::style::CURSOR_DEFAULT, dw::core::style::CURSOR_MOVE, dragScrolling, dragX, dragY, dw::fltk::FltkViewBase::handle(), hasDragScroll, horScrolling, hscrollbar, dw::fltk::FltkViewBase::mouse_x, dw::fltk::FltkViewBase::mouse_y, positionChanged(), scroll(), dw::fltk::FltkViewBase::setCursor(), verScrolling, and vscrollbar.

void dw::fltk::FltkViewport::hscrollbarCallback	(	Fl_Widget *	hscrollbar,
		void *	viewportPtr
	)			[static, private]

Referenced by FltkViewport().

void dw::fltk::FltkViewport::hscrollbarChanged

(

)

[private]

References hscrollbar, scroll(), and scrollX.

void dw::fltk::FltkViewport::positionChanged

(

)

[private]

References dragScrolling, dw::core::Layout::motionNotify(), dw::fltk::FltkViewBase::mouse_x, dw::fltk::FltkViewBase::mouse_y, dw::fltk::FltkViewBase::theLayout, translateViewXToCanvasX(), and translateViewYToCanvasY().

Referenced by handle(), and scrollTo().

void dw::fltk::FltkViewport::resize	(	int	x,
		int	y,
		int	w,
		int	h
	)

References adjustScrollbarsAndGadgetsAllocation(), dw::fltk::FltkViewBase::theLayout, and dw::core::Layout::viewportSizeChanged().

void dw::fltk::FltkViewport::scroll

(

dw::core::ScrollCommand

)

[virtual]

Scroll the viewport as commanded.

Reimplemented from dw::core::View.

References dw::core::BOTTOM_CMD, dw::fltk::FltkViewBase::canvasHeight, hscrollbar, dw::core::LEFT_CMD, dw::core::LINE_DOWN_CMD, dw::core::LINE_UP_CMD, dw::core::RIGHT_CMD, dw::core::SCREEN_DOWN_CMD, dw::core::SCREEN_UP_CMD, scroll(), scrollTo(), scrollX, dw::core::TOP_CMD, and vscrollbar.

void dw::fltk::FltkViewport::scroll	(	int	dx,
		int	dy
	)

References scrollTo(), scrollX, and scrollY.

Referenced by handle(), hscrollbarChanged(), scroll(), setViewportSize(), and vscrollbarChanged().

void dw::fltk::FltkViewport::scrollTo	(	int	x,
		int	y
	)			[virtual]

Scroll the vieport to the given position.

Does not have to be implemented, when usesViewport returns false.

Implements dw::core::View.

References adjustScrollbarValues(), dw::fltk::FltkViewBase::canvasHeight, dw::fltk::FltkViewBase::canvasWidth, hscrollbar, lout::misc::max(), lout::misc::min(), positionChanged(), SCROLLBAR_THICKNESS, scrollDX, scrollDY, dw::core::Layout::scrollPosChanged(), scrollX, scrollY, dw::fltk::FltkViewBase::theLayout, updateCanvasWidgets(), and vscrollbar.

Referenced by scroll().

void dw::fltk::FltkViewport::setCanvasSize	(	int	width,
		int	ascent,
		int	descent
	)			[virtual]

Set the canvas size.

Reimplemented from dw::fltk::FltkViewBase.

References adjustScrollbarValues().

void dw::fltk::FltkViewport::setDragScroll

(

bool

enable

)

[inline]

References hasDragScroll.

void dw::fltk::FltkViewport::setGadgetOrientation	(	bool	hscrollbarVisible,
		bool	vscrollbarVisible,
		FltkViewport::GadgetOrientation	gadgetOrientation
	)

References adjustScrollbarsAndGadgetsAllocation().

void dw::fltk::FltkViewport::setScrollStep

(

int

step

)

References hscrollbar, and vscrollbar.

void dw::fltk::FltkViewport::setViewportSize	(	int	width,
		int	height,
		int	hScrollbarThickness,
		int	vScrollbarThickness
	)			[virtual]

Set the viewport size.

Does not have to be implemented, when usesViewport returns false.

This will normally imply a resize of the UI widget. Width and height are the dimensions of the new size, including the scrollbar thicknesses.

Implements dw::core::View.

References adjustScrollbarsAndGadgetsAllocation(), hscrollbar, scroll(), scrollX, scrollY, and vscrollbar.

int dw::fltk::FltkViewport::translateCanvasXToViewX

(

int

x

)

[protected, virtual]

Implements dw::fltk::FltkViewBase.

References scrollX.

int dw::fltk::FltkViewport::translateCanvasYToViewY

(

int

y

)

[protected, virtual]

Implements dw::fltk::FltkViewBase.

References scrollY.

int dw::fltk::FltkViewport::translateViewXToCanvasX

(

int

x

)

[protected, virtual]

Implements dw::fltk::FltkViewBase.

References scrollX.

Referenced by positionChanged().

int dw::fltk::FltkViewport::translateViewYToCanvasY

(

int

y

)

[protected, virtual]

Implements dw::fltk::FltkViewBase.

References scrollY.

Referenced by positionChanged().

void dw::fltk::FltkViewport::updateCanvasWidgets	(	int	oldScrollX,
		int	oldScrollY
	)			[private]

References hscrollbar, and vscrollbar.

Referenced by scrollTo().

bool dw::fltk::FltkViewport::usesViewport

(

)

[virtual]

Return, whether this view uses a viewport.

Implements dw::core::View.

void dw::fltk::FltkViewport::vscrollbarCallback	(	Fl_Widget *	vscrollbar,
		void *	viewportPtr
	)			[static, private]

Referenced by FltkViewport().

void dw::fltk::FltkViewport::vscrollbarChanged

(

)

[private]

References scroll(), scrollY, and vscrollbar.

---

Member Data Documentation

int dw::fltk::FltkViewport::dragScrolling [private]

Referenced by FltkViewport(), handle(), and positionChanged().

int dw::fltk::FltkViewport::dragX [private]

Referenced by handle().

int dw::fltk::FltkViewport::dragY [private]

Referenced by handle().

GadgetOrientation dw::fltk::FltkViewport::gadgetOrientation[4] [private]

Referenced by adjustScrollbarsAndGadgetsAllocation(), and FltkViewport().

lout::container::typed::List<lout::object::TypedPointer < Fl_Widget> >* dw::fltk::FltkViewport::gadgets [private]

Referenced by addGadget(), adjustScrollbarsAndGadgetsAllocation(), draw_area(), FltkViewport(), and ~FltkViewport().

int dw::fltk::FltkViewport::hasDragScroll [private]

Referenced by FltkViewport(), handle(), and setDragScroll().

int dw::fltk::FltkViewport::horScrolling [private]

Referenced by FltkViewport(), and handle().

Fl_Scrollbar * dw::fltk::FltkViewport::hscrollbar [private]

Referenced by adjustScrollbarsAndGadgetsAllocation(), adjustScrollbarValues(), draw(), FltkViewport(), handle(), hscrollbarChanged(), scroll(), scrollTo(), setScrollStep(), setViewportSize(), and updateCanvasWidgets().

int dw::fltk::FltkViewport::scrollDX [private]

Referenced by draw(), FltkViewport(), and scrollTo().

int dw::fltk::FltkViewport::scrollDY [private]

Referenced by draw(), FltkViewport(), and scrollTo().

int dw::fltk::FltkViewport::scrollX [private]

Referenced by adjustScrollbarValues(), FltkViewport(), hscrollbarChanged(), scroll(), scrollTo(), setViewportSize(), translateCanvasXToViewX(), and translateViewXToCanvasX().

int dw::fltk::FltkViewport::scrollY [private]

Referenced by adjustScrollbarValues(), FltkViewport(), scroll(), scrollTo(), setViewportSize(), translateCanvasYToViewY(), translateViewYToCanvasY(), and vscrollbarChanged().

int dw::fltk::FltkViewport::verScrolling [private]

Referenced by FltkViewport(), and handle().

Fl_Scrollbar* dw::fltk::FltkViewport::vscrollbar [private]

Referenced by adjustScrollbarsAndGadgetsAllocation(), adjustScrollbarValues(), draw(), FltkViewport(), handle(), scroll(), scrollTo(), setScrollStep(), setViewportSize(), updateCanvasWidgets(), and vscrollbarChanged().

---

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

• dw/fltkviewport.hh
• dw/fltkviewport.cc