UPane Class Reference

Pane gadget (for making Viewports, Cardboxes, Transparent layers). More...

#include <upane.hpp>

Inheritance diagram for UPane:

List of all members.

Public Member Functions
	UPane (const UArgs &a=UArgs::none)
	constructor: see shortcut creator upane() and UGroup::~UGroup()
virtual	~UPane ()
virtual const UStyle &	getStyle (UContext *) const
float	getXScroll ()
float	getYScroll ()
	returns the current scroll values (float values between 0 and 100).
void	setXScroll (float _xscroll)
void	setYScroll (float _yscroll)
void	setScroll (float xscroll, float yscroll)
	scrolls the pane (and the associated scrollbars when applicable) float values are between 0 and 100.
void	scrollImpl (float new_xscroll, float new_yscroll, bool upd_x, bool upd_y, bool update_pane)
	[impl] does not update the associated scrollbars.
UBox *	getViewport ()
	returns the current Viewport (if any; null otherwise)
UView *	getViewportView (UView *pane_view)
	returns the corresponding Viewport View
UScrollbar *	getVScrollbar ()
UScrollbar *	getHScrollbar ()
	return the Vertical and Horizontal Scrollbars (if any; null otherwise)
Static Public Member Functions
static const UStyle &	makeStyle ()
Static Public Attributes
static UStyle *	style = null
Friends
UPane &	upane (const UArgs &a=UArgs::none)
	shortcut creator: creates a new UPane

---

Detailed Description

Pane gadget (for making Viewports, Cardboxes, Transparent layers).

There are 5 ways of using UPanes:

• as a Wiewport: the pane must have only one UBox child. setScroll(), setXScroll(), setYScroll() are then used to control which part of the child is visible.

• as a Scrollpane: by using subclass UScrollpane or by adding UScrollbars to this UPane

• as a Cardbox: when several UBox children are added to the Pane they are superimposed and have the same size (which is the largest size of all children)

• as a Cardbox with transparent layers: by making all chidren transparent or transluscent except the first one

• as a Wiewport/Scrollpane that is also a Cardbox: by adding several children to the pane and using the setScroll() methods or the associated scrollbars (the same children parts will be visible)

---

Constructor & Destructor Documentation

UPane::~UPane (   )  [virtual]

!Att: scrollbar pas forcement enfnats du Pane !

---

Member Function Documentation

UBox * UPane::getViewport (   )

returns the current Viewport (if any; null otherwise) The viewport is the scrolled box in the center area.

UView * UPane::getViewportView (  UView *  pane_view  )

returns the corresponding Viewport View Returns the UView of the current Viewport that is contained in Pen view that is given as an argument

---

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

• upane.hpp
• uupane.cpp

---