dw::fltk::FltkViewport Class Reference

#include <fltkviewport.hh>

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)
Public Member Functions inherited from dw::fltk::FltkWidgetView
	FltkWidgetView (int x, int y, int w, int h, const char *label=0)
	~FltkWidgetView ()
void	drawText (core::style::Font *font, core::style::Color *color, core::style::Color::Shading shading, int x, int y, const char *text, int len)
void	drawSimpleWrappedText (core::style::Font *font, core::style::Color *color, core::style::Color::Shading shading, int x, int y, int w, int h, const char *text)
void	drawImage (core::Imgbuf *imgbuf, int xRoot, int yRoot, int x, int y, int width, int height)
bool	usesFltkWidgets ()
void	addFltkWidget (Fl_Widget *widget, core::Allocation *allocation)
void	removeFltkWidget (Fl_Widget *widget)
void	allocateFltkWidget (Fl_Widget *widget, core::Allocation *allocation)
void	drawFltkWidget (Fl_Widget *widget, core::Rectangle *area)
Public Member Functions inherited from dw::fltk::FltkViewBase
	FltkViewBase (int x, int y, int w, int h, const char *label=0)
	~FltkViewBase ()
void	draw ()
int	handle (int event)
void	setLayout (core::Layout *layout)
	This methods notifies the view, that it has been attached to a layout.
void	setCursor (core::style::Cursor cursor)
	Set the cursor appearance.
void	setBgColor (core::style::Color *color)
	Set the background of the view.
void	startDrawing (core::Rectangle *area)
	Called before drawing.
void	finishDrawing (core::Rectangle *area)
	Called after drawing.
void	queueDraw (core::Rectangle *area)
	Queue a region, which is given in canvas coordinates, for drawing.
void	queueDrawTotal ()
	Queue the total viewport for drawing.
void	cancelQueueDraw ()
	Cancel a draw queue request.
void	drawPoint (core::style::Color *color, core::style::Color::Shading shading, int x, int y)
void	drawLine (core::style::Color *color, core::style::Color::Shading shading, int x1, int y1, int x2, int y2)
void	drawTypedLine (core::style::Color *color, core::style::Color::Shading shading, core::style::LineType type, int width, int x1, int y1, int x2, int y2)
void	drawRectangle (core::style::Color *color, core::style::Color::Shading shading, bool filled, int x, int y, int width, int height)
void	drawArc (core::style::Color *color, core::style::Color::Shading shading, bool filled, int centerX, int centerY, int width, int height, int angle1, int angle2)
void	drawPolygon (core::style::Color *color, core::style::Color::Shading shading, bool filled, bool convex, core::Point *points, int npoints)
core::View *	getClippingView (int x, int y, int width, int height)
void	mergeClippingView (core::View *clippingView)
void	setBufferedDrawing (bool b)
Public Member Functions inherited from lout::object::Object
virtual	~Object ()
	The destructor is defined as virtual (but not abstract), so that destruction of Object's works properly.
virtual bool	equals (Object *other)
	Returns, whether two objects are equal.
virtual int	hashValue ()
	Return a hash value for the object.
virtual Object *	clone ()
	Return an exact copy of the object.
virtual void	intoStringBuffer (misc::StringBuffer *sb)
	Store a textual representation of the object in a misc::StringBuffer.
const char *	toString ()
	Use object::Object::intoStringBuffer to return a textual representation of the object.
virtual size_t	sizeOf ()
	Return the number of bytes, this object totally uses.

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	selectionScroll ()
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	selectionScroll (void *vport)
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

Additional Inherited Members
Protected Attributes inherited from dw::fltk::FltkViewBase
core::Layout *	theLayout
int	canvasWidth
int	canvasHeight
int	mouse_x
int	mouse_y
Fl_Widget *	focused_child

Detailed Description

Definition at line 14 of file fltkviewport.hh.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
SCROLLBAR_THICKNESS

Definition at line 20 of file fltkviewport.hh.

GadgetOrientation

enum dw::fltk::FltkViewport::GadgetOrientation

Enumerator
GADGET_VERTICAL
GADGET_HORIZONTAL

Definition at line 17 of file fltkviewport.hh.

Constructor & Destructor Documentation

FltkViewport()

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

Definition at line 54 of file fltkviewport.cc.

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

~FltkViewport()

dw::fltk::FltkViewport::~FltkViewport

(

)

Definition at line 85 of file fltkviewport.cc.

References DBG_OBJ_DELETE, and gadgets.

Member Function Documentation

addGadget()

void dw::fltk::FltkViewport::addGadget

(

Fl_Widget *

gadget

)

Bug:

Reparent?

Definition at line 552 of file fltkviewport.cc.

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

adjustScrollbarsAndGadgetsAllocation()

void dw::fltk::FltkViewport::adjustScrollbarsAndGadgetsAllocation ( )

private

Definition at line 91 of file fltkviewport.cc.

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

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

adjustScrollbarValues()

void dw::fltk::FltkViewport::adjustScrollbarValues ( )

private

Definition at line 146 of file fltkviewport.cc.

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

Referenced by scrollTo(), and setCanvasSize().

draw()

void dw::fltk::FltkViewport::draw

(

)

Definition at line 208 of file fltkviewport.cc.

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

Referenced by draw().

draw_area()

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

staticprivate

Definition at line 185 of file fltkviewport.cc.

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

Referenced by draw().

getHScrollbarThickness()

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.

Definition at line 384 of file fltkviewport.cc.

References SCROLLBAR_THICKNESS.

getVScrollbarThickness()

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.

Definition at line 389 of file fltkviewport.cc.

References SCROLLBAR_THICKNESS.

handle()

int dw::fltk::FltkViewport::handle

(

int

event

)

Bug:

Draw focus box.

Bug:

Undraw focus box.

Definition at line 243 of file fltkviewport.cc.

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

Referenced by handle().

hscrollbarCallback()

void dw::fltk::FltkViewport::hscrollbarCallback ( Fl_Widget *  hscrollbar, void *  viewportPtr  )

staticprivate

Definition at line 167 of file fltkviewport.cc.

Referenced by FltkViewport().

hscrollbarChanged()

void dw::fltk::FltkViewport::hscrollbarChanged ( )

private

Definition at line 152 of file fltkviewport.cc.

References hscrollbar, scroll(), and scrollX.

positionChanged()

void dw::fltk::FltkViewport::positionChanged ( )

private

Definition at line 359 of file fltkviewport.cc.

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().

resize()

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

Definition at line 174 of file fltkviewport.cc.

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

scroll() [1/2]

void dw::fltk::FltkViewport::scroll ( dw::core::ScrollCommand  )

virtual

Scroll the viewport as commanded.

Reimplemented from dw::core::View.

Definition at line 430 of file fltkviewport.cc.

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_LEFT_CMD, dw::core::SCREEN_RIGHT_CMD, dw::core::SCREEN_UP_CMD, scroll(), scrollTo(), scrollX, dw::core::TOP_CMD, and vscrollbar.

scroll() [2/2]

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

Definition at line 425 of file fltkviewport.cc.

References scrollTo(), scrollX, and scrollY.

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

scrollTo()

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.

Definition at line 394 of file fltkviewport.cc.

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(), and scroll().

selectionScroll() [1/2]

void dw::fltk::FltkViewport::selectionScroll ( )

private

Definition at line 458 of file fltkviewport.cc.

References hscrollbar, dw::fltk::FltkViewBase::mouse_x, dw::fltk::FltkViewBase::mouse_y, scroll(), and vscrollbar.

Referenced by handle(), and selectionScroll().

selectionScroll() [2/2]

void dw::fltk::FltkViewport::selectionScroll ( void *  vport )

staticprivate

Definition at line 475 of file fltkviewport.cc.

References selectionScroll().

setCanvasSize()

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

virtual

Set the canvas size.

Reimplemented from dw::fltk::FltkViewBase.

Definition at line 350 of file fltkviewport.cc.

References adjustScrollbarValues(), and dw::fltk::FltkViewBase::setCanvasSize().

setDragScroll()

void dw::fltk::FltkViewport::setDragScroll ( bool  enable )

inline

Definition at line 76 of file fltkviewport.hh.

References hasDragScroll.

Referenced by UIcmd_tab_new().

setGadgetOrientation()

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

Definition at line 542 of file fltkviewport.cc.

References adjustScrollbarsAndGadgetsAllocation(), and gadgetOrientation.

setScrollStep()

void dw::fltk::FltkViewport::setScrollStep

(

int

step

)

Definition at line 373 of file fltkviewport.cc.

References hscrollbar, and vscrollbar.

Referenced by UIcmd_tab_new().

setViewportSize()

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.

Definition at line 481 of file fltkviewport.cc.

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

translateCanvasXToViewX()

int dw::fltk::FltkViewport::translateCanvasXToViewX ( int  x )

protectedvirtual

Implements dw::fltk::FltkViewBase.

Definition at line 530 of file fltkviewport.cc.

References scrollX.

translateCanvasYToViewY()

int dw::fltk::FltkViewport::translateCanvasYToViewY ( int  y )

protectedvirtual

Implements dw::fltk::FltkViewBase.

Definition at line 535 of file fltkviewport.cc.

References scrollY.

translateViewXToCanvasX()

int dw::fltk::FltkViewport::translateViewXToCanvasX ( int  x )

protectedvirtual

Implements dw::fltk::FltkViewBase.

Definition at line 520 of file fltkviewport.cc.

References scrollX.

Referenced by positionChanged().

translateViewYToCanvasY()

int dw::fltk::FltkViewport::translateViewYToCanvasY ( int  y )

protectedvirtual

Implements dw::fltk::FltkViewBase.

Definition at line 525 of file fltkviewport.cc.

References scrollY.

Referenced by positionChanged().

updateCanvasWidgets()

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

private

Definition at line 507 of file fltkviewport.cc.

References hscrollbar, and vscrollbar.

Referenced by scrollTo().

usesViewport()

bool dw::fltk::FltkViewport::usesViewport ( )

virtual

Return, whether this view uses a viewport.

Implements dw::core::View.

Definition at line 379 of file fltkviewport.cc.

vscrollbarCallback()

void dw::fltk::FltkViewport::vscrollbarCallback ( Fl_Widget *  vscrollbar, void *  viewportPtr  )

staticprivate

Definition at line 162 of file fltkviewport.cc.

Referenced by FltkViewport().

vscrollbarChanged()

void dw::fltk::FltkViewport::vscrollbarChanged ( )

private

Definition at line 157 of file fltkviewport.cc.

References scroll(), scrollY, and vscrollbar.

Member Data Documentation

dragScrolling

int dw::fltk::FltkViewport::dragScrolling

private

Definition at line 24 of file fltkviewport.hh.

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

dragX

int dw::fltk::FltkViewport::dragX

private

Definition at line 24 of file fltkviewport.hh.

Referenced by handle().

dragY

int dw::fltk::FltkViewport::dragY

private

Definition at line 24 of file fltkviewport.hh.

Referenced by handle().

gadgetOrientation

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

private

Definition at line 29 of file fltkviewport.hh.

Referenced by adjustScrollbarsAndGadgetsAllocation(), FltkViewport(), and setGadgetOrientation().

gadgets

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

private

Definition at line 31 of file fltkviewport.hh.

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

hasDragScroll

int dw::fltk::FltkViewport::hasDragScroll

private

Definition at line 24 of file fltkviewport.hh.

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

horScrolling

int dw::fltk::FltkViewport::horScrolling

private

Definition at line 25 of file fltkviewport.hh.

Referenced by FltkViewport(), and handle().

hscrollbar

Fl_Scrollbar * dw::fltk::FltkViewport::hscrollbar

private

Definition at line 27 of file fltkviewport.hh.

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

scrollDX

int dw::fltk::FltkViewport::scrollDX

private

Definition at line 23 of file fltkviewport.hh.

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

scrollDY

int dw::fltk::FltkViewport::scrollDY

private

Definition at line 23 of file fltkviewport.hh.

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

scrollX

int dw::fltk::FltkViewport::scrollX

private

Definition at line 22 of file fltkviewport.hh.

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

scrollY

int dw::fltk::FltkViewport::scrollY

private

Definition at line 22 of file fltkviewport.hh.

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

verScrolling

int dw::fltk::FltkViewport::verScrolling

private

Definition at line 25 of file fltkviewport.hh.

Referenced by FltkViewport(), and handle().

vscrollbar

Fl_Scrollbar* dw::fltk::FltkViewport::vscrollbar

private

Definition at line 27 of file fltkviewport.hh.

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

---

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

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