Client-side interface to a PixInsight ScrollBox control. More...

#include <ScrollBox.h>

Inheritance diagram for pcl::ScrollBox:

Public Types
using	pos_event_handler = void(Control::*)(ScrollBox &sender, int pos)

using	range_event_handler = void(Control::*)(ScrollBox &sender, int minValue, int maxValue)

Public Types inherited from pcl::Frame
using	style = FrameStyle::value_type

Public Types inherited from pcl::Control
using	child_event_handler = void(Control::*)(Control &sender, Control &child)

using	close_event_handler = void(Control::*)(Control &sender, bool &allowClose)

using	event_handler = void(Control::*)(Control &sender)

using	file_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers, bool &wantsFiles)

using	file_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers)

using	keyboard_event_handler = void(Control::*)(Control &sender, int key, unsigned modifiers, bool &wantsKey)

using	mouse_button_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int button, unsigned buttons, unsigned modifiers)

using	mouse_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, unsigned buttons, unsigned modifiers)

using	mouse_wheel_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int delta, unsigned buttons, unsigned modifiers)

using	move_event_handler = void(Control::*)(Control &sender, const pcl::Point &newPos, const pcl::Point &oldPos)

using	paint_event_handler = void(Control::*)(Control &sender, const pcl::Rect &updateRect)

using	resize_event_handler = void(Control::*)(Control &sender, int newWidth, int newHeight, int oldWidth, int oldHeight)

using	view_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers, bool &wantsView)

using	view_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers)

Public Member Functions
	ScrollBox (Control &parent=Control::Null())

	~ScrollBox () override

void	DisableAutoScroll (bool disableHorz=true, bool disableVert=true)

void	DisableHorizontalTracking (bool disableHorz=true)

void	DisableTracking (bool disableHorz=true, bool disableVert=true)

void	DisableVerticalTracking (bool disableVert=true)

void	EnableAutoScroll (bool enableHorz=true, bool enableVert=true)

void	EnableHorizontalTracking (bool enableHorz=true)

void	EnableTracking (bool enableHorz=true, bool enableVert=true)

void	EnableVerticalTracking (bool enableVert=true)

void	GetHorizontalScrollRange (int &minPos, int &maxPos) const

void	GetVerticalScrollRange (int &minPos, int &maxPos) const

void	HideHorizontalScrollBar (bool hide=true)

void	HideScrollBars (bool hideHorz=true, bool hideVert=true)

void	HideVerticalScrollBar (bool hide=true)

int	HorizontalScrollPosition () const

bool	IsHorizontalAutoScrollEnabled () const

bool	IsHorizontalScrollBarVisible () const

bool	IsHorizontalTrackingEnabled () const

bool	IsVerticalAutoScrollEnabled () const

bool	IsVerticalScrollBarVisible () const

bool	IsVerticalTrackingEnabled () const

int	LineHeight () const

int	LineWidth () const

int	MaxHorizontalScrollPosition () const

int	MaxVerticalScrollPosition () const

int	MinHorizontalScrollPosition () const

int	MinVerticalScrollPosition () const

void	OnHorizontalScrollPosUpdated (pos_event_handler handler, Control &receiver)

void	OnHorizontalScrollRangeUpdated (range_event_handler handler, Control &receiver)

void	OnVerticalScrollPosUpdated (pos_event_handler handler, Control &receiver)

void	OnVerticalScrollRangeUpdated (range_event_handler handler, Control &receiver)

int	PageHeight () const

int	PageWidth () const

pcl::Point	ScrollPosition () const

void	SetHorizontalScrollPosition (int horzPos)

void	SetHorizontalScrollRange (int minPos, int maxPos)

void	SetLineHeight (int height)

void	SetLineSize (int width, int height)

void	SetLineWidth (int width)

void	SetPageHeight (int height)

void	SetPageSize (int width, int height)

void	SetPageWidth (int width)

void	SetScrollPosition (const pcl::Point &pos)

void	SetScrollPosition (int horzPos, int vertPos)

void	SetVerticalScrollPosition (int vertPos)

void	SetVerticalScrollRange (int minPos, int maxPos)

void	ShowHorizontalScrollBar (bool show=true)

void	ShowScrollBars (bool showHorz=true, bool showVert=true)

void	ShowVerticalScrollBar (bool show=true)

int	VerticalScrollPosition () const

Control &	Viewport ()

const Control &	Viewport () const

Public Member Functions inherited from pcl::Frame
	Frame (Control &parent=Control::Null())

	~Frame () override

int	BorderWidth () const

int	LineWidth () const

int	ScaledBorderWidth () const

int	ScaledLineWidth () const

void	SetLineWidth (int)

void	SetScaledLineWidth (int width)

void	SetStyle (style)

style	Style () const

Public Member Functions inherited from pcl::Control
	Control (const Control &)=delete

	Control (Control &&)=delete

	Control (Control &parent=Null(), uint32=0)

	~Control () override

void	ActivateRealTimePreview ()

void	ActivateTrackView ()

void	ActivateWindow ()

void	AdjustToContents ()

RGBA	AlternateCanvasColor () const

RGBA	BackgroundColor () const

pcl::Rect	BoundsRect () const

void	BringToFront ()

RGBA	ButtonColor () const

RGBA	ButtonTextColor () const

bool	CanUpdate () const

RGBA	CanvasColor ()

Control &	ChildByPos (const pcl::Point &p) const

Control &	ChildByPos (int x, int y) const

pcl::Rect	ChildrenRect () const

Control &	ChildToFocus () const

void	ClearInfoText ()

int	ClientHeight () const

pcl::Rect	ClientRect () const

int	ClientWidth () const

void	ControlToLocal (const Control &, int &x, int &y) const

pcl::Point	ControlToLocal (const Control &w, const pcl::Point &p) const

pcl::Cursor	Cursor () const

void	DeactivateRealTimePreview ()

void	DeactivateTrackView ()

void	Disable (bool disabled=true)

void	DisableExpansion (bool horzDisable=true, bool vertDisable=true)

void	DisableMouseTracking (bool disable=true)

void	DisableUpdates (bool disable=true)

double	DisplayPixelRatio () const

virtual void	Enable (bool enabled=true)

void	EnableExpansion (bool horzEnable=true, bool vertEnable=true)

void	EnableMouseTracking (bool=true)

void	EnableUpdates (bool enable=true)

void	EnsureLayoutUpdated ()

void	EnsureUnique () override

void	Focus (bool focus=true)

Control &	FocusedChild () const

FocusStyles	FocusStyle () const

pcl::Font	Font () const

RGBA	ForegroundColor () const

int	FrameHeight () const

pcl::Rect	FrameRect () const

int	FrameWidth () const

pcl::Cursor	GetCursor () const

pcl::Font	GetFont () const

void	GetMaxSize (int &w, int &h) const

void	GetMinSize (int &w, int &h) const

void	GetScaledMaxSize (int &w, int &h) const

void	GetScaledMinSize (int &w, int &h) const

pcl::Sizer	GetSizer () const

pcl::Point	GlobalToLocal (const pcl::Point &p) const

void	GlobalToLocal (int &x, int &y) const

int	Height () const

void	Hide ()

RGBA	HighlightColor () const

RGBA	HighlightedTextColor () const

String	InfoText () const

bool	IsActiveWindow () const

bool	IsAncestorOf (const Control &) const

virtual bool	IsEnabled () const

bool	IsFixedHeight () const

bool	IsFixedWidth () const

bool	IsFocused () const

bool	IsHidden () const

bool	IsHorizontalExpansionEnabled () const

bool	IsMaximized () const

bool	IsMinimized () const

bool	IsModal () const

bool	IsMouseTrackingEnabled () const

bool	IsRealTimePreviewActive () const

bool	IsTrackViewActive () const

bool	IsUnderMouse () const

bool	IsVerticalExpansionEnabled () const

bool	IsVisible () const

bool	IsWindow () const

void	LocalToControl (const Control &, int &x, int &y) const

pcl::Point	LocalToControl (const Control &w, const pcl::Point &p) const

pcl::Point	LocalToGlobal (const pcl::Point &p) const

void	LocalToGlobal (int &x, int &y) const

pcl::Point	LocalToParent (const pcl::Point &p) const

void	LocalToParent (int &x, int &y) const

int	LogicalPixelsToPhysical (int size) const

int	LogicalPixelsToResource (int size) const

int	MaxHeight () const

int	MaxWidth () const

int	MinHeight () const

int	MinWidth () const

void	Move (const pcl::Point &p)

void	Move (int x, int y)

Control &	NextSiblingToFocus () const

void	OnChildCreate (child_event_handler, Control &)

void	OnChildDestroy (child_event_handler, Control &)

void	OnClose (close_event_handler, Control &)

void	OnDestroy (event_handler, Control &)

void	OnEnter (event_handler, Control &)

void	OnFileDrag (file_drag_event_handler, Control &)

void	OnFileDrop (file_drop_event_handler, Control &)

void	OnGetFocus (event_handler, Control &)

void	OnHide (event_handler, Control &)

void	OnKeyPress (keyboard_event_handler, Control &)

void	OnKeyRelease (keyboard_event_handler, Control &)

void	OnLeave (event_handler, Control &)

void	OnLoseFocus (event_handler, Control &)

void	OnMouseDoubleClick (mouse_event_handler, Control &)

void	OnMouseMove (mouse_event_handler, Control &)

void	OnMousePress (mouse_button_event_handler, Control &)

void	OnMouseRelease (mouse_button_event_handler, Control &)

void	OnMouseWheel (mouse_wheel_event_handler, Control &)

void	OnMove (move_event_handler, Control &)

void	OnPaint (paint_event_handler, Control &)

void	OnResize (resize_event_handler, Control &)

void	OnShow (event_handler, Control &)

void	OnViewDrag (view_drag_event_handler, Control &)

void	OnViewDrop (view_drop_event_handler, Control &)

Control &	operator= (const Control &)=delete

Control &	operator= (Control &&)=delete

Control &	Parent () const

pcl::Point	ParentToLocal (const pcl::Point &p) const

void	ParentToLocal (int &x, int &y) const

int	PhysicalPixelsToLogical (int size) const

pcl::Point	Position () const

void	Repaint ()

void	Repaint (const pcl::Rect &r)

void	Repaint (int x0, int y0, int x1, int y1)

void	Resize (int w, int h)

double	ResourcePixelRatio () const

int	ResourcePixelsToLogical (int size) const

void	Restyle ()

Point	ScaledCursorHotSpot (const Point &hotSpot) const

Point	ScaledCursorHotSpot (int xHot, int yHot) const

int	ScaledMaxHeight () const

int	ScaledMaxWidth () const

int	ScaledMinHeight () const

int	ScaledMinWidth () const

template<class R >
String	ScaledResource (R resource) const

template<class S >
String	ScaledStyleSheet (S cssCode, int fontDPI=0) const

void	Scroll (const pcl::Point &d)

void	Scroll (const pcl::Point &d, const pcl::Rect &r)

void	Scroll (int dx, int dy)

void	Scroll (int dx, int dy, int x0, int y0, int x1, int y1)

void	SendToBack ()

void	SetAlternateCanvasColor (RGBA)

void	SetBackgroundColor (RGBA)

void	SetButtonColor (RGBA)

void	SetButtonTextColor (RGBA)

void	SetCanvasColor (RGBA)

void	SetChildToFocus (Control &)

void	SetClientRect (const pcl::Rect &r)

void	SetClientRect (int x0, int y0, int x1, int y1)

void	SetCursor (const pcl::Cursor &)

void	SetCursorToParent ()

void	SetFixedHeight ()

void	SetFixedHeight (int h)

void	SetFixedSize ()

void	SetFixedSize (int w, int h)

void	SetFixedWidth ()

void	SetFixedWidth (int w)

void	SetFocusStyle (FocusStyles)

void	SetFont (const pcl::Font &)

void	SetForegroundColor (RGBA)

void	SetHighlightColor (RGBA)

void	SetHighlightedTextColor (RGBA)

void	SetInfoText (const String &)

void	SetMaxHeight ()

void	SetMaxHeight (int h)

void	SetMaxSize ()

void	SetMaxSize (int w, int h)

void	SetMaxWidth ()

void	SetMaxWidth (int w)

void	SetMinHeight ()

void	SetMinHeight (int h)

void	SetMinSize ()

void	SetMinSize (int w, int h)

void	SetMinWidth ()

void	SetMinWidth (int w)

void	SetNextSiblingToFocus (Control &)

void	SetParent (Control &)

void	SetRealTimePreviewActive (bool=true)

void	SetScaledFixedHeight (int h)

void	SetScaledFixedSize (int w, int h)

void	SetScaledFixedWidth (int w)

void	SetScaledMaxHeight (int h)

void	SetScaledMaxSize (int w, int h)

void	SetScaledMaxWidth (int w)

void	SetScaledMinHeight (int h)

void	SetScaledMinSize (int w, int h)

void	SetScaledMinWidth (int w)

void	SetSizer (pcl::Sizer &)

void	SetStyleSheet (const String &css)

void	SetTextColor (RGBA)

void	SetToolTip (const String &)

void	SetTrackViewActive (bool=true)

void	SetVariableHeight ()

void	SetVariableSize ()

void	SetVariableWidth ()

void	SetVisible (bool visible)

void	SetWindowOpacity (double)

void	SetWindowTitle (const String &)

void	Show ()

pcl::Sizer	Sizer () const

void	StackUnder (Control &)

String	StyleSheet () const

RGBA	TextColor () const

String	ToolTip () const

void	Unfocus ()

void	Update ()

void	Update (const pcl::Rect &r)

void	Update (int x0, int y0, int x1, int y1)

pcl::Rect	VisibleRect () const

int	Width () const

Control &	Window () const

double	WindowOpacity () const

String	WindowTitle () const

int	X () const

int	Y () const

Public Member Functions inherited from pcl::UIObject
virtual	~UIObject () noexcept(false)

bool	IsAlias () const

bool	IsGarbage () const

bool	IsNull () const

bool	IsSameObject (const UIObject &o) const

bool	IsUnique () const

String	ObjectId () const

IsoString	ObjectType () const

bool	operator< (const UIObject &o) const

bool	operator== (const UIObject &o) const

size_type	RefCount () const

void	SetObjectId (const String &id)

Additional Inherited Members
Static Public Member Functions inherited from pcl::Control
static void	HideToolTip ()

static Control &	Null ()

static void	ShowToolTip (const Point &pos, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0))

static void	ShowToolTip (int x, int y, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0))

static String	ToolTipText ()

Static Public Member Functions inherited from pcl::UIObject
static UIObject &	Null ()

Protected Member Functions inherited from pcl::UIObject
	UIObject ()=default

	UIObject (const UIObject &x)

	UIObject (UIObject &&x)

UIObject &	operator= (const UIObject &x)

UIObject &	operator= (UIObject &&x)

Detailed Description

TODO: Write a detailed description for ScrollBox.

Definition at line 75 of file ScrollBox.h.

Constructor & Destructor Documentation

◆ ScrollBox()

pcl::ScrollBox::ScrollBox ( Control & parent = Control::Null() )

Constructs a ScrollBox as a child control of parent.

◆ ~ScrollBox()

pcl::ScrollBox::~ScrollBox ( )

inlineoverride

Destroys a ScrollBox control.

Definition at line 87 of file ScrollBox.h.

Member Function Documentation

◆ DisableAutoScroll()

void pcl::ScrollBox::DisableAutoScroll	(	bool	disableHorz = `true`,
		bool	disableVert = `true`
	)

inline

Disables the automatic scroll mode.

This is a convenience member function, equivalent to EnableAutoScroll( !disableHorz, !disableVert )

Definition at line 204 of file ScrollBox.h.

◆ DisableHorizontalTracking()

void pcl::ScrollBox::DisableHorizontalTracking ( bool disableHorz = true )

inline

Disables or enables the automatic tracking mode for the horizontal scroll bar of this box control control.

This is a convenience member function, equivalent to EnableTracking( !disableHorz, IsVerticalTrackingEnabled() )

Definition at line 490 of file ScrollBox.h.

◆ DisableTracking()

void pcl::ScrollBox::DisableTracking	(	bool	disableHorz = `true`,
		bool	disableVert = `true`
	)

inline

Disables or enables the automatic tracking mode for this scroll box control.

This is a convenience member function, equivalent to EnableTracking( !disableHorz, !disableVert )

Definition at line 478 of file ScrollBox.h.

◆ DisableVerticalTracking()

void pcl::ScrollBox::DisableVerticalTracking ( bool disableVert = true )

inline

Disables or enables the automatic tracking mode for the vertical scroll bar of this box control control.

This is a convenience member function, equivalent to EnableTracking( IsHorizontalTrackingEnabled(), !disableVert )

Definition at line 502 of file ScrollBox.h.

◆ EnableAutoScroll()

void pcl::ScrollBox::EnableAutoScroll	(	bool	enableHorz = `true`,
		bool	enableVert = `true`
	)

Enables the automatic scroll mode.

Parameters

enableHorz	New enabled state for the horizontal scroll bar.
enableVert	New enabled state for the vertical scroll bar.

In automatic scroll mode, scroll bars are automatically shown or hidden as necessary. A scroll bar is shown only if the corresponding scrolling range is larger than the visible length of the scrolling area.

◆ EnableHorizontalTracking()

void pcl::ScrollBox::EnableHorizontalTracking ( bool enableHorz = true )

inline

Enables or disables the automatic tracking mode for the horizontal scroll bar of this box control control.

This is a convenience member function, equivalent to EnableTracking( enableHorz, IsVerticalTrackingEnabled() )

Definition at line 454 of file ScrollBox.h.

◆ EnableTracking()

void pcl::ScrollBox::EnableTracking	(	bool	enableHorz = `true`,
		bool	enableVert = `true`
	)

Enables or disables the automatic tracking mode for this scroll box control.

Parameters

enableHorz	New state of automatic tracking mode for the horizontal scroll bar.
enableVert	New state of automatic tracking mode for the vertical scroll bar.

When automatic tracking is enabled, the viewport receives continuous update requests while the user is moving an scroll bar with the mouse. When automatic tracking is disabled, the viewport is updated only when the mouse is released.

◆ EnableVerticalTracking()

void pcl::ScrollBox::EnableVerticalTracking ( bool enableVert = true )

inline

Enables or disables the automatic tracking mode for the vertical scroll bar of this box control control.

This is a convenience member function, equivalent to EnableTracking( IsHorizontalTrackingEnabled(), enableVert )

Definition at line 466 of file ScrollBox.h.

◆ GetHorizontalScrollRange()

void pcl::ScrollBox::GetHorizontalScrollRange	(	int &	minPos,
		int &	maxPos
	)		const

Gets the current horizontal scroll range.

Parameters

[out]	minPos	Minimum horizontal scrolling position
[out]	maxPos	Maximum horizontal scrolling position

The virtual document width is equal to maxPos - minPos + PageWidth() in scrolling units.

◆ GetVerticalScrollRange()

void pcl::ScrollBox::GetVerticalScrollRange	(	int &	minPos,
		int &	maxPos
	)		const

Gets the current vertical scroll range.

Parameters

[out]	minPos	Minimum vertical scrolling position
[out]	maxPos	Maximum vertical scrolling position

The virtual document height is equal to maxPos - minPos + PageHeight() in scrolling units.

◆ HideHorizontalScrollBar()

void pcl::ScrollBox::HideHorizontalScrollBar ( bool hide = true )

inline

Forces visibility of the horizontal scroll bar.

This is a convenience member function, equivalent to ShowHorizontalScrollBar( !hide )

Definition at line 139 of file ScrollBox.h.

◆ HideScrollBars()

void pcl::ScrollBox::HideScrollBars	(	bool	hideHorz = `true`,
		bool	hideVert = `true`
	)

inline

Forces visibility of scroll bars.

This is a convenience member function, equivalent to ShowScrollBars( !hideHorz, !hideVert )

Definition at line 117 of file ScrollBox.h.

◆ HideVerticalScrollBar()

void pcl::ScrollBox::HideVerticalScrollBar ( bool hide = true )

inline

Forces visibility of the vertical scroll bar.

This is a convenience member function, equivalent to ShowVerticalScrollBar( !hide )

Definition at line 161 of file ScrollBox.h.

◆ HorizontalScrollPosition()

int pcl::ScrollBox::HorizontalScrollPosition ( ) const

inline

Returns the current horizontal scroll position in scrolling units.

Definition at line 375 of file ScrollBox.h.

References pcl::GenericPoint< T >::x.

◆ IsHorizontalAutoScrollEnabled()

bool pcl::ScrollBox::IsHorizontalAutoScrollEnabled ( ) const

Returns true iff the automatic scroll mode is enabled for the horizontal scroll bar.

In automatic scroll mode, scroll bars are automatically shown or hidden as necessary. A scroll bar is shown only if the corresponding scrolling range is larger than the visible length of the scrolling area.

◆ IsHorizontalScrollBarVisible()

bool pcl::ScrollBox::IsHorizontalScrollBarVisible ( ) const

Returns true iff the horizontal scroll bar is currently visible on this scroll box.

◆ IsHorizontalTrackingEnabled()

bool pcl::ScrollBox::IsHorizontalTrackingEnabled ( ) const

Returns true iff the automatic tracking mode is enabled for the horizontal scroll bar of this scroll box control.

◆ IsVerticalAutoScrollEnabled()

bool pcl::ScrollBox::IsVerticalAutoScrollEnabled ( ) const

Returns true iff the automatic scroll mode is enabled for the vertical scroll bar.

In automatic scroll mode, scroll bars are automatically shown or hidden as necessary. A scroll bar is shown only if the corresponding scrolling range is larger than the visible length of the scrolling area.

◆ IsVerticalScrollBarVisible()

bool pcl::ScrollBox::IsVerticalScrollBarVisible ( ) const

Returns true iff the vertical scroll bar is currently visible on this scroll box.

◆ IsVerticalTrackingEnabled()

bool pcl::ScrollBox::IsVerticalTrackingEnabled ( ) const

Returns true iff the automatic tracking mode is enabled for the vertical scroll bar of this scroll box control.

◆ LineHeight()

int pcl::ScrollBox::LineHeight ( ) const

Returns the current line height of this scroll box control.

The line height is the number of scrolling units scrolled when the user clicks on an arrow icon of the vertical scroll bar.

◆ LineWidth()

int pcl::ScrollBox::LineWidth ( ) const

Returns the current line width of this scroll box control.

The line width is the number of scrolling units scrolled when the user clicks on an arrow icon of the horizontal scroll bar.

◆ MaxHorizontalScrollPosition()

int pcl::ScrollBox::MaxHorizontalScrollPosition ( ) const

inline

Returns the maximum horizontal scrolling position.

Definition at line 242 of file ScrollBox.h.

◆ MaxVerticalScrollPosition()

int pcl::ScrollBox::MaxVerticalScrollPosition ( ) const

inline

Returns the maximum horizontal scrolling position.

Definition at line 258 of file ScrollBox.h.

◆ MinHorizontalScrollPosition()

int pcl::ScrollBox::MinHorizontalScrollPosition ( ) const

inline

Returns the minimum horizontal scrolling position.

Definition at line 234 of file ScrollBox.h.

◆ MinVerticalScrollPosition()

int pcl::ScrollBox::MinVerticalScrollPosition ( ) const

inline

Returns the minimum vertical scrolling position.

Definition at line 250 of file ScrollBox.h.

◆ PageHeight()

int pcl::ScrollBox::PageHeight ( ) const

Returns the current page height of this scroll box in scrolling units.

The page height is the length of the vertical scroll bar's slider, or the amount scrolled when the user presses the PgUp or PgDn keys.

◆ PageWidth()

int pcl::ScrollBox::PageWidth ( ) const

Returns the current page width of this scroll box in scrolling units.

The page width is the length of the horizontal scroll bar's slider.

◆ ScrollPosition()

pcl::Point pcl::ScrollBox::ScrollPosition ( ) const

Returns the current scroll position. Returned oordinates are expressed in scrolling units.

◆ SetHorizontalScrollPosition()

void pcl::ScrollBox::SetHorizontalScrollPosition ( int horzPos )

inline

Sets the horizontal scroll position.

Definition at line 405 of file ScrollBox.h.

◆ SetHorizontalScrollRange()

void pcl::ScrollBox::SetHorizontalScrollRange	(	int	minPos,
		int	maxPos
	)

Sets the horizontal scroll range.

Parameters

minPos	Minimum horizontal scrolling position
maxPos	Maximum horizontal scrolling position

The virtual document width will be equal to maxPos - minPos + PageWidth() in scrolling units.

◆ SetLineHeight()

void pcl::ScrollBox::SetLineHeight ( int height )

inline

Sets the line height of this scroll box in scrolling units.

Definition at line 361 of file ScrollBox.h.

◆ SetLineSize()

void pcl::ScrollBox::SetLineSize	(	int	width,
		int	height
	)

Sets the line sizes of this scroll box.

Parameters

width	New line width in scrolling units.
height	New line height in scrolling units.

◆ SetLineWidth()

void pcl::ScrollBox::SetLineWidth ( int width )

inline

Sets the line width of this scroll box in scrolling units.

Definition at line 353 of file ScrollBox.h.

◆ SetPageHeight()

void pcl::ScrollBox::SetPageHeight ( int height )

inline

Sets the page height of this scroll box in scrolling units.

Definition at line 321 of file ScrollBox.h.

◆ SetPageSize()

void pcl::ScrollBox::SetPageSize	(	int	width,
		int	height
	)

Sets the page size of this scroll box.

Parameters

width	New page width in scrolling units.
height	New page height in scrolling units.

◆ SetPageWidth()

void pcl::ScrollBox::SetPageWidth ( int width )

inline

Sets the page width of this scroll box in scrolling units.

Definition at line 313 of file ScrollBox.h.

◆ SetScrollPosition() [1/2]

void pcl::ScrollBox::SetScrollPosition ( const pcl::Point & pos )

inline

Sets the scroll position pos of this scroll box control.

Definition at line 391 of file ScrollBox.h.

References pcl::GenericPoint< T >::x, and pcl::GenericPoint< T >::y.

◆ SetScrollPosition() [2/2]

void pcl::ScrollBox::SetScrollPosition	(	int	horzPos,
		int	vertPos
	)

Sets the scroll coordinates horzPos and vertPos of this scroll box control.

◆ SetVerticalScrollPosition()

void pcl::ScrollBox::SetVerticalScrollPosition ( int vertPos )

inline

Sets the vertical scroll position.

Definition at line 413 of file ScrollBox.h.

◆ SetVerticalScrollRange()

void pcl::ScrollBox::SetVerticalScrollRange	(	int	minPos,
		int	maxPos
	)

Sets the vertical scroll range.

Parameters

minPos	Minimum vertical scrolling position
maxPos	Maximum vertical scrolling position

The virtual document height will be equal to maxPos - minPos + PageHeight() in scrolling units.

◆ ShowHorizontalScrollBar()

void pcl::ScrollBox::ShowHorizontalScrollBar ( bool show = true )

inline

Forces visibility of the horizontal scroll bar.

This is a convenience member function, equivalent to ShowScrollBars( show, IsVerticalScrollBarVisible() )

Definition at line 128 of file ScrollBox.h.

◆ ShowScrollBars()

void pcl::ScrollBox::ShowScrollBars	(	bool	showHorz = `true`,
		bool	showVert = `true`
	)

Forces visibility of scroll bars.

Parameters

showHorz	Visibility of the horizontal scroll bar.
showVert	Visibility of the vertical scroll bar.

◆ ShowVerticalScrollBar()

void pcl::ScrollBox::ShowVerticalScrollBar ( bool show = true )

inline

Forces visibility of the vertical scroll bar.

This is a convenience member function, equivalent to ShowScrollBars( IsHorizontalScrollBarVisible(), show )

Definition at line 150 of file ScrollBox.h.

◆ VerticalScrollPosition()

int pcl::ScrollBox::VerticalScrollPosition ( ) const

inline

Returns the current vertical scroll position in scrolling units.

Definition at line 383 of file ScrollBox.h.

References pcl::GenericPoint< T >::y.

◆ Viewport() [1/2]

Control& pcl::ScrollBox::Viewport ( )

inline

Returns a reference to the viewport control of this scroll box.

The viewport control represents the contents, or "virtual document" of the scroll box.

Definition at line 525 of file ScrollBox.h.

◆ Viewport() [2/2]

const Control& pcl::ScrollBox::Viewport ( ) const

inline

Returns a constant reference to the viewport control of this scroll box.

The viewport control represents the contents, or "virtual document" of the scroll box.

Definition at line 514 of file ScrollBox.h.

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

ScrollBox.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

TODO: Write a detailed description for ScrollBox.

Constructor & Destructor Documentation

◆ ScrollBox()

◆ ~ScrollBox()

Member Function Documentation

◆ DisableAutoScroll()

◆ DisableHorizontalTracking()

◆ DisableTracking()

◆ DisableVerticalTracking()

◆ EnableAutoScroll()

◆ EnableHorizontalTracking()

◆ EnableTracking()

◆ EnableVerticalTracking()

◆ GetHorizontalScrollRange()

◆ GetVerticalScrollRange()

◆ HideHorizontalScrollBar()

◆ HideScrollBars()

◆ HideVerticalScrollBar()

◆ HorizontalScrollPosition()

◆ IsHorizontalAutoScrollEnabled()

◆ IsHorizontalScrollBarVisible()

◆ IsHorizontalTrackingEnabled()

◆ IsVerticalAutoScrollEnabled()

◆ IsVerticalScrollBarVisible()

◆ IsVerticalTrackingEnabled()

◆ LineHeight()

◆ LineWidth()

◆ MaxHorizontalScrollPosition()

◆ MaxVerticalScrollPosition()

◆ MinHorizontalScrollPosition()

◆ MinVerticalScrollPosition()

◆ PageHeight()

◆ PageWidth()

◆ ScrollPosition()

◆ SetHorizontalScrollPosition()

◆ SetHorizontalScrollRange()

◆ SetLineHeight()

◆ SetLineSize()

◆ SetLineWidth()

◆ SetPageHeight()

◆ SetPageSize()

◆ SetPageWidth()

◆ SetScrollPosition() [1/2]

◆ SetScrollPosition() [2/2]

◆ SetVerticalScrollPosition()

◆ SetVerticalScrollRange()

◆ ShowHorizontalScrollBar()

◆ ShowScrollBars()

◆ ShowVerticalScrollBar()

◆ VerticalScrollPosition()

◆ Viewport() [1/2]

◆ Viewport() [2/2]