PCL
|
Client-side interface to a PixInsight ComboBox control. More...
#include <ComboBox.h>
Public Types | |
using | edit_event_handler = void(Control::*)(ComboBox &sender) |
using | item_event_handler = void(Control::*)(ComboBox &sender, int itemIndex) |
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 | |
ComboBox (Control &parent=Control::Null()) | |
~ComboBox () override | |
void | AddItem (const String &text, const Bitmap &icon=Bitmap::Null()) |
template<class C > | |
void | AddItems (const C &c) |
template<class FI > | |
void | AddItems (FI i, FI j) |
void | Clear () |
void | ClearEditText () |
void | ClearItemIcon (int index) |
void | ClearItemText (int index) |
int | CurrentItem () const |
void | DisableAutoCompletion (bool disable=true) |
void | DisableEdit (bool disable=true) |
String | EditText () const |
void | EnableAutoCompletion (bool=true) |
void | EnableEdit (bool=true) |
int | FindItem (const String &text, int fromIdx=0, bool exactMatch=false, bool caseSensitive=false) const |
void | GetIconSize (int &width, int &height) const |
void | GetScaledIconSize (int &width, int &height) const |
void | HideList () |
int | IconHeight () const |
int | IconWidth () const |
void | InsertItem (int index, const String &text, const Bitmap &icon=Bitmap::Null()) |
template<class C > | |
void | InsertItems (int index, const C &c) |
template<class FI > | |
void | InsertItems (int index, FI i, FI j) |
bool | IsAutoCompletionEnabled () const |
bool | IsEditEnabled () const |
Bitmap | ItemIcon (int index) const |
String | ItemText (int index) const |
int | MaxVisibleItemCount () const |
int | MinItemCharWidth () const |
int | NumberOfItems () const |
void | OnEditTextUpdated (edit_event_handler handler, Control &receiver) |
void | OnItemHighlighted (item_event_handler handler, Control &receiver) |
void | OnItemSelected (item_event_handler handler, Control &receiver) |
void | RemoveItem (int index) |
int | ScaledIconHeight () const |
int | ScaledIconWidth () const |
void | SetCurrentItem (int index) |
void | SetEditText (const String &) |
void | SetIconSize (int size) |
void | SetIconSize (int width, int height) |
void | SetItemIcon (int index, const Bitmap &) |
void | SetItemText (int index, const String &) |
void | SetMaxVisibleItemCount (int) |
void | SetMinItemCharWidth (int) |
void | SetScaledIconSize (int size) |
void | SetScaledIconSize (int width, int height) |
void | ShowList () |
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) |
Definition at line 76 of file ComboBox.h.
pcl::ComboBox::ComboBox | ( | Control & | parent = Control::Null() | ) |
Constructs a ComboBox as a child control of parent.
|
inlineoverride |
Destroys a ComboBox control.
Definition at line 88 of file ComboBox.h.
|
inline |
Adds a new item at the end of this combo box.
This is a convenience function, equivalent to: InsertItem( NumberOfItems(), text, icon )
Definition at line 144 of file ComboBox.h.
|
inline |
Appends a list of combo box items from a container.
c | A reference to a container with the list of strings that will be used for newly created items. |
This is a convenience function, equivalent to: InsertItems( NumberOfItems(), c );
Definition at line 219 of file ComboBox.h.
|
inline |
Appends a list of combo box items.
This is a convenience function, equivalent to: InsertItems( NumberOfItems(), i, j )
Definition at line 183 of file ComboBox.h.
void pcl::ComboBox::Clear | ( | ) |
Removes all existing items in this combo box.
|
inline |
Empties the editable part of this combo box control.
Definition at line 311 of file ComboBox.h.
|
inline |
Clears the icon of the combo box item at the specified index.
This is a convenience function, equivalent to: SetItemIcon( index, Bitmap::Null() )
Definition at line 271 of file ComboBox.h.
References pcl::Bitmap::Null().
|
inline |
Empties the text of the combo box item at the specified index.
Definition at line 249 of file ComboBox.h.
int pcl::ComboBox::CurrentItem | ( | ) | const |
Returns the index of the current item in this combo box, or -1 if no item is currently selected in this combo box.
|
inline |
Disables or enables auto completion for this combo box control.
This is a convenience function, equivalent to: EnableAutoCompletion( !disable )
Definition at line 333 of file ComboBox.h.
|
inline |
Disables or enables the editable state of this combo box control.
This is a convenience function, equivalent to: EnableEdit( !disable )
Definition at line 293 of file ComboBox.h.
String pcl::ComboBox::EditText | ( | ) | const |
Returns the current text of the editable part of this combo box control.
void pcl::ComboBox::EnableAutoCompletion | ( | bool | = true | ) |
Enables or disables auto completion for this combo box control.
void pcl::ComboBox::EnableEdit | ( | bool | = true | ) |
Enables or disables the editable state of this combo box control.
int pcl::ComboBox::FindItem | ( | const String & | text, |
int | fromIdx = 0 , |
||
bool | exactMatch = false , |
||
bool | caseSensitive = false |
||
) | const |
Finds an item in this combo box. Returns the index of the item found, or -1 if no item was found that matches the specified criteria.
text | Text to find. |
fromIdx | Starting index from which the search will begin. |
exactMatch | Whether the search will succeed only if an exact match is found, or a partial match is sufficient. |
caseSensitive | True for a case-sensitive search. |
void pcl::ComboBox::GetIconSize | ( | int & | width, |
int & | height | ||
) | const |
Provides the current icon dimensions for this combo box control.
[out] | width,height | Icon dimensions in pixels. |
|
inline |
#
Definition at line 379 of file ComboBox.h.
void pcl::ComboBox::HideList | ( | ) |
Forces this combo box control to exit the drop-down state. The list of items will be hidden, if it is currently visible.
|
inline |
Returns the current icon height in pixels for this combo box control.
Definition at line 356 of file ComboBox.h.
|
inline |
Returns the current icon width in pixels for this combo box control.
Definition at line 348 of file ComboBox.h.
void pcl::ComboBox::InsertItem | ( | int | index, |
const String & | text, | ||
const Bitmap & | icon = Bitmap::Null() |
||
) |
Inserts a new item in this combo box.
index | Insertion point. If an index greater than or equal to the current length is specified, the new item is appended to the end of the current set of items. If the index is less than or equal to zero, the new item will be prepended to the current list of items. |
text | Text for the new item. |
icon | Item icon. |
|
inline |
Inserts a list of combo box items from a container.
index | Insertion point. If an index greater than or equal to the current length is specified, the new items are appended to the end of the current set of items. If the index is less than or equal to zero, the new items will be prepended to the current list of items. |
c | A reference to a container with the list of strings that will be assigned to newly created items. |
This is a convenience function, equivalent to: InsertItems( index, c.Begin(), c.End() )
Definition at line 204 of file ComboBox.h.
|
inline |
Inserts a list of combo box items.
index | Insertion point. If an index greater than or equal to the current length is specified, the new items are appended to the end of the current set of items. If the index is less than or equal to zero, the new items will be prepended to the current list of items. |
i,j | Two forward iterators defining a range of contiguous strings that correspond to the texts of the newly created items. |
Definition at line 163 of file ComboBox.h.
bool pcl::ComboBox::IsAutoCompletionEnabled | ( | ) | const |
Returns true iff auto completion is currently enabled for this combo box control.
bool pcl::ComboBox::IsEditEnabled | ( | ) | const |
Returns true iff this combo box is editable. Editable combo boxes allow the user to edit the text of the currently selected item.
Bitmap pcl::ComboBox::ItemIcon | ( | int | index | ) | const |
Returns the current icon of the combo box item at the specified index.
String pcl::ComboBox::ItemText | ( | int | index | ) | const |
Returns the current text of the combo box item at the specified index.
int pcl::ComboBox::MaxVisibleItemCount | ( | ) | const |
Returns the maximum number of items that can be visible when this combo box control is dropped down, or 0 is no specific limit has been set.
int pcl::ComboBox::MinItemCharWidth | ( | ) | const |
Returns the minimum number of characters that fit in this combo box control, or zero if no specific limit has been set.
int pcl::ComboBox::NumberOfItems | ( | ) | const |
Returns the total number of items in this ComboBox control.
void pcl::ComboBox::RemoveItem | ( | int | index | ) |
Removes the item at the specified index. If the specified index is greater than or equal to the current length, or less than zero,, no items are removed.
|
inline |
#
Definition at line 393 of file ComboBox.h.
|
inline |
#
Definition at line 386 of file ComboBox.h.
void pcl::ComboBox::SetCurrentItem | ( | int | index | ) |
Selects a combo box item with the specified index.
void pcl::ComboBox::SetEditText | ( | const String & | ) |
Sets the text contents of the editable part of this combo box control.
|
inline |
Sets the icon size in pixels for this combo box control.
This is a convenience function, equivalent to: SetIconSize( size, size )
Definition at line 372 of file ComboBox.h.
void pcl::ComboBox::SetIconSize | ( | int | width, |
int | height | ||
) |
Sets the icon dimensions in pixels for this combo box control.
void pcl::ComboBox::SetItemIcon | ( | int | index, |
const Bitmap & | |||
) |
Changes the icon of the combo box item at the specified index. If a null bitmap is specified, the combo box item will have no associated icon.
void pcl::ComboBox::SetItemText | ( | int | index, |
const String & | |||
) |
Sets the current text of the combo box item at the specified index.
void pcl::ComboBox::SetMaxVisibleItemCount | ( | int | ) |
Sets the maximum number of items that can be visible when this combo box control is dropped down. If zero is specified, the combo box control will show a convenient number of items automatically in drop-down state.
void pcl::ComboBox::SetMinItemCharWidth | ( | int | ) |
Sets the minimum number of characters that must fit in this combo box control. If zero is specified, the combo box control will adapt its size automatically to its initial contents.
|
inline |
#
Definition at line 407 of file ComboBox.h.
|
inline |
#
Definition at line 400 of file ComboBox.h.
void pcl::ComboBox::ShowList | ( | ) |
Forces this combo box control to enter the drop-down state. The list of existing items is shown on a pop-up panel where they can be browsed and selected.