Client-side interface to a PixInsight Control object. More...

#include <Control.h>

Inheritance diagram for pcl::Control:

Public Types
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
	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)

Static Public Member Functions
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 ()

Additional Inherited Members
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 Control.

Definition at line 125 of file Control.h.

Constructor & Destructor Documentation

◆ Control() [1/3]

pcl::Control::Control	(	Control &	parent = `Null()`,
		uint32	= `0`
	)

Constructs a control as a child of parent. If no non-null parent is specified, the control will be an independent object not associated (in the hierarchical sense) to any graphical interface element.

The second uint32 argument is not used; it is reserved for future extensions, and must be zero in current PCL versions.

◆ ~Control()

pcl::Control::~Control ( )

inlineoverride

Destroys a Control object.

Definition at line 142 of file Control.h.

◆ Control() [2/3]

pcl::Control::Control ( const Control & )

delete

Copy constructor. Copy and move semantics are disabled for UI controls because of client/server parent-children and event handling relations.

◆ Control() [3/3]

pcl::Control::Control ( Control && )

delete

Move constructor. Copy and move semantics are disabled for UI controls because of client/server parent-children and event handling relations.

Member Function Documentation

◆ ActivateRealTimePreview()

void pcl::Control::ActivateRealTimePreview ( )

inline

#

Definition at line 1189 of file Control.h.

◆ ActivateTrackView()

void pcl::Control::ActivateTrackView ( )

inline

#

Definition at line 1163 of file Control.h.

◆ ActivateWindow()

void pcl::Control::ActivateWindow ( )

#

◆ AdjustToContents()

void pcl::Control::AdjustToContents ( )

#

◆ AlternateCanvasColor()

RGBA pcl::Control::AlternateCanvasColor ( ) const

#

◆ BackgroundColor()

RGBA pcl::Control::BackgroundColor ( ) const

#

◆ BoundsRect()

pcl::Rect pcl::Control::BoundsRect ( ) const

inline

Returns the client rectangle of this control in client coordinates. This function is equivalent to: Rect( 0, 0, ClientWidth(), ClientHeight() )

Definition at line 250 of file Control.h.

References pcl::GenericRectangle< T >::Height(), and pcl::GenericRectangle< T >::Width().

◆ BringToFront()

void pcl::Control::BringToFront ( )

#

◆ ButtonColor()

RGBA pcl::Control::ButtonColor ( ) const

#

◆ ButtonTextColor()

RGBA pcl::Control::ButtonTextColor ( ) const

#

◆ CanUpdate()

bool pcl::Control::CanUpdate ( ) const

#

◆ CanvasColor()

RGBA pcl::Control::CanvasColor ( )

#

◆ ChildByPos() [1/2]

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

inline

#

Definition at line 740 of file Control.h.

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

◆ ChildByPos() [2/2]

Control& pcl::Control::ChildByPos	(	int	x,
		int	y
	)		const

#

◆ ChildrenRect()

pcl::Rect pcl::Control::ChildrenRect ( ) const

#

◆ ChildToFocus()

Control& pcl::Control::ChildToFocus ( ) const

#

◆ ClearInfoText()

void pcl::Control::ClearInfoText ( )

inline

#

Definition at line 1144 of file Control.h.

◆ ClientHeight()

int pcl::Control::ClientHeight ( ) const

inline

Returns the height in pixels of the client area of this control.

Definition at line 232 of file Control.h.

◆ ClientRect()

pcl::Rect pcl::Control::ClientRect ( ) const

Returns the client rectangle of this control in parent coordinates.

◆ ClientWidth()

int pcl::Control::ClientWidth ( ) const

inline

Returns the width in pixels of the client area of this control.

Definition at line 216 of file Control.h.

◆ ControlToLocal() [1/2]

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

#

◆ ControlToLocal() [2/2]

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

inline

#

Definition at line 718 of file Control.h.

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

◆ Cursor()

pcl::Cursor pcl::Control::Cursor ( ) const

#

◆ DeactivateRealTimePreview()

void pcl::Control::DeactivateRealTimePreview ( )

inline

#

Definition at line 1196 of file Control.h.

◆ DeactivateTrackView()

void pcl::Control::DeactivateTrackView ( )

inline

#

Definition at line 1170 of file Control.h.

◆ Disable()

void pcl::Control::Disable ( bool disabled = true )

inline

#

Definition at line 783 of file Control.h.

◆ DisableExpansion()

void pcl::Control::DisableExpansion	(	bool	horzDisable = `true`,
		bool	vertDisable = `true`
	)

inline

#

Definition at line 593 of file Control.h.

◆ DisableMouseTracking()

void pcl::Control::DisableMouseTracking ( bool disable = true )

inline

#

Definition at line 798 of file Control.h.

◆ DisableUpdates()

void pcl::Control::DisableUpdates ( bool disable = true )

inline

#

Definition at line 913 of file Control.h.

◆ Enable()

virtual void pcl::Control::Enable ( bool enabled = true )

virtual

#

Reimplemented in pcl::SectionBar.

◆ EnableExpansion()

void pcl::Control::EnableExpansion	(	bool	horzEnable = `true`,
		bool	vertEnable = `true`
	)

#

◆ EnableMouseTracking()

void pcl::Control::EnableMouseTracking ( bool = true )

#

◆ EnableUpdates()

void pcl::Control::EnableUpdates ( bool enable = true )

#

◆ EnsureLayoutUpdated()

void pcl::Control::EnsureLayoutUpdated ( )

Make sure the control has valid geometry and layout, even if it has never been shown on the screen.

Control layouts and geometries are not computed, in general, until the control has been shown on the screen, either explicitly or implicitly. By calling this member function one can ensure that the control has computed a valid layout, including all of its child controls, even if it has never been shown, so for example a subsequent call to Width() or ClientRect() will provide actual values.

This function can be quite slow, especially for complex controls such as process interfaces, so it should only be used when necessary, never on a regular basis. Calling this member function for a control that is already visible on the screen has no effect.

◆ EnsureUnique()

void pcl::Control::EnsureUnique ( )

inlineoverridevirtual

Ensures that the server-side object managed by this instance is uniquely referenced.

Since server-side controls are unique objects, calling this member function has no effect.

Reimplemented from pcl::UIObject.

Definition at line 177 of file Control.h.

◆ Focus()

void pcl::Control::Focus ( bool focus = true )

#

◆ FocusedChild()

Control& pcl::Control::FocusedChild ( ) const

#

◆ FocusStyle()

FocusStyles pcl::Control::FocusStyle ( ) const

#

◆ Font()

pcl::Font pcl::Control::Font ( ) const

#

◆ ForegroundColor()

RGBA pcl::Control::ForegroundColor ( ) const

#

◆ FrameHeight()

int pcl::Control::FrameHeight ( ) const

inline

Returns the frame height of this control in pixels.

Definition at line 203 of file Control.h.

◆ FrameRect()

pcl::Rect pcl::Control::FrameRect ( ) const

Returns the frame rectangle of this control.

◆ FrameWidth()

int pcl::Control::FrameWidth ( ) const

inline

Returns the frame width of this control in pixels.

Definition at line 195 of file Control.h.

◆ GetCursor()

pcl::Cursor pcl::Control::GetCursor ( ) const

inline

#

Deprecated:: Use Control::Cursor() in newly produced code.

Definition at line 1005 of file Control.h.

◆ GetFont()

pcl::Font pcl::Control::GetFont ( ) const

inline

Deprecated:: Use Control::Font() in newly produced code.

Definition at line 1105 of file Control.h.

◆ GetMaxSize()

void pcl::Control::GetMaxSize	(	int &	w,
		int &	h
	)		const

#

◆ GetMinSize()

void pcl::Control::GetMinSize	(	int &	w,
		int &	h
	)		const

#

◆ GetScaledMaxSize()

void pcl::Control::GetScaledMaxSize	(	int &	w,
		int &	h
	)		const

inline

#

Definition at line 532 of file Control.h.

◆ GetScaledMinSize()

void pcl::Control::GetScaledMinSize	(	int &	w,
		int &	h
	)		const

inline

#

Definition at line 488 of file Control.h.

◆ GetSizer()

pcl::Sizer pcl::Control::GetSizer ( ) const

inline

#

Deprecated:: Use Control::Sizer() in newly produced code.

Definition at line 663 of file Control.h.

◆ GlobalToLocal() [1/2]

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

inline

#

Definition at line 674 of file Control.h.

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

◆ GlobalToLocal() [2/2]

void pcl::Control::GlobalToLocal	(	int &	x,
		int &	y
	)		const

#

◆ Height()

int pcl::Control::Height ( ) const

inline

A convenient synonym for ClientHeight().

Definition at line 240 of file Control.h.

◆ Hide()

void pcl::Control::Hide ( )

#

◆ HideToolTip()

static void pcl::Control::HideToolTip ( )

static

Hides the tool tip window, if one is currently visible.

◆ HighlightColor()

RGBA pcl::Control::HighlightColor ( ) const

#

◆ HighlightedTextColor()

RGBA pcl::Control::HighlightedTextColor ( ) const

#

◆ InfoText()

String pcl::Control::InfoText ( ) const

#

◆ IsActiveWindow()

bool pcl::Control::IsActiveWindow ( ) const

#

◆ IsAncestorOf()

bool pcl::Control::IsAncestorOf ( const Control & ) const

#

◆ IsEnabled()

virtual bool pcl::Control::IsEnabled ( ) const

virtual

#

Reimplemented in pcl::SectionBar.

◆ IsFixedHeight()

bool pcl::Control::IsFixedHeight ( ) const

inline

#

Definition at line 441 of file Control.h.

◆ IsFixedWidth()

bool pcl::Control::IsFixedWidth ( ) const

inline

#

Definition at line 434 of file Control.h.

◆ IsFocused()

bool pcl::Control::IsFocused ( ) const

#

◆ IsHidden()

bool pcl::Control::IsHidden ( ) const

inline

#

Definition at line 827 of file Control.h.

◆ IsHorizontalExpansionEnabled()

bool pcl::Control::IsHorizontalExpansionEnabled ( ) const

#

◆ IsMaximized()

bool pcl::Control::IsMaximized ( ) const

#

◆ IsMinimized()

bool pcl::Control::IsMinimized ( ) const

#

◆ IsModal()

bool pcl::Control::IsModal ( ) const

#

◆ IsMouseTrackingEnabled()

bool pcl::Control::IsMouseTrackingEnabled ( ) const

#

◆ IsRealTimePreviewActive()

bool pcl::Control::IsRealTimePreviewActive ( ) const

#

◆ IsTrackViewActive()

bool pcl::Control::IsTrackViewActive ( ) const

#

◆ IsUnderMouse()

bool pcl::Control::IsUnderMouse ( ) const

Returns true if the mouse cursor is over this control.

◆ IsVerticalExpansionEnabled()

bool pcl::Control::IsVerticalExpansionEnabled ( ) const

#

◆ IsVisible()

bool pcl::Control::IsVisible ( ) const

#

◆ IsWindow()

bool pcl::Control::IsWindow ( ) const

#

◆ LocalToControl() [1/2]

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

#

◆ LocalToControl() [2/2]

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

inline

#

Definition at line 729 of file Control.h.

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

◆ LocalToGlobal() [1/2]

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

inline

#

Definition at line 685 of file Control.h.

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

◆ LocalToGlobal() [2/2]

void pcl::Control::LocalToGlobal	(	int &	x,
		int &	y
	)		const

#

◆ LocalToParent() [1/2]

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

inline

#

Definition at line 707 of file Control.h.

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

◆ LocalToParent() [2/2]

void pcl::Control::LocalToParent	(	int &	x,
		int &	y
	)		const

#

◆ MaxHeight()

int pcl::Control::MaxHeight ( ) const

inline

Returns the maximum height in pixels of the client rectangle.

Definition at line 345 of file Control.h.

◆ MaxWidth()

int pcl::Control::MaxWidth ( ) const

inline

Returns the maximum width in pixels of the client rectangle.

Definition at line 337 of file Control.h.

◆ MinHeight()

int pcl::Control::MinHeight ( ) const

inline

Returns the minimum height in pixels of the client rectangle.

Definition at line 286 of file Control.h.

◆ MinWidth()

int pcl::Control::MinWidth ( ) const

inline

Returns the minimum width in pixels of the client rectangle.

Definition at line 278 of file Control.h.

◆ Move() [1/2]

void pcl::Control::Move ( const pcl::Point & p )

inline

#

Definition at line 630 of file Control.h.

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

◆ Move() [2/2]

void pcl::Control::Move	(	int	x,
		int	y
	)

#

◆ NextSiblingToFocus()

Control& pcl::Control::NextSiblingToFocus ( ) const

#

◆ Null()

static Control& pcl::Control::Null ( )

static

Returns a reference to a null Control instance. A null Control does not correspond to an existing control in the PixInsight core application.

Referenced by pcl::TabBox::ClearControls(), pcl::TabBox::ClearLeftControl(), pcl::TabBox::ClearRightControl(), and pcl::SectionBar::Section().

◆ operator=() [1/2]

Control& pcl::Control::operator= ( const Control & )

delete

Copy assignment. Copy and move semantics are disabled for UI controls because of client/server parent-children and event handling relations.

◆ operator=() [2/2]

Control& pcl::Control::operator= ( Control && )

delete

Move assignment. Copy and move semantics are disabled for UI controls because of client/server parent-children and event handling relations.

◆ Parent()

Control& pcl::Control::Parent ( ) const

Returns a reference to the parent control, or Control::Null() if this control has no parent.

◆ ParentToLocal() [1/2]

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

inline

#

Definition at line 696 of file Control.h.

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

◆ ParentToLocal() [2/2]

void pcl::Control::ParentToLocal	(	int &	x,
		int &	y
	)		const

#

◆ Position()

pcl::Point pcl::Control::Position ( ) const

Returns the current position of this control in parent coordinates.

The position of a control refers to the upper left corner of its frame rectangle.

See also: X(), Y()

◆ Repaint() [1/3]

void pcl::Control::Repaint ( )

#

◆ Repaint() [2/3]

void pcl::Control::Repaint ( const pcl::Rect & r )

inline

#

Definition at line 939 of file Control.h.

References pcl::GenericRectangle< T >::x0, pcl::GenericRectangle< T >::x1, pcl::GenericRectangle< T >::y0, and pcl::GenericRectangle< T >::y1.

◆ Repaint() [3/3]

void pcl::Control::Repaint	(	int	x0,
		int	y0,
		int	x1,
		int	y1
	)

#

◆ Resize()

void pcl::Control::Resize	(	int	w,
		int	h
	)

#

◆ Restyle()

void pcl::Control::Restyle ( )

Recomputes all style properties for this control: colors, fonts, spacings, margings, etc.

Call this function to ensure that the screen rendition of this control applies all current settings; for example, after setting a new CSS style sheet with SetStyleSheet().

◆ ScaledMaxHeight()

int pcl::Control::ScaledMaxHeight ( ) const

inline

Returns the maximum height in pixels of the client rectangle.

Definition at line 525 of file Control.h.

◆ ScaledMaxWidth()

int pcl::Control::ScaledMaxWidth ( ) const

inline

Returns the maximum width in pixels of the client rectangle.

Definition at line 517 of file Control.h.

◆ ScaledMinHeight()

int pcl::Control::ScaledMinHeight ( ) const

inline

Returns the minimum height in pixels of the client rectangle.

Definition at line 481 of file Control.h.

◆ ScaledMinWidth()

int pcl::Control::ScaledMinWidth ( ) const

inline

Returns the minimum width in pixels of the client rectangle.

Definition at line 473 of file Control.h.

◆ Scroll() [1/4]

void pcl::Control::Scroll ( const pcl::Point & d )

inline

#

Definition at line 978 of file Control.h.

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

◆ Scroll() [2/4]

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

inline

#

Definition at line 989 of file Control.h.

References pcl::GenericPoint< T >::x, pcl::GenericRectangle< T >::x0, pcl::GenericRectangle< T >::x1, pcl::GenericPoint< T >::y, pcl::GenericRectangle< T >::y0, and pcl::GenericRectangle< T >::y1.

◆ Scroll() [3/4]

void pcl::Control::Scroll	(	int	dx,
		int	dy
	)

#

◆ Scroll() [4/4]

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

#

◆ SendToBack()

void pcl::Control::SendToBack ( )

#

◆ SetAlternateCanvasColor()

void pcl::Control::SetAlternateCanvasColor ( RGBA )

#

◆ SetBackgroundColor()

void pcl::Control::SetBackgroundColor ( RGBA )

#

◆ SetButtonColor()

void pcl::Control::SetButtonColor ( RGBA )

#

◆ SetButtonTextColor()

void pcl::Control::SetButtonTextColor ( RGBA )

#

◆ SetCanvasColor()

void pcl::Control::SetCanvasColor ( RGBA )

#

◆ SetChildToFocus()

void pcl::Control::SetChildToFocus ( Control & )

#

◆ SetClientRect() [1/2]

void pcl::Control::SetClientRect ( const pcl::Rect & r )

inline

#

Definition at line 258 of file Control.h.

References pcl::GenericRectangle< T >::x0, pcl::GenericRectangle< T >::x1, pcl::GenericRectangle< T >::y0, and pcl::GenericRectangle< T >::y1.

◆ SetClientRect() [2/2]

void pcl::Control::SetClientRect	(	int	x0,
		int	y0,
		int	x1,
		int	y1
	)

#

◆ SetCursor()

void pcl::Control::SetCursor ( const pcl::Cursor & )

#

◆ SetCursorToParent()

void pcl::Control::SetCursorToParent ( )

#

◆ SetFixedHeight() [1/2]

void pcl::Control::SetFixedHeight ( )

inline

#

Definition at line 416 of file Control.h.

◆ SetFixedHeight() [2/2]

void pcl::Control::SetFixedHeight ( int h )

inline

#

Definition at line 409 of file Control.h.

◆ SetFixedSize() [1/2]

void pcl::Control::SetFixedSize ( )

inline

#

Definition at line 427 of file Control.h.

◆ SetFixedSize() [2/2]

void pcl::Control::SetFixedSize	(	int	w,
		int	h
	)

#

◆ SetFixedWidth() [1/2]

void pcl::Control::SetFixedWidth ( )

inline

#

Definition at line 402 of file Control.h.

◆ SetFixedWidth() [2/2]

void pcl::Control::SetFixedWidth ( int w )

inline

#

Definition at line 395 of file Control.h.

◆ SetFocusStyle()

void pcl::Control::SetFocusStyle ( FocusStyles )

#

◆ SetFont()

void pcl::Control::SetFont ( const pcl::Font & )

#

◆ SetForegroundColor()

void pcl::Control::SetForegroundColor ( RGBA )

#

◆ SetHighlightColor()

void pcl::Control::SetHighlightColor ( RGBA )

#

◆ SetHighlightedTextColor()

void pcl::Control::SetHighlightedTextColor ( RGBA )

#

◆ SetInfoText()

void pcl::Control::SetInfoText ( const String & )

#

◆ SetMaxHeight() [1/2]

void pcl::Control::SetMaxHeight ( )

inline

#

Definition at line 377 of file Control.h.

◆ SetMaxHeight() [2/2]

void pcl::Control::SetMaxHeight ( int h )

inline

#

Definition at line 370 of file Control.h.

◆ SetMaxSize() [1/2]

void pcl::Control::SetMaxSize ( )

inline

#

Definition at line 388 of file Control.h.

◆ SetMaxSize() [2/2]

void pcl::Control::SetMaxSize	(	int	w,
		int	h
	)

#

◆ SetMaxWidth() [1/2]

void pcl::Control::SetMaxWidth ( )

inline

#

Definition at line 363 of file Control.h.

◆ SetMaxWidth() [2/2]

void pcl::Control::SetMaxWidth ( int w )

inline

#

Definition at line 356 of file Control.h.

◆ SetMinHeight() [1/2]

void pcl::Control::SetMinHeight ( )

inline

#

Definition at line 318 of file Control.h.

◆ SetMinHeight() [2/2]

void pcl::Control::SetMinHeight ( int h )

inline

#

Definition at line 311 of file Control.h.

◆ SetMinSize() [1/2]

void pcl::Control::SetMinSize ( )

inline

#

Definition at line 329 of file Control.h.

◆ SetMinSize() [2/2]

void pcl::Control::SetMinSize	(	int	w,
		int	h
	)

#

◆ SetMinWidth() [1/2]

void pcl::Control::SetMinWidth ( )

inline

#

Definition at line 304 of file Control.h.

◆ SetMinWidth() [2/2]

void pcl::Control::SetMinWidth ( int w )

inline

#

Definition at line 297 of file Control.h.

◆ SetNextSiblingToFocus()

void pcl::Control::SetNextSiblingToFocus ( Control & )

#

◆ SetParent()

void pcl::Control::SetParent ( Control & )

#

◆ SetRealTimePreviewActive()

void pcl::Control::SetRealTimePreviewActive ( bool = true )

#

◆ SetScaledFixedHeight()

void pcl::Control::SetScaledFixedHeight ( int h )

inline

#

Definition at line 567 of file Control.h.

◆ SetScaledFixedSize()

void pcl::Control::SetScaledFixedSize	(	int	w,
		int	h
	)

inline

#

Definition at line 574 of file Control.h.

◆ SetScaledFixedWidth()

void pcl::Control::SetScaledFixedWidth ( int w )

inline

#

Definition at line 560 of file Control.h.

◆ SetScaledMaxHeight()

void pcl::Control::SetScaledMaxHeight ( int h )

inline

#

Definition at line 546 of file Control.h.

◆ SetScaledMaxSize()

void pcl::Control::SetScaledMaxSize	(	int	w,
		int	h
	)

inline

#

Definition at line 553 of file Control.h.

◆ SetScaledMaxWidth()

void pcl::Control::SetScaledMaxWidth ( int w )

inline

#

Definition at line 539 of file Control.h.

◆ SetScaledMinHeight()

void pcl::Control::SetScaledMinHeight ( int h )

inline

#

Definition at line 502 of file Control.h.

◆ SetScaledMinSize()

void pcl::Control::SetScaledMinSize	(	int	w,
		int	h
	)

inline

#

Definition at line 509 of file Control.h.

◆ SetScaledMinWidth()

void pcl::Control::SetScaledMinWidth ( int w )

inline

#

Definition at line 495 of file Control.h.

◆ SetSizer()

void pcl::Control::SetSizer ( pcl::Sizer & )

#

◆ SetStyleSheet()

void pcl::Control::SetStyleSheet ( const String & css )

#

◆ SetTextColor()

void pcl::Control::SetTextColor ( RGBA )

#

◆ SetToolTip()

void pcl::Control::SetToolTip ( const String & )

#

◆ SetTrackViewActive()

void pcl::Control::SetTrackViewActive ( bool = true )

#

◆ SetVariableHeight()

void pcl::Control::SetVariableHeight ( )

inline

#

Definition at line 464 of file Control.h.

◆ SetVariableSize()

void pcl::Control::SetVariableSize ( )

inline

#

Definition at line 448 of file Control.h.

◆ SetVariableWidth()

void pcl::Control::SetVariableWidth ( )

inline

#

Definition at line 456 of file Control.h.

◆ SetVisible()

void pcl::Control::SetVisible ( bool visible )

inline

#

Definition at line 809 of file Control.h.

◆ SetWindowOpacity()

void pcl::Control::SetWindowOpacity ( double )

#

◆ SetWindowTitle()

void pcl::Control::SetWindowTitle ( const String & )

#

◆ Show()

void pcl::Control::Show ( )

#

◆ ShowToolTip() [1/2]

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

inlinestatic

Shows a new tool tip window.

This function is equivalent to ShowToolTip( pos.x, pos.y, text, control, rect ).

Definition at line 1245 of file Control.h.

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

◆ ShowToolTip() [2/2]

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

static

Shows a new tool tip window.

Parameters

x,y	Position (horizontal, vertical) of the new tool tip window in global coordinates.
text	Tool tip text. Can be either a plain text string or include HTML tags with CSS style properties. If this is an empty string the tool tip window will be hidden, if already visible.
control	If this is not a null control, the tool tip window will be hidden as soon as the cursor moves out of the control boundaries or, if specified, out of the rect rectangle in local coordinates.
rect	If a non-void rectangle is specified, the tool tip window will be hidden as soon as the cursor moves out of it. If a non-null control is specified, the coordinates of rect are local to it; otherwise global coordinates are assumed.

The new tool tip window will be shown (or hidden if an empty text is specified) immediately.

◆ Sizer()

pcl::Sizer pcl::Control::Sizer ( ) const

#

◆ StackUnder()

void pcl::Control::StackUnder ( Control & )

#

◆ StyleSheet()

String pcl::Control::StyleSheet ( ) const

#

◆ TextColor()

RGBA pcl::Control::TextColor ( ) const

#

◆ ToolTip()

String pcl::Control::ToolTip ( ) const

#

◆ ToolTipText()

static String pcl::Control::ToolTipText ( )

static

Returns the tool tip window's text, if a tool tip window is currently visible.

◆ Unfocus()

void pcl::Control::Unfocus ( )

inline

#

Definition at line 870 of file Control.h.

◆ Update() [1/3]

void pcl::Control::Update ( )

#

◆ Update() [2/3]

void pcl::Control::Update ( const pcl::Rect & r )

inline

#

Definition at line 924 of file Control.h.

References pcl::GenericRectangle< T >::x0, pcl::GenericRectangle< T >::x1, pcl::GenericRectangle< T >::y0, and pcl::GenericRectangle< T >::y1.

◆ Update() [3/3]

void pcl::Control::Update	(	int	x0,
		int	y0,
		int	x1,
		int	y1
	)

#

◆ VisibleRect()

pcl::Rect pcl::Control::VisibleRect ( ) const

#

◆ Width()

int pcl::Control::Width ( ) const

inline

A convenient synonym for ClientWidth().

Definition at line 224 of file Control.h.

◆ Window()

Control& pcl::Control::Window ( ) const

Returns a reference to the top-level window that owns this control, either directly or through its parent.

◆ WindowOpacity()

double pcl::Control::WindowOpacity ( ) const

#

◆ WindowTitle()

String pcl::Control::WindowTitle ( ) const

#

◆ X()

int pcl::Control::X ( ) const

inline

Returns the horizontal position of this control in parent coordinates.

See also: Y(), Position()

Definition at line 613 of file Control.h.

◆ Y()

int pcl::Control::Y ( ) const

inline

Returns the horizontal position of this control in parent coordinates.

See also: X(), Position()

Definition at line 623 of file Control.h.

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

Control.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

TODO: Write a detailed description for Control.

Constructor & Destructor Documentation

◆ Control() [1/3]

◆ ~Control()

◆ Control() [2/3]

◆ Control() [3/3]

Member Function Documentation

◆ ActivateRealTimePreview()

◆ ActivateTrackView()

◆ ActivateWindow()

◆ AdjustToContents()

◆ AlternateCanvasColor()

◆ BackgroundColor()

◆ BoundsRect()

◆ BringToFront()

◆ ButtonColor()

◆ ButtonTextColor()

◆ CanUpdate()

◆ CanvasColor()

◆ ChildByPos() [1/2]

◆ ChildByPos() [2/2]

◆ ChildrenRect()

◆ ChildToFocus()

◆ ClearInfoText()

◆ ClientHeight()

◆ ClientRect()

◆ ClientWidth()

◆ ControlToLocal() [1/2]

◆ ControlToLocal() [2/2]

◆ Cursor()

◆ DeactivateRealTimePreview()

◆ DeactivateTrackView()

◆ Disable()

◆ DisableExpansion()

◆ DisableMouseTracking()

◆ DisableUpdates()

◆ Enable()

◆ EnableExpansion()

◆ EnableMouseTracking()

◆ EnableUpdates()

◆ EnsureLayoutUpdated()

◆ EnsureUnique()

◆ Focus()

◆ FocusedChild()

◆ FocusStyle()

◆ Font()

◆ ForegroundColor()

◆ FrameHeight()

◆ FrameRect()

◆ FrameWidth()

◆ GetCursor()

◆ GetFont()

◆ GetMaxSize()

◆ GetMinSize()

◆ GetScaledMaxSize()

◆ GetScaledMinSize()

◆ GetSizer()

◆ GlobalToLocal() [1/2]

◆ GlobalToLocal() [2/2]

◆ Height()

◆ Hide()

◆ HideToolTip()

◆ HighlightColor()

◆ HighlightedTextColor()

◆ InfoText()

◆ IsActiveWindow()

◆ IsAncestorOf()

◆ IsEnabled()

◆ IsFixedHeight()

◆ IsFixedWidth()

◆ IsFocused()

◆ IsHidden()

◆ IsHorizontalExpansionEnabled()

◆ IsMaximized()

◆ IsMinimized()