PCL
pcl::TabBox Class Reference

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

#include <TabBox.h>

+ Inheritance diagram for pcl::TabBox:

Public Types

using page_event_handler = void(Control::*)(TabBox &sender, int pageIndex)
 
using tab_position = TabPosition::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

 TabBox (Control &parent=Control::Null())
 
 ~TabBox () override
 
void AddPage (Control &page, const String &label, const Bitmap &icon=Bitmap::Null())
 
void ClearControls ()
 
void ClearLeftControl ()
 
void ClearPageIcon (int idx)
 
void ClearPageLabel (int idx)
 
void ClearPageToolTip (int idx)
 
void ClearRightControl ()
 
ControlCurrentPageControl () const
 
int CurrentPageIndex () const
 
void DisablePage (int index, bool disable=true)
 
void EnablePage (int index, bool enable=true)
 
void InsertPage (int index, Control &page, const String &label, const Bitmap &icon=Bitmap::Null())
 
bool IsPageEnabled (int index) const
 
ControlLeftControl () const
 
int NumberOfPages () const
 
void OnPageSelected (page_event_handler handler, Control &receiver)
 
ControlPageControlByIndex (int index) const
 
Bitmap PageIcon (int idx) const
 
String PageLabel (int idx) const
 
String PageToolTip (int idx) const
 
void RemovePage (int idx)
 
ControlRightControl () const
 
void SelectPage (int index)
 
void SetControls (Control &left, Control &right)
 
void SetCurrentPageIndex (int index)
 
void SetLeftControl (Control &w)
 
void SetPageIcon (int idx, const Bitmap &)
 
void SetPageLabel (int idx, const String &)
 
void SetPageToolTip (int idx, const String &)
 
void SetRightControl (Control &w)
 
void SetTabPosition (tab_position pos)
 
tab_position TabPosition () 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 ()
 
ControlChildByPos (const pcl::Point &p) const
 
ControlChildByPos (int x, int y) const
 
pcl::Rect ChildrenRect () const
 
ControlChildToFocus () 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)
 
ControlFocusedChild () 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)
 
ControlNextSiblingToFocus () 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 &)
 
Controloperator= (const Control &)=delete
 
Controloperator= (Control &&)=delete
 
ControlParent () 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
 
ControlWindow () 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 ControlNull ()
 
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 UIObjectNull ()
 
- Protected Member Functions inherited from pcl::UIObject
 UIObject ()=default
 
 UIObject (const UIObject &x)
 
 UIObject (UIObject &&x)
 
UIObjectoperator= (const UIObject &x)
 
UIObjectoperator= (UIObject &&x)
 

Detailed Description

TODO: Write a detailed description for TabBox.

Definition at line 96 of file TabBox.h.

Member Typedef Documentation

◆ tab_position

using pcl::TabBox::tab_position = TabPosition::value_type

Represents a tab position.

Definition at line 103 of file TabBox.h.

Constructor & Destructor Documentation

◆ TabBox()

pcl::TabBox::TabBox ( Control parent = Control::Null())

Constructs a TabBox as a child control of parent.

◆ ~TabBox()

pcl::TabBox::~TabBox ( )
inlineoverride

Destroys a TabBox control.

Definition at line 113 of file TabBox.h.

Member Function Documentation

◆ AddPage()

void pcl::TabBox::AddPage ( Control page,
const String label,
const Bitmap icon = Bitmap::Null() 
)
inline

Appends a new page control to this TabBox.

This is a convenience member function, equivalent to InsertPage( NumberOfPages(), page, label, icon )

InsertPage, RemovePage()

Definition at line 182 of file TabBox.h.

◆ ClearControls()

void pcl::TabBox::ClearControls ( )
inline

#

Definition at line 325 of file TabBox.h.

References pcl::Control::Null().

◆ ClearLeftControl()

void pcl::TabBox::ClearLeftControl ( )
inline

#

Definition at line 311 of file TabBox.h.

References pcl::Control::Null().

◆ ClearPageIcon()

void pcl::TabBox::ClearPageIcon ( int  idx)
inline

#

Definition at line 263 of file TabBox.h.

References pcl::Bitmap::Null().

◆ ClearPageLabel()

void pcl::TabBox::ClearPageLabel ( int  idx)
inline

#

Definition at line 248 of file TabBox.h.

◆ ClearPageToolTip()

void pcl::TabBox::ClearPageToolTip ( int  idx)
inline

#

Definition at line 278 of file TabBox.h.

◆ ClearRightControl()

void pcl::TabBox::ClearRightControl ( )
inline

#

Definition at line 318 of file TabBox.h.

References pcl::Control::Null().

◆ CurrentPageControl()

Control& pcl::TabBox::CurrentPageControl ( ) const

Returns a reference to the current page control in this TabBox, or Control::Null() if this TabBox has no page controls.

◆ CurrentPageIndex()

int pcl::TabBox::CurrentPageIndex ( ) const

Returns the zero-based index of the current page control in this TabBox, or -1 if this TabBox has no page controls.

◆ DisablePage()

void pcl::TabBox::DisablePage ( int  index,
bool  disable = true 
)
inline

Disables or enables the page control at the specified index.

This is a convenience member function, equivalent to EnablePage( index, !disable )

See also
EnablePage(), IsPageEnabled()

Definition at line 233 of file TabBox.h.

◆ EnablePage()

void pcl::TabBox::EnablePage ( int  index,
bool  enable = true 
)

Enables or disables the page control at the specified index.

See also
DisablePage(), IsPageEnabled()

◆ InsertPage()

void pcl::TabBox::InsertPage ( int  index,
Control page,
const String label,
const Bitmap icon = Bitmap::Null() 
)

Inserts a new page control in this TabBox.

Parameters
indexZero-based index where the new page control will be inserted. If index is greater than or equal to the number of existing page controls, the new page will be appended to the list of existing page controls. If index is less than zero, the new page will be prepended to the list of existing page controls.
pageThe page control to be inserted.
labelThe text that will be shown on the new tab selector.
iconThe icon that will be shown on the new tab selector.
See also
AddPage(), RemovePage()

◆ IsPageEnabled()

bool pcl::TabBox::IsPageEnabled ( int  index) const

Returns true iff the page control at the specified index is enabled.

See also
EnablePage(), DisablePage()

◆ LeftControl()

Control& pcl::TabBox::LeftControl ( ) const

#

◆ NumberOfPages()

int pcl::TabBox::NumberOfPages ( ) const

Returns the number of page controls in this TabBox.

◆ PageControlByIndex()

Control& pcl::TabBox::PageControlByIndex ( int  index) const

Returns a reference to the page control at the specified zero-based index in this TabBox, or Control::Null() if this TabBox has no page controls, or if index is not valid.

◆ PageIcon()

Bitmap pcl::TabBox::PageIcon ( int  idx) const

#

◆ PageLabel()

String pcl::TabBox::PageLabel ( int  idx) const

#

◆ PageToolTip()

String pcl::TabBox::PageToolTip ( int  idx) const

#

◆ RemovePage()

void pcl::TabBox::RemovePage ( int  idx)

Removes the page control at the specified zero-based index.

This member function does not delete the page control; it simply removes it from the list of page controls in this TabBox.

See also
InsertPage(), AddPage()

◆ RightControl()

Control& pcl::TabBox::RightControl ( ) const

#

◆ SelectPage()

void pcl::TabBox::SelectPage ( int  index)
inline

A synonym for SetCurrentPageIndex( index )

Definition at line 136 of file TabBox.h.

◆ SetControls()

void pcl::TabBox::SetControls ( Control left,
Control right 
)

#

◆ SetCurrentPageIndex()

void pcl::TabBox::SetCurrentPageIndex ( int  index)

Selects the current page control by its zero-based index.

◆ SetLeftControl()

void pcl::TabBox::SetLeftControl ( Control w)
inline

#

Definition at line 297 of file TabBox.h.

◆ SetPageIcon()

void pcl::TabBox::SetPageIcon ( int  idx,
const Bitmap  
)

#

◆ SetPageLabel()

void pcl::TabBox::SetPageLabel ( int  idx,
const String  
)

#

◆ SetPageToolTip()

void pcl::TabBox::SetPageToolTip ( int  idx,
const String  
)

#

◆ SetRightControl()

void pcl::TabBox::SetRightControl ( Control w)
inline

#

Definition at line 304 of file TabBox.h.

◆ SetTabPosition()

void pcl::TabBox::SetTabPosition ( tab_position  pos)

Sets the position of the tab selectors row in this TabBox.

See also
TabPosition()

◆ TabPosition()

tab_position pcl::TabBox::TabPosition ( ) const

Returns the position of the tab selectors row in this TabBox.

See also
SetTabPosition()

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