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

#include <ViewList.h>

Inheritance diagram for pcl::ViewList:

Public Types
using	view_event_handler = void(Control::*)(ViewList &sender, View &view)

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
	ViewList (Control &parent=Control::Null())

	~ViewList () override

View	CurrentView () const

View	ExcludedView () const

void	ExcludeView (const View &v)

void	GetAll ()

void	GetMainViews ()

void	GetPreviews ()

bool	HasView (const View &view)

bool	IncludesMainViews () const

bool	IncludesPreviews () const

bool	IncludesRealTimePreview () const

void	OnCurrentViewUpdated (view_event_handler handler, Control &receiver)

void	OnViewSelected (view_event_handler handler, Control &receiver)

void	Regenerate (bool mainViews=true, bool previews=true, bool realTimePreview=false)

void	RemoveView (const View &view)

void	SelectView (const View &view)

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 ViewList

Definition at line 76 of file ViewList.h.

Constructor & Destructor Documentation

◆ ViewList()

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

Constructs a ViewList as a child control of parent.

◆ ~ViewList()

pcl::ViewList::~ViewList ( )

inlineoverride

Destroys a ViewList control.

Definition at line 88 of file ViewList.h.

Member Function Documentation

◆ CurrentView()

View pcl::ViewList::CurrentView ( ) const

Returns the view that is currently selected in this ViewList control, or View::Null() if there is no view selected.

See also: SelectView()

◆ ExcludedView()

View pcl::ViewList::ExcludedView ( ) const

Returns the excluded view of this ViewList control, or View::Null() if this ViewList excludes no view.

The excluded view is never included in the list of items of a ViewList control, regardless of the current state of inclusion for main views and previews. This feature is useful when there is a view that shouldn't be referenced in a processing interface. For example, a dynamic interface can easily avoid references to its own dynamic target by excluding it from a ViewList.

By default, ViewList controls exclude no views.

See also: ExcludeView()

◆ ExcludeView()

void pcl::ViewList::ExcludeView ( const View & v )

Sets the excluded view of this ViewList control, or clears it (to exclude no view) if View::Null() is specified.

See also: ExcludedView()

◆ GetAll()

void pcl::ViewList::GetAll ( )

inline

Updates this ViewList control, regenerating the list of items for all existing views, including all main views and previews.

This is a convenience member function, equivalent to: Regenerate( true, true )

Calling this member function implicitly enables the inclusion of main views and previews in the list of items of this ViewList control.

See also: GetMainViews(), GetPreviews(), Regenerate()

Definition at line 163 of file ViewList.h.

◆ GetMainViews()

void pcl::ViewList::GetMainViews ( )

inline

Updates this ViewList control, regenerating the list of items for existing main views exclusively.

This is a convenience member function, equivalent to: Regenerate( true, false )

Calling this member function implicitly disables the inclusion of previews in the list of items of this ViewList control.

See also: GetPreviews(), GetAll(), Regenerate()

Definition at line 129 of file ViewList.h.

◆ GetPreviews()

void pcl::ViewList::GetPreviews ( )

inline

Updates this ViewList control, regenerating the list of items for existing previews exclusively.

This is a convenience member function, equivalent to: Regenerate( false, true )

Calling this member function implicitly disables the inclusion of main views in the list of items of this ViewList control.

See also: GetMainViews(), GetAll(), Regenerate()

Definition at line 146 of file ViewList.h.

◆ HasView()

bool pcl::ViewList::HasView ( const View & view )

Returns true iff the specified view has been included in the list of items of this ViewList control.

◆ IncludesMainViews()

bool pcl::ViewList::IncludesMainViews ( ) const

Returns true iff this ViewList control includes main views (images).

See also: IncludesPreviews(), Regenerate()

◆ IncludesPreviews()

bool pcl::ViewList::IncludesPreviews ( ) const

Returns true iff this ViewList control includes previews.

See also: IncludesMainViews(), Regenerate()

◆ IncludesRealTimePreview()

bool pcl::ViewList::IncludesRealTimePreview ( ) const

Returns true iff this ViewList control includes the virtual real-time preview.

See the documentation for Regenerate() for more information about the virtual real-time preview.

See also: Regenerate()

◆ Regenerate()

void pcl::ViewList::Regenerate	(	bool	mainViews = `true`,
		bool	previews = `true`,
		bool	realTimePreview = `false`
	)

Regenerates the list of view items in this ViewList control.

Parameters

mainViews	Whether to enable inclusion of main views (images) - true by default.
previews	Whether to enable inclusion of previews - true by default.
realTimePreview	Whether to include the virtual real-time preview - false by default.

The virtual real-time preview is a high-level interface to the image currently represented in the Real-Time Preview window. This is a special view that is not attached to any existing image window, and hence has only limited functionality. For example, the standard HistogramTransformation and Statistics tools enable access to this virtual view to obtain the histogram and statistical data, respectively, of the image being represented on the Real-Time Preview window.

In general, a module must not gain access to the virtual real-time preview unless it implements some interactive functionality that depends on the current state of the Real-Time Preview window.

See also: View

◆ RemoveView()

void pcl::ViewList::RemoveView ( const View & view )

Removes the specified view from the list of existing items of this ViewList control.

◆ SelectView()

void pcl::ViewList::SelectView ( const View & view )

Selects the specified view in this ViewList control.

If View::Null() is specified, the ViewList control selects a special item (usually, the first item) with the "No View Selected" text. This is equivalent to a "no selection" state.

If the specified view is not included in this ViewList, calling this member function has no effect.

See also: CurrentView(), HasView()

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

ViewList.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

TODO: Write a detailed description for ViewList

Constructor & Destructor Documentation

◆ ViewList()

◆ ~ViewList()

Member Function Documentation

◆ CurrentView()

◆ ExcludedView()

◆ ExcludeView()

◆ GetAll()

◆ GetMainViews()

◆ GetPreviews()

◆ HasView()

◆ IncludesMainViews()

◆ IncludesPreviews()

◆ IncludesRealTimePreview()

◆ Regenerate()

◆ RemoveView()

◆ SelectView()