Faith::ScrollView Class Reference

#include <faith/scrollview.h>

Inheritance diagram for Faith::ScrollView:

List of all members.

Public Slots
void	scrollTo (const Faith::Point &pt)
void	scrollTo (int x, int y)
void	ensureVisible (const Faith::Point &pt)
void	ensureVisible (int x, int y)
Signals
void	scrolledTo (int x, int y)
void	scrolledTo (const Faith::Point &pt)
Public Member Functions
	ScrollView (Widget *parent, const char *name=0)
	~ScrollView ()
ScrollBar *	horizontalScrollBar ()
ScrollBar *	verticalScrollBar ()
Widget *	cornerWidget ()
Widget *	contents ()
Widget *	clipper ()
Faith::Size	contentsSize () const
Faith::Size	viewportSize () const
void	setContentsSize (const Faith::Size &size)
void	setContentsSize (int w, int h)
Faith::Point	contentsLocation () const
Protected Member Functions
void	resizeEvent (Faith::ResizeEvent *e)
void	paintEvent (Faith::PaintEvent *e)
virtual void	contentsMousePressEvent (Faith::MouseEvent *)
virtual void	contentsMouseReleaseEvent (Faith::MouseEvent *)
virtual void	contentsMouseMoveEvent (Faith::MouseEvent *)
virtual void	contentsKeyPressEvent (Faith::KeyPressEvent *)
virtual void	contentsPaintEvent (Faith::PaintEvent *)
virtual void	contentsFocusInEvent (Faith::FocusEvent *)
virtual void	contentsFocusOutEvent (Faith::FocusEvent *)
virtual void	contentsEnterEvent (Faith::Event *)
virtual void	contentsLeaveEvent (Faith::Event *)
virtual void	viewportEnterEvent (Faith::Event *)
virtual void	viewportLeaveEvent (Faith::Event *)
virtual void	viewportResizeEvent (Faith::ResizeEvent *)

---

Constructor & Destructor Documentation

Faith::ScrollView::ScrollView	(	Widget *	parent,
		const char *	name = 0
	)

Faith::ScrollView::~ScrollView

(

)

---

Member Function Documentation

Widget* Faith::ScrollView::clipper

(

)

This is the widget that actually lives here, and moves the contents widget around such that scrolling occurs

Widget* Faith::ScrollView::contents

(

)

the widget that contains the contents

Things that are scrolled are children of this

virtual void Faith::ScrollView::contentsEnterEvent

(

Faith::Event *

)

[inline, protected, virtual]

virtual void Faith::ScrollView::contentsFocusInEvent

(

Faith::FocusEvent *

)

[inline, protected, virtual]

virtual void Faith::ScrollView::contentsFocusOutEvent

(

Faith::FocusEvent *

)

[inline, protected, virtual]

virtual void Faith::ScrollView::contentsKeyPressEvent

(

Faith::KeyPressEvent *

)

[inline, protected, virtual]

Reimplemented in Faith::GListView.

virtual void Faith::ScrollView::contentsLeaveEvent

(

Faith::Event *

)

[inline, protected, virtual]

Faith::Point Faith::ScrollView::contentsLocation

(

)

const

Returns:

the location you have scrolledTo()

virtual void Faith::ScrollView::contentsMouseMoveEvent

(

Faith::MouseEvent *

)

[inline, protected, virtual]

virtual void Faith::ScrollView::contentsMousePressEvent

(

Faith::MouseEvent *

)

[inline, protected, virtual]

Reimplemented in Faith::GListView.

virtual void Faith::ScrollView::contentsMouseReleaseEvent

(

Faith::MouseEvent *

)

[inline, protected, virtual]

virtual void Faith::ScrollView::contentsPaintEvent

(

Faith::PaintEvent *

)

[inline, protected, virtual]

Reimplemented in Faith::GListView.

Faith::Size Faith::ScrollView::contentsSize

(

)

const

returns the extents that you may scroll to in pixels relative to the contents of the viewport

You can modify it with setSize

Widget* Faith::ScrollView::cornerWidget

(

)

The little empty space that goes in the gap between the scrollbars

void Faith::ScrollView::ensureVisible	(	int	x,
		int	y
	)			[inline, slot]

void Faith::ScrollView::ensureVisible

(

const Faith::Point &

pt

)

[slot]

Scrolls as little as possible to make the given point visible

will emit scrolledTo if necessary

ScrollBar* Faith::ScrollView::horizontalScrollBar

(

)

void Faith::ScrollView::paintEvent

(

Faith::PaintEvent *

e

)

[protected, virtual]

Reimplemented from Faith::Widget.

void Faith::ScrollView::resizeEvent

(

Faith::ResizeEvent *

e

)

[protected, virtual]

Reimplemented from Faith::Widget.

void Faith::ScrollView::scrolledTo

(

const Faith::Point &

pt

)

[signal]

emitted when you scroll somewhere, the parameter is the pixel location of the top-left

void Faith::ScrollView::scrolledTo	(	int	x,
		int	y
	)			[signal]

emitted when you scroll somewhere, the parameters are the pixel location of the top-left

void Faith::ScrollView::scrollTo	(	int	x,
		int	y
	)			[inline, slot]

void Faith::ScrollView::scrollTo

(

const Faith::Point &

pt

)

[slot]

try to make the given Point at the top-left of the viewport. If I cannot scroll that far, then I'll get as close as I can to it

will emit scrolledTo if necessary

void Faith::ScrollView::setContentsSize	(	int	w,
		int	h
	)			[inline]

void Faith::ScrollView::setContentsSize

(

const Faith::Size &

size

)

ScrollBar* Faith::ScrollView::verticalScrollBar

(

)

virtual void Faith::ScrollView::viewportEnterEvent

(

Faith::Event *

)

[inline, protected, virtual]

virtual void Faith::ScrollView::viewportLeaveEvent

(

Faith::Event *

)

[inline, protected, virtual]

virtual void Faith::ScrollView::viewportResizeEvent

(

Faith::ResizeEvent *

)

[inline, protected, virtual]

Faith::Size Faith::ScrollView::viewportSize

(

)

const

Returns:

the size of the viewport (the same as the size of the clipper)

---

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

• faithui/faith/scrollview.h

---