Module: Wx

Defined in:
lib/wx/doc/rtc/richtext_style_sheet.rb,
lib/wx/doc/gen/aui/aui_manager_event.rb,
lib/wx/doc/gen/aui/aui_tool_bar_item.rb,
lib/wx/doc/gen/file_dir_picker_event.rb,
lib/wx/doc/gen/grid/grid_cell_editor.rb,
lib/wx/doc/gen/html/html_help_window.rb,
lib/wx/doc/gen/owner_drawn_combo_box.rb,
lib/wx/doc/gen/pg/pg_validation_info.rb,
lib/wx/doc/gen/pg/property_grid_page.rb,
lib/wx/doc/gen/property_sheet_dialog.rb,
lib/wx/doc/gen/prt/page_setup_dialog.rb,
lib/wx/doc/gen/rbn/ribbon_button_bar.rb,
lib/wx/doc/gen/stc/styled_text_event.rb,
lib/wx/doc/html/html_help_controller.rb,
lib/wx/doc/gen/aui/aui_floating_frame.rb,
lib/wx/doc/gen/aui/aui_notebook_event.rb,
lib/wx/doc/gen/aui/aui_tool_bar_event.rb,
lib/wx/doc/gen/calculate_layout_event.rb,
lib/wx/doc/gen/collapsible_pane_event.rb,
lib/wx/doc/gen/grid/grid_string_table.rb,
lib/wx/doc/gen/pg/property_grid_event.rb,
lib/wx/doc/gen/prt/print_abort_dialog.rb,
lib/wx/doc/gen/rbn/ribbon_panel_event.rb,
lib/wx/doc/gen/rtc/rich_text_printing.rb,
lib/wx/doc/gen/aui/aui_mdi_child_frame.rb,
lib/wx/doc/gen/credential_entry_dialog.rb,
lib/wx/doc/gen/data_object_simple_base.rb,
lib/wx/doc/gen/grid/grid_cell_renderer.rb,
lib/wx/doc/gen/grid/grid_table_message.rb,
lib/wx/doc/gen/html/html_easy_printing.rb,
lib/wx/doc/gen/query_layout_info_event.rb,
lib/wx/doc/gen/rbn/ribbon_art_provider.rb,
lib/wx/doc/gen/std_dialog_button_sizer.rb,
lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb,
lib/wx/doc/gen/pg/property_grid_manager.rb,
lib/wx/doc/gen/rbn/ribbon_gallery_event.rb,
lib/wx/doc/gen/rtc/symbol_picker_dialog.rb,
lib/wx/doc/gen/aui/aui_mdi_client_window.rb,
lib/wx/doc/gen/html/html_help_controller.rb,
lib/wx/doc/gen/pg/pg_array_editor_dialog.rb,
lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb,
lib/wx/doc/gen/rtc/rich_text_xml_handler.rb,
lib/wx/doc/gen/file_dialog_custom_control.rb,
lib/wx/doc/gen/file_dialog_customize_hook.rb,
lib/wx/doc/gen/grid/grid_cell_bool_editor.rb,
lib/wx/doc/gen/grid/grid_cell_date_editor.rb,
lib/wx/doc/gen/grid/grid_cell_enum_editor.rb,
lib/wx/doc/gen/grid/grid_cell_text_editor.rb,
lib/wx/doc/gen/pg/property_grid_interface.rb,
lib/wx/doc/gen/rtc/rich_text_file_handler.rb,
lib/wx/doc/gen/rtc/rich_text_html_handler.rb,
lib/wx/doc/rtc/rich_text_composite_object.rb,
lib/wx/doc/gen/grid/grid_cell_float_editor.rb,
lib/wx/doc/gen/pg/property_grid_page_state.rb,
lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb,
lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb,
lib/wx/doc/gen/grid/grid_cell_choice_editor.rb,
lib/wx/doc/gen/grid/grid_cell_date_renderer.rb,
lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb,
lib/wx/doc/gen/grid/grid_cell_number_editor.rb,
lib/wx/doc/gen/grid/grid_range_select_event.rb,
lib/wx/doc/gen/rtc/rich_text_style_list_box.rb,
lib/wx/doc/gen/grid/grid_cell_float_renderer.rb,
lib/wx/doc/gen/pg/numeric_property_validator.rb,
lib/wx/doc/gen/grid/grid_cell_number_renderer.rb,
lib/wx/doc/gen/grid/grid_cell_string_renderer.rb,
lib/wx/doc/gen/grid/grid_editor_created_event.rb,
lib/wx/doc/gen/rtc/rich_text_composite_object.rb,
lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb,
lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb,
lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb,
lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb,
lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb,
lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb,
lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb,
lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb,
lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb

Defined Under Namespace

Modules: AUI, ArrayExt, ArtLocator, ComboPopup, GRID, HTML, IDHelper, PG, PRT, RBN, RTC, STC, TextEntry, WithImages Classes: AboutDialogInfo, AcceleratorEntry, AcceleratorEntryFlags, AcceleratorTable, Accessible, ActivateEvent, ActivityIndicator, AffineMatrix2D, AffineMatrix2DBase, Alignment, Animation, AnimationCtrl, AnimationDecoder, AnimationDisposal, AnimationType, AntialiasMode, AnyButton, App, AppTraits, ArchiveFSHandler, ArtProvider, BackgroundStyle, BannerWindow, Bitmap, BitmapBundle, BitmapButton, BitmapComboBox, BitmapDataObject, BitmapToggleButton, BitmapType, Bitness, BookCtrlBase, BookCtrlEvent, Border, BoxSizer, Brush, BrushStyle, BufferedDC, BufferedPaintDC, BusyInfo, BusyInfoFlags, Button, CalculateLayoutEvent, CalendarCtrl, CalendarDateAttr, CalendarDateBorder, CalendarEvent, CalendarHitTestResult, Caret, CheckBox, CheckBoxState, CheckListBox, ChildFocusEvent, Choice, Choicebook, ClientDC, Clipboard, ClipboardTextEvent, CloseEvent, CollapsiblePane, CollapsiblePaneEvent, Colour, ColourData, ColourDatabase, ColourDialog, ColourPickerCtrl, ColourPickerEvent, ComboBox, ComboCtrl, ComboPopupWx, CommandEvent, CommandLinkButton, CompositionMode, Config, ConfigBase, ConfigWx, ContentProtection, ContextHelp, ContextHelpButton, ContextMenuEvent, Control, ControlWithItems, CredentialEntryDialog, Cursor, CustomDataObject, DC, DCOverlay, DPIChangedEvent, DataFormat, DataFormatId, DataObject, DataObjectComposite, DataObjectSimple, DataObjectSimpleBase, DateEvent, DatePickerCtrl, DialUpEvent, DialUpManager, Dialog, DialogLayoutAdaptationMode, DialogLayoutAdapter, DirDialog, DirFilterListCtrl, DirPickerCtrl, Direction, DisplayChangedEvent, DragImage, DragResult, DropFilesEvent, DropSource, DropTarget, DuplexMode, EditableListBox, EllipsizeFlags, EllipsizeMode, Endianness, Enum, EraseEvent, Event, EventBlocker, EventCategory, EventFilter, EventPropagation, EvtHandler, ExtHelpController, FSFile, FileCtrl, FileCtrlEvent, FileDataObject, FileDialog, FileDialogButton, FileDialogCheckBox, FileDialogChoice, FileDialogCustomControl, FileDialogCustomize, FileDialogCustomizeHook, FileDialogRadioButton, FileDialogStaticText, FileDialogTextCtrl, FileDirPickerEvent, FileDropTarget, FilePickerCtrl, FileSystem, FileSystemHandler, FileSystemOpenFlags, FindDialogEvent, FindReplaceData, FindReplaceDialog, FindReplaceDialogStyles, FindReplaceFlags, FlexGridSizer, FlexSizerGrowMode, FloatValidator, FloodFillStyle, FocusEvent, Font, FontData, FontDialog, FontEncoding, FontFamily, FontFlag, FontInfo, FontMetrics, FontPickerCtrl, FontPickerEvent, FontStyle, FontSymbolicSize, FontWeight, Frame, FullScreenEvent, GBPosition, GBSizerItem, GBSpan, GCDC, GDIObject, GUIEventLoop, Gauge, GenericAboutDialog, GenericAnimationCtrl, GenericDirCtrl, GenericStaticBitmap, GenericValidator, GeometryCentre, GestureEvent, GradientType, GraphicsBitmap, GraphicsBrush, GraphicsContext, GraphicsFont, GraphicsGradientStop, GraphicsGradientStops, GraphicsMatrix, GraphicsObject, GraphicsPath, GraphicsPen, GraphicsPenInfo, GraphicsRenderer, GridBagSizer, GridSizer, HBoxSizer, HWrapSizer, HeaderColumn, HeaderColumnSimple, HeaderCtrl, HeaderCtrlEvent, HeaderCtrlSimple, HelpController, HelpEvent, HelpProvider, HelpSearchMode, HitTest, HyperlinkCtrl, HyperlinkEvent, Icon, IconBundle, IconLocation, IconizeEvent, IdleEvent, IdleMode, Image, ImageAlphaBlendMode, ImageDataObject, ImageList, ImagePNGType, ImageResizeQuality, ImageResolution, InfoBar, InitDialogEvent, InputStream, IntegerValidator, InterpolationQuality, ItemAttr, ItemKind, JoystickEvent, KeyCategoryFlags, KeyCode, KeyEvent, KeyModifier, KeyboardState, Language, LanguageInfo, LayoutAlgorithm, LayoutAlignment, LayoutDirection, LayoutOrientation, LinuxDistributionInfo, ListBox, ListColumnFormat, ListCtrl, ListEvent, ListItem, ListView, Listbook, Locale, LocaleCategory, LocaleForm, LocaleInfo, LocaleInitFlags, LocaleName, LocaleTagType, Log, LogBuffer, LogChain, LogGui, LogInterposer, LogLevelValues, LogNull, LogRecordInfo, LogStderr, LogTextCtrl, LogWindow, LongPressEvent, MDIChildFrame, MDIClientWindow, MDIParentFrame, MappingMode, Mask, Matrix2D, MaximizeEvent, MediaCtrl, MediaCtrlPlayerControls, MediaEvent, MediaState, MemoryDC, MemoryFSHandler, Menu, MenuBar, MenuEvent, MenuItem, MessageDialog, MiniFrame, MirrorDC, MouseButton, MouseCaptureChangedEvent, MouseCaptureLostEvent, MouseEvent, MouseState, MouseWheelAxis, MoveEvent, MultiChoiceDialog, NavigationKeyEvent, NonOwnedWindow, Notebook, NotifyEvent, NumValidatorStyle, NumberEntryDialog, Object, OperatingSystemId, Orientation, OutCode, OutputStream, Overlay, OwnerDrawnComboBox, OwnerDrawnComboBoxPaintingFlags, PaintDC, PaintEvent, Palette, PaletteChangedEvent, PanGestureEvent, Panel, PaperSize, PasswordEntryDialog, Pen, PenCap, PenInfo, PenJoin, PenQuality, PenStyle, PersistenceManager, PersistentBookCtrl, PersistentComboBox, PersistentObject, PersistentTLW, PersistentTreeBookCtrl, PersistentWindowBase, PickerBase, PlatformInfo, Point, Point2DDouble, Point2DInt, PolygonFillMode, PopupTransientWindow, PopupWindow, PortId, PressAndTapEvent, PrintMode, PrintOrientation, ProgressDialog, PropertySheetDialog, PropertySheetDialogFlags, QueryLayoutInfoEvent, QueryNewPaletteEvent, RadioBox, RadioButton, RasterOperationMode, RealPoint, RearrangeCtrl, RearrangeList, Rect, Region, RegionContain, RegionIterator, RotateGestureEvent, SVGBitmapEmbedHandler, SVGBitmapFileHandler, SVGBitmapHandler, SVGFileDC, SVGShapeRenderingMode, SashDragStatus, SashEdgePosition, SashEvent, SashLayoutWindow, SashWindow, ScaledDC, ScreenDC, ScrollBar, ScrollEvent, ScrollWinEvent, ScrollbarVisibility, ScrolledCanvas, ScrolledControl, ScrolledWindow, SearchCtrl, SecretStore, SecretValue, SeekMode, SetCursorEvent, SettableHeaderColumn, ShowEffect, ShowEvent, Simplebook, SingleChoiceDialog, Size, SizeEvent, Sizer, SizerFlagBits, SizerFlags, SizerItem, Slider, SpinButton, SpinCtrl, SpinCtrlDouble, SpinDoubleEvent, SpinEvent, SplashScreen, SplitMode, SplitterEvent, SplitterWindow, StandardID, StandardPaths, StaticBitmap, StaticBox, StaticBoxSizer, StaticLine, StaticText, StatusBar, StatusBarPane, StdDialogButtonSizer, StockCursor, StreamBase, StreamError, Stretch, SysColourChangedEvent, SystemColour, SystemFeature, SystemFont, SystemMetric, SystemOptions, SystemScreenType, SystemSettings, TaskBarButton, TaskBarIcon, TaskBarIconEvent, TaskBarIconType, TextAttr, TextAttrAlignment, TextAttrBulletStyle, TextAttrEffects, TextAttrFlags, TextAttrLineSpacing, TextAttrUnderlineType, TextCompleter, TextCompleterSimple, TextCtrl, TextCtrlHitTestResult, TextDataObject, TextDropTarget, TextEntryDialog, TextProofOptions, TextValidator, TextValidatorStyle, ThumbBarButton, TimePickerCtrl, Timer, TimerEvent, TipProvider, ToggleButton, ToolBar, ToolBarToolBase, ToolBarToolStyle, ToolTip, Toolbook, TopLevelWindow, TreeCtrl, TreeEvent, TreeItemIcon, TreeItemId, Treebook, TwoFingerTapEvent, UIActionSimulator, URLDataObject, UnsignedValidator, UpdateUI, UpdateUIEvent, UpdateUIMode, VBoxSizer, VListBox, VScrolledWindow, VWrapSizer, Validator, Variant, VersionInfo, VisualAttributes, WebCredentials, Window, WindowCreateEvent, WindowDC, WindowDestroyEvent, WindowDisabler, WindowVariant, Wizard, WizardEvent, WizardPage, WizardPageSimple, WrapSizer, XmlDocumentLoadFlag, XmlNode, XmlNodeType, XmlResource, XmlResourceFlags, XmlSubclassFactory, ZoomGestureEvent

Managing stock IDs collapse

STOCK_NOFLAGS = 
0
STOCK_WITH_MNEMONIC = 
1
STOCK_WITH_ACCELERATOR = 
2
STOCK_WITHOUT_ELLIPSIS = 
4
STOCK_FOR_BUTTON = 
STOCK_WITHOUT_ELLIPSIS | STOCK_WITH_MNEMONIC
STOCK_MENU = 
0

Constant Summary collapse

FLP_OPEN = 
1024
FLP_SAVE = 
2048
FLP_OVERWRITE_PROMPT = 
4096
FLP_FILE_MUST_EXIST = 
8192
FLP_CHANGE_DIR = 
16384
FLP_SMALL = 
32768
FLP_USE_TEXTCTRL = 
2
FLP_DEFAULT_STYLE = 
9216
DIRP_DIR_MUST_EXIST = 
8
DIRP_CHANGE_DIR = 
16
DIRP_SMALL = 
32768
DIRP_USE_TEXTCTRL = 
2
DIRP_DEFAULT_STYLE = 
8
EVT_FILEPICKER_CHANGED = 
10157
EVT_DIRPICKER_CHANGED = 
10158
ODCB_DCLICK_CYCLES =

Double-clicking cycles item if CB_READONLY is also used.

256
ODCB_STD_CONTROL_PAINT =

If used, control itself is not custom paint using callback.

4096
EVT_WEBREQUEST_STATE = 
10326
EVT_WEBREQUEST_DATA = 
10327
ThePenList = 
Wx::Pen
TheFontList =

In wxRuby this is simply an alias for the Font class.

Font
TheBrushList =

In wxRuby this is simply an alias for the Brush class.

Wx::Brush
DEFAULT_DATE_TIME_FORMAT =

These constants are not documented in the wxWidgets interface headers although they are referenced in various argument defaults which are in the interface header declarations so we do want them included the wxRuby docs so the doc links work.

'%c'
DEFAULT_TIME_SPAN_FORMAT = 
'%H:%M:%S'
CHOICE_NAME_STR = 
'choice'
COLOUR_PICKER_CTRL_NAME_STR = 
'colourpicker'
COLOUR_PICKER_WIDGET_NAME_STR = 
'colourpickerwidget'
'hyperlink'
PANEL_NAME_STR = 
'panel'
LIST_BOX_NAME_STR = 
'listBox'
FRAME_NAME_STR = 
'frame'
STATUS_LINE_NAME_STR = 
'status_line'
STATIC_BITMAP_NAME_STR = 
'staticBitmap'
WEB_VIEW_NAME_STR = 
'wxWebView'
ANIMATION_CTRL_NAME_STR = 
'animationctrl'
TOOL_BAR_NAME_STR = 
'toolbar'
TEXT_CTRL_NAME_STR = 
'text'
LIST_CTRL_NAME_STR = 
'listCtrl'
FILE_PICKER_CTRL_NAME_STR = 
'filepicker'
FILE_PICKER_WIDGET_NAME_STR = 
'filepickerwidget'
DIR_PICKER_CTRL_NAME_STR = 
'dirpicker'
DIR_PICKER_WIDGET_NAME_STR = 
'dirpickerwidget'
FILE_CTRL_NAME_STR = 
'wxfilectrl'
FILE_SELECTOR_PROMPT_STR = 
'Select a file'
STATIC_BOX_NAME_STR = 
'groupBox'
BUTTON_NAME_STR = 
'button'
RADIO_BOX_NAME_STR = 
'radioBox'
STATIC_LINE_NAME_STR = 
'staticLine'
RADIO_BUTTON_NAME_STR = 
'radioButton'
BITMAP_RADIO_BUTTON_NAME_STR = 
'radioButton'
GAUGE_NAME_STR = 
'gauge'
DATA_VIEW_CTRL_NAME_STR = 
'dataviewCtrl'
FONT_PICKER_CTRL_NAME_STR = 
'fontpicker'
FONT_PICKER_WIDGET_NAME_STR = 
'fontpickerwidget'
REARRANGE_LIST_NAME_STR = 
'wxRearrangeList'
REARRANGE_DIALOG_NAME_STR = 
'wxRearrangeDlg'
NOTEBOOK_NAME_STR = 
'notebook'
CONTROL_NAME_STR = 
'control'
SCROLL_BAR_NAME_STR = 
'scrollBar'
STATUS_BAR_NAME_STR = 
'statusBar'
SLIDER_NAME_STR = 
'slider'
HEADER_CTRL_NAME_STR = 
'wxHeaderCtrl'
BITMAP_COMBO_BOX_NAME_STR = 
'bitmapComboBox'
CHECK_BOX_NAME_STR = 
'check'
FILE_DIALOG_NAME_STR = 
'filedlg'
ADD_REMOVE_CTRL_NAME_STR = 
'wxAddRemoveCtrl'
STATIC_TEXT_NAME_STR = 
'staticText'
COMBO_BOX_NAME_STR = 
'comboBox'
SEARCH_CTRL_NAME_STR = 
'searchCtrl'
TREE_CTRL_NAME_STR = 
'treeCtrl'
DIALOG_NAME_STR = 
'dialog'
COLLAPSIBLE_HEADER_CTRL_NAME_STR = 
'collapsibleHeader'
COLLAPSIBLE_PANE_NAME_STR = 
'collapsiblePane'
'bannerwindow'
GRID_NAME_STR = 
'grid'
TREE_LIST_CTRL_NAME_STR = 
'wxTreeListCtrl'
HTML_LIST_BOX_NAME_STR = 
'htmlListBox'
SIMPLE_HTML_LIST_BOX_NAME_STR = 
'simpleHtmlListBox'
HTML_WINDOW_NAME_STR = 
'htmlWindow'
EDITABLE_LIST_BOX_NAME_STR = 
'editableListBox'
V_LIST_BOX_NAME_STR = 
'wxVListBox'
ACTIVITY_INDICATOR_NAME_STR = 
'activityindicator'
TIME_PICKER_CTRL_NAME_STR = 
'timectrl'
DATE_PICKER_CTRL_NAME_STR = 
'datectrl'
CALENDAR_NAME_STR = 
'CalendarCtrl'
SPIN_BUTTON_NAME_STR = 
'wxSpinButton'
MSW_HEADER_CTRL_NAME_STR =

wxMSW only

'wxMSWHeaderCtrl'
PROPERTY_GRID_MANAGER_NAME_STR = 
'wxPropertyGridManager'
PROPERTY_GRID_NAME_STR = 
'wxPropertyGrid'
STC_NAME_STR = 
'stcwindow'
MEDIA_CTRL_NAME_STR = 
'mediaCtrl'
SPIN_CTRL_NAME_STR = 
'spinCtrl'
SPIN_CTRL_DOUBLE_NAME_STR = 
'wxSpinCtrlDouble'
SPLITTER_WINDOW_NAME_STR = 
'splitter'
TOOLBOOK_NAME_STR = 
'toolbook'
TREEBOOK_NAME_STR = 
'treebook'
SASH_WINDOW_NAME_STR = 
'sashWindow'
SASH_LAYOUT_WINDOW_NAME_STR = 
'layoutWindow'
SCROLLED_NAME_STR = 
'SCROLLED_WINDOW'
ICON_DEFAULT_TYPE =

Default BitmapType for current platform. Actual value is platform dependent.

Wx::BitmapType::BITMAP_TYPE_ANY
BITMAP_DEFAULT_TYPE =

Default BitmapType for current platform. Actual value is platform dependent.

Wx::BitmapType::BITMAP_TYPE_ANY
CURSOR_DEFAULT_TYPE =

Default BitmapType for current platform. Actual value is platform dependent.

Wx::BitmapType::BITMAP_TYPE_ANY
TRANSPARENT_COLOUR = 
Wx::Colour.new(0, 0, 0, Wx::ALPHA_TRANSPARENT)
EVT_COMMAND_SCROLL_TOP = 
EVT_SCROLL_TOP
EVT_COMMAND_SCROLL_BOTTOM = 
EVT_SCROLL_BOTTOM
EVT_COMMAND_SCROLL_LINEUP = 
EVT_SCROLL_LINEUP
EVT_COMMAND_SCROLL_LINEDOWN = 
EVT_SCROLL_LINEDOWN
EVT_COMMAND_SCROLL_PAGEUP = 
EVT_SCROLL_PAGEUP
EVT_COMMAND_SCROLL_PAGEDOWN = 
EVT_SCROLL_PAGEDOWN
EVT_COMMAND_SCROLL_THUMBTRACK = 
EVT_SCROLL_THUMBTRACK
EVT_COMMAND_SCROLL_THUMBRELEASE = 
EVT_SCROLL_THUMBRELEASE
EVT_COMMAND_SCROLL_CHANGED = 
EVT_SCROLL_CHANGED
NULL_PEN =

An empty pen.

nil
DEFAULT_DATE_TIME =

Default/Null time (mostly equates to now).

nil
DefaultDateTime =

Default/Null time (mostly equates to now).

DEFAULT_DATE_TIME
WXRUBY_VERSION =

wxRuby version string

'1.3.1'
WXRUBY_RELEASE_TYPE =

wxRuby version release type (alpha, beta, rc)

''
WXRUBY_MAJOR =

wxRuby major version number

1
WXRUBY_MINOR =

wxRuby minor version number

3
WXRUBY_RELEASE =

wxRuby release number

1
WXWIDGETS_VERSION =

Convenience string for WxWidgets version info

'3.2.6'
WXWIDGETS_MAJOR_VERSION =

Integer constant reflecting the major version of the wxWidgets release used to build wxRuby

3
WXWIDGETS_MINOR_VERSION =

Integer constant reflecting the minor version of the wxWidgets release used to build wxRuby

2
WXWIDGETS_RELEASE_NUMBER =

Integer constant reflecting the release number of the wxWidgets release used to build wxRuby

6
WXWIDGETS_SUBRELEASE_NUMBER =

Integer constant reflecting the sub-release number of the wxWidgets release used to build wxRuby

0
WXWIDGETS_DEBUG_LEVEL =

Integer constant reflecting the wxWidgets wxDEBUG_LEVEL

1
DEBUG =

Boolean constant indicating if wxRuby was build in debug (true) or release (false) mode

false
PLATFORM =

Platform id of the wxWidgets port used to build wxRuby

'WXGTK'
SIZE_AUTO_WIDTH = 
1
SIZE_AUTO_HEIGHT = 
2
SIZE_AUTO = 
3
SIZE_USE_EXISTING = 
0
SIZE_ALLOW_MINUS_ONE = 
4
SIZE_NO_ADJUSTMENTS = 
8
SIZE_FORCE = 
16
SIZE_FORCE_EVENT = 
32
VSCROLL = 
-2147483648
HSCROLL = 
1073741824
CAPTION = 
536870912
DOUBLE_BORDER = 
268435456
SUNKEN_BORDER = 
134217728
RAISED_BORDER = 
67108864
BORDER = 
33554432
SIMPLE_BORDER = 
33554432
STATIC_BORDER = 
16777216
NO_BORDER = 
2097152
ALWAYS_SHOW_SB = 
8388608
CLIP_CHILDREN = 
4194304
CLIP_SIBLINGS = 
536870912
TRANSPARENT_WINDOW = 
1048576
TAB_TRAVERSAL = 
524288
WANTS_CHARS = 
262144
RETAINED = 
0
BACKINGSTORE = 
0
131072
FULL_REPAINT_ON_RESIZE = 
65536
NO_FULL_REPAINT_ON_RESIZE = 
0
WINDOW_STYLE_MASK = 
-65536
WS_EX_BLOCK_EVENTS = 
2
WS_EX_TRANSIENT = 
4
WS_EX_THEMED_BACKGROUND = 
8
WS_EX_PROCESS_IDLE = 
16
WS_EX_PROCESS_UI_UPDATES = 
32
FRAME_EX_METAL = 
64
DIALOG_EX_METAL = 
64
WS_EX_CONTEXTHELP = 
128
FRAME_EX_CONTEXTHELP = 
128
DIALOG_EX_CONTEXTHELP = 
128
FRAME_DRAWER = 
32
FRAME_NO_WINDOW_MENU = 
256
MB_DOCKABLE = 
1
1
COLOURED = 
2048
FIXED_LENGTH = 
1024
LB_SORT = 
16
LB_SINGLE = 
32
LB_MULTIPLE = 
64
LB_EXTENDED = 
128
LB_NEEDED_SB = 
0
LB_OWNERDRAW = 
256
LB_ALWAYS_SB = 
512
LB_NO_SB = 
1024
LB_HSCROLL = 
1073741824
LB_INT_HEIGHT = 
2048
CB_SIMPLE = 
4
CB_SORT = 
8
CB_READONLY = 
16
CB_DROPDOWN = 
32
RA_LEFTTORIGHT = 
1
RA_TOPTOBOTTOM = 
2
RA_SPECIFY_COLS = 
4
RA_SPECIFY_ROWS = 
8
RA_HORIZONTAL = 
4
RA_VERTICAL = 
8
RB_GROUP = 
4
RB_SINGLE = 
8
SB_HORIZONTAL = 
4
SB_VERTICAL = 
8
SP_HORIZONTAL = 
4
SP_VERTICAL = 
8
SP_ARROW_KEYS = 
16384
SP_WRAP = 
32768
TC_RIGHTJUSTIFY = 
16
TC_FIXEDWIDTH = 
32
TC_TOP = 
0
TC_LEFT = 
32
TC_RIGHT = 
64
TC_BOTTOM = 
128
TC_MULTILINE = 
512
TC_OWNERDRAW = 
1024
BI_EXPAND = 
8192
LI_HORIZONTAL = 
4
LI_VERTICAL = 
8
YES = 
2
OK = 
4
NO = 
8
YES_NO = 
10
CANCEL = 
16
APPLY = 
32
CLOSE = 
64
OK_DEFAULT = 
0
YES_DEFAULT = 
0
NO_DEFAULT = 
128
CANCEL_DEFAULT = 
-2147483648
ICON_EXCLAMATION = 
256
ICON_HAND = 
512
ICON_WARNING = 
256
ICON_ERROR = 
512
ICON_QUESTION = 
1024
ICON_INFORMATION = 
2048
ICON_STOP = 
512
ICON_ASTERISK = 
2048
HELP = 
4096
FORWARD = 
8192
BACKWARD = 
16384
RESET = 
32768
MORE = 
65536
SETUP = 
131072
ICON_NONE = 
262144
ICON_AUTH_NEEDED = 
524288
ICON_MASK = 
265984
NOT_FOUND = 
-1
-1
-2
-3
-4
STAY_ON_TOP = 
32768
ICONIZE = 
16384
MINIMIZE = 
16384
MAXIMIZE = 
8192
CLOSE_BOX = 
4096
SYSTEM_MENU = 
2048
MINIMIZE_BOX = 
1024
MAXIMIZE_BOX = 
512
TINY_CAPTION = 
128
RESIZE_BORDER = 
64
DEFAULT_COORD =

A special value meaning “use default coordinate”.

-1
NULL_FONT =

An empty Font.

nil
ICON_SCREEN_DEPTH = 
-1
NULL_ICON =

An empty Icon.

nil
NULL_ICON_BUNDLE =

An empty IconBundle.

nil
FONTRESTRICT_NONE = 
0
FONTRESTRICT_SCALABLE = 
1 << 0
FONTRESTRICT_FIXEDPITCH = 
1 << 1
NULL_BRUSH =

An empty brush.

nil
JOYSTICK1 = 
0
JOYSTICK2 = 
1
JOY_BUTTON_ANY = 
-1
JOY_BUTTON1 = 
1
JOY_BUTTON2 = 
2
JOY_BUTTON3 = 
4
JOY_BUTTON4 = 
8
EVT_NULL =

A special event type usually used to indicate that some Event has yet no type assigned.

10003
EVT_ANY = 
-1
EVT_BUTTON = 
10007
EVT_CHECKBOX = 
10008
EVT_CHOICE = 
10009
EVT_LISTBOX = 
10010
EVT_LISTBOX_DCLICK = 
10011
EVT_CHECKLISTBOX = 
10012
EVT_MENU = 
10013
EVT_SLIDER = 
10014
EVT_RADIOBOX = 
10015
EVT_RADIOBUTTON = 
10016
EVT_SCROLLBAR = 
10017
EVT_VLBOX = 
10018
EVT_COMBOBOX = 
10019
EVT_TOOL_RCLICKED = 
10020
EVT_TOOL_DROPDOWN = 
10022
EVT_TOOL_ENTER = 
10021
EVT_COMBOBOX_DROPDOWN = 
10023
EVT_COMBOBOX_CLOSEUP = 
10024
EVT_THREAD = 
10005
EVT_LEFT_DOWN = 
10025
EVT_LEFT_UP = 
10026
EVT_MIDDLE_DOWN = 
10027
EVT_MIDDLE_UP = 
10028
EVT_RIGHT_DOWN = 
10029
EVT_RIGHT_UP = 
10030
EVT_MOTION = 
10031
EVT_ENTER_WINDOW = 
10032
EVT_LEAVE_WINDOW = 
10033
EVT_LEFT_DCLICK = 
10034
EVT_MIDDLE_DCLICK = 
10035
EVT_RIGHT_DCLICK = 
10036
EVT_SET_FOCUS = 
10037
EVT_KILL_FOCUS = 
10038
EVT_CHILD_FOCUS = 
10039
EVT_MOUSEWHEEL = 
10040
EVT_MAGNIFY = 
10047
EVT_AUX1_DOWN = 
10041
EVT_AUX1_UP = 
10042
EVT_AUX1_DCLICK = 
10043
EVT_AUX2_DOWN = 
10044
EVT_AUX2_UP = 
10045
EVT_AUX2_DCLICK = 
10046
EVT_CHAR = 
10048
EVT_CHAR_HOOK = 
10050
EVT_NAVIGATION_KEY = 
10051
EVT_KEY_DOWN = 
10052
EVT_KEY_UP = 
10053
EVT_SET_CURSOR = 
10054
EVT_SCROLL_TOP = 
10055
EVT_SCROLL_BOTTOM = 
10056
EVT_SCROLL_LINEUP = 
10057
EVT_SCROLL_LINEDOWN = 
10058
EVT_SCROLL_PAGEUP = 
10059
EVT_SCROLL_PAGEDOWN = 
10060
EVT_SCROLL_THUMBTRACK = 
10061
EVT_SCROLL_THUMBRELEASE = 
10062
EVT_SCROLL_CHANGED = 
10063
EVT_SPIN_UP = 
10057
EVT_SPIN_DOWN = 
10058
EVT_SPIN = 
10061
EVT_SCROLLWIN_TOP = 
10064
EVT_SCROLLWIN_BOTTOM = 
10065
EVT_SCROLLWIN_LINEUP = 
10066
EVT_SCROLLWIN_LINEDOWN = 
10067
EVT_SCROLLWIN_PAGEUP = 
10068
EVT_SCROLLWIN_PAGEDOWN = 
10069
EVT_SCROLLWIN_THUMBTRACK = 
10070
EVT_SCROLLWIN_THUMBRELEASE = 
10071
EVT_GESTURE_PAN = 
10072
EVT_GESTURE_ZOOM = 
10073
EVT_GESTURE_ROTATE = 
10074
EVT_TWO_FINGER_TAP = 
10075
EVT_LONG_PRESS = 
10076
EVT_PRESS_AND_TAP = 
10077
EVT_SIZE = 
10078
EVT_MOVE = 
10080
EVT_CLOSE_WINDOW = 
10084
EVT_END_SESSION = 
10085
EVT_QUERY_END_SESSION = 
10086
EVT_ACTIVATE_APP = 
10088
EVT_ACTIVATE = 
10089
EVT_CREATE = 
10090
EVT_DESTROY = 
10091
EVT_SHOW = 
10092
EVT_ICONIZE = 
10093
EVT_MAXIMIZE = 
10094
EVT_FULLSCREEN = 
10095
EVT_PAINT = 
10098
EVT_ERASE_BACKGROUND = 
10099
EVT_NC_PAINT = 
10100
EVT_MENU_OPEN = 
10101
EVT_MENU_CLOSE = 
10102
EVT_MENU_HIGHLIGHT = 
10103
EVT_CONTEXT_MENU = 
10104
EVT_SYS_COLOUR_CHANGED = 
10105
EVT_DPI_CHANGED = 
10107
EVT_QUERY_NEW_PALETTE = 
10108
EVT_PALETTE_CHANGED = 
10109
EVT_JOY_BUTTON_DOWN = 
10110
EVT_JOY_BUTTON_UP = 
10111
EVT_JOY_MOVE = 
10112
EVT_JOY_ZMOVE = 
10113
EVT_DROP_FILES = 
10114
EVT_INIT_DIALOG = 
10115
EVT_IDLE = 
10004
EVT_UPDATE_UI = 
10116
EVT_SIZING = 
10079
EVT_MOVING = 
10081
EVT_MOVE_START = 
10082
EVT_MOVE_END = 
10083
EVT_HIBERNATE = 
10087
EVT_TEXT_COPY = 
10117
EVT_TEXT_CUT = 
10118
EVT_TEXT_PASTE = 
10119
EVT_COMMAND_LEFT_CLICK = 
10120
EVT_COMMAND_LEFT_DCLICK = 
10121
EVT_COMMAND_RIGHT_CLICK = 
10122
EVT_COMMAND_RIGHT_DCLICK = 
10123
EVT_COMMAND_SET_FOCUS = 
10124
EVT_COMMAND_KILL_FOCUS = 
10125
EVT_COMMAND_ENTER = 
10126
EVT_HELP = 
10127
EVT_DETAILED_HELP = 
10128
EVT_TOOL = 
10013
EVT_WINDOW_MODAL_DIALOG_CLOSED = 
10147
EVT_MENU_HIGHLIGHT_ALL = 
10103
FRAME_NO_TASKBAR = 
2
FRAME_TOOL_WINDOW = 
4
FRAME_FLOAT_ON_PARENT = 
8
GA_HORIZONTAL = 
4
GA_VERTICAL = 
8
GA_PROGRESS = 
16
GA_SMOOTH = 
32
GA_TEXT = 
64
IMAGE_OPTION_QUALITY = 
"quality"
IMAGE_OPTION_FILENAME = 
"FileName"
IMAGE_OPTION_RESOLUTION = 
"Resolution"
IMAGE_OPTION_RESOLUTIONX = 
"ResolutionX"
IMAGE_OPTION_RESOLUTIONY = 
"ResolutionY"
IMAGE_OPTION_RESOLUTIONUNIT = 
"ResolutionUnit"
IMAGE_OPTION_MAX_WIDTH = 
"MaxWidth"
IMAGE_OPTION_MAX_HEIGHT = 
"MaxHeight"
IMAGE_OPTION_ORIGINAL_WIDTH = 
"OriginalWidth"
IMAGE_OPTION_ORIGINAL_HEIGHT = 
"OriginalHeight"
IMAGE_OPTION_BMP_FORMAT = 
"wxBMP_FORMAT"
IMAGE_OPTION_CUR_HOTSPOT_X = 
"HotSpotX"
IMAGE_OPTION_CUR_HOTSPOT_Y = 
"HotSpotY"
IMAGE_OPTION_GIF_COMMENT = 
"GifComment"
IMAGE_OPTION_GIF_TRANSPARENCY = 
"Transparency"
IMAGE_OPTION_GIF_TRANSPARENCY_HIGHLIGHT = 
"Highlight"
IMAGE_OPTION_GIF_TRANSPARENCY_UNCHANGED = 
"Unchanged"
IMAGE_OPTION_PNG_FORMAT = 
"PngFormat"
IMAGE_OPTION_PNG_BITDEPTH = 
"PngBitDepth"
IMAGE_OPTION_PNG_FILTER = 
"PngF"
IMAGE_OPTION_PNG_COMPRESSION_LEVEL = 
"PngZL"
IMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL = 
"PngZM"
IMAGE_OPTION_PNG_COMPRESSION_STRATEGY = 
"PngZS"
IMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE = 
"PngZB"
IMAGE_OPTION_TIFF_BITSPERSAMPLE = 
"BitsPerSample"
IMAGE_OPTION_TIFF_SAMPLESPERPIXEL = 
"SamplesPerPixel"
IMAGE_OPTION_TIFF_COMPRESSION = 
"Compression"
IMAGE_OPTION_TIFF_PHOTOMETRIC = 
"Photometric"
IMAGE_OPTION_TIFF_IMAGEDESCRIPTOR = 
"ImageDescriptor"
BMP_24BPP = 
24
BMP_8BPP = 
8
BMP_8BPP_GREY = 
9
BMP_8BPP_GRAY = 
9
BMP_8BPP_RED = 
10
BMP_8BPP_PALETTE = 
11
BMP_4BPP = 
4
BMP_1BPP = 
1
BMP_1BPP_BW = 
2
IMAGE_ALPHA_TRANSPARENT =

Constant used to indicate the alpha value conventionally defined as the complete transparency.

0
IMAGE_ALPHA_OPAQUE =

Constant used to indicate the alpha value conventionally defined as the complete opacity.

255
IMAGE_ALPHA_THRESHOLD = 
128
NULL_IMAGE =

An instance of an empty image without an alpha channel.

nil
Strip_Mnemonics =

Strip ‘&’ characters.

1
Strip_Accel =

Strip everything after ‘t’.

2
Strip_CJKMnemonics =

Strip everything looking like CJK mnemonic.

4
Strip_All =

Strip both mnemonics and accelerators.

3
Strip_Menu =

Strip everything from menu item labels.

7
AutoBufferedPaintDC =

This constant is set to either Wx::PaintDC if the platform supports native double buffering or Wx::BufferedPaintDC otherwise.

_
EventLoop =

In wxRuby simply an alias for GUIEventLoop.

GUIEventLoop
BITMAP_SCREEN_DEPTH = 
-1
NULL_BITMAP =

An empty Bitmap object.

nil
C2S_NAME = 
1
C2S_CSS_SYNTAX = 
2
C2S_HTML_SYNTAX = 
4
ALPHA_TRANSPARENT = 
0
ALPHA_OPAQUE = 
255
NULL_COLOUR = 
nil
NULL_CURSOR = 
nil
DIALOG_NO_PARENT = 
32
DEFAULT_DIALOG_STYLE = 
536877056
DIALOG_ADAPTATION_NONE = 
0
DIALOG_ADAPTATION_STANDARD_SIZER = 
1
DIALOG_ADAPTATION_ANY_SIZER = 
2
DIALOG_ADAPTATION_LOOSE_BUTTONS = 
3
SL_HORIZONTAL = 
4
SL_VERTICAL = 
8
SL_TICKS = 
16
SL_AUTOTICKS = 
16
SL_LEFT = 
64
SL_TOP = 
128
SL_RIGHT = 
256
SL_BOTTOM = 
512
SL_BOTH = 
1024
SL_SELRANGE = 
2048
SL_INVERSE = 
4096
SL_MIN_MAX_LABELS = 
8192
SL_VALUE_LABEL = 
16384
SL_LABELS = 
24576
TOUCH_NONE =

Don’t generate any touch events.

0
TOUCH_VERTICAL_PAN_GESTURE =

Generate PanGestureEvent for vertical pans.

1
TOUCH_HORIZONTAL_PAN_GESTURE =

Generate PanGestureEvent for horizontal pans.

2
TOUCH_PAN_GESTURES =

Generate PanGestureEvent for any pans.

3
TOUCH_ZOOM_GESTURE =

Generate ZoomGestureEvent.

4
TOUCH_ROTATE_GESTURE =

Generate RotateGestureEvent.

8
TOUCH_PRESS_GESTURES =

Generate events for press or tap gestures such as TwoFingerTapEvent, LongPressEvent and PressAndTapEvent.

16
TOUCH_ALL_GESTURES =

Enable all supported gesture events.

31
SEND_EVENT_POST = 
1
NULL_PALETTE =

An empty palette.

nil
LB_DEFAULT = 
0
LB_TOP = 
16
LB_BOTTOM = 
32
LB_LEFT = 
64
LB_RIGHT = 
128
LB_ALIGN_MASK = 
240
EVT_LISTBOOK_PAGE_CHANGED = 
10232
EVT_LISTBOOK_PAGE_CHANGING = 
10231
NB_DEFAULT = 
0
NB_TOP = 
16
NB_BOTTOM = 
32
NB_LEFT = 
64
NB_RIGHT = 
128
NB_FIXEDWIDTH = 
256
NB_MULTILINE = 
512
NB_NOPAGETHEME = 
1024
NB_HITTEST_NOWHERE = 
1
NB_HITTEST_ONICON = 
2
NB_HITTEST_ONLABEL = 
4
NB_HITTEST_ONITEM = 
16
NB_HITTEST_ONPAGE = 
8
EVT_NOTEBOOK_PAGE_CHANGED = 
10195
EVT_NOTEBOOK_PAGE_CHANGING = 
10196
TB_HORIZONTAL =

lay out the toolbar horizontally

4
TB_TOP = 
4
TB_VERTICAL =

lay out the toolbar vertically

8
TB_LEFT = 
8
TB_FLAT =

“flat” buttons (Win32/GTK only)

32
TB_DOCKABLE =

dockable toolbar (GTK only)

64
TB_NOICONS =

don’t show the icons (they’re shown by default)

128
TB_TEXT =

show the text (not shown by default)

256
TB_NODIVIDER =

don’t show the divider between toolbar and the window (Win32 only)

512
TB_NOALIGN =

no automatic alignment (Win32 only, useless)

1024
TB_HORZ_LAYOUT =

show the text and the icons alongside, not vertically stacked (Win32/GTK)

2048
TB_HORZ_TEXT = 
2304
TB_NO_TOOLTIPS =

don’t show the toolbar short help tooltips

4096
TB_BOTTOM =

lay out toolbar at the bottom of the window

8192
TB_RIGHT =

lay out toolbar at the right edge of the window

16384
TB_DEFAULT_STYLE =

flags that are closest to the native look

4
TBK_BUTTONBAR = 
256
TBK_HORZ_LAYOUT = 
32768
EVT_TOOLBOOK_PAGE_CHANGED = 
10239
EVT_TOOLBOOK_PAGE_CHANGING = 
10238
EVT_TREEBOOK_PAGE_CHANGED = 
10241
EVT_TREEBOOK_PAGE_CHANGING = 
10240
EVT_TREEBOOK_NODE_COLLAPSED = 
10242
EVT_TREEBOOK_NODE_EXPANDED = 
10243
XML_NO_INDENTATION = 
-1
AC_NO_AUTORESIZE = 
16
AC_DEFAULT_STYLE = 
2097152
NULL_ANIMATION =

An empty animation object.

nil
CHK_2STATE = 
16384
CHK_3STATE = 
4096
CHK_ALLOW_3RD_STATE_FOR_USER = 
8192
Drag_CopyOnly =

Allow only copying.

0
Drag_AllowMove =

Allow moving too (copying is always allowed).

1
Drag_DefaultMove =

Allow moving and make it default operation.

3
FC_DEFAULT_STYLE = 
1
FC_OPEN = 
1
FC_SAVE = 
2
FC_MULTIPLE = 
4
FC_NOSHOWHIDDEN = 
8
EVT_FILECTRL_SELECTIONCHANGED = 
10153
EVT_FILECTRL_FILEACTIVATED = 
10154
EVT_FILECTRL_FOLDERCHANGED = 
10155
EVT_FILECTRL_FILTERCHANGED = 
10156
LC_VRULES = 
1
LC_HRULES = 
2
LC_ICON = 
4
LC_SMALL_ICON = 
8
LC_LIST = 
16
LC_REPORT = 
32
LC_ALIGN_TOP = 
64
LC_ALIGN_LEFT = 
128
LC_AUTOARRANGE = 
256
LC_VIRTUAL = 
512
LC_EDIT_LABELS = 
1024
LC_NO_HEADER = 
2048
LC_NO_SORT_HEADER = 
4096
LC_SINGLE_SEL = 
8192
LC_SORT_ASCENDING = 
16384
LC_SORT_DESCENDING = 
32768
LC_MASK_TYPE = 
60
LC_MASK_ALIGN = 
192
LC_MASK_SORT = 
49152
LIST_MASK_STATE = 
1
LIST_MASK_TEXT = 
2
LIST_MASK_IMAGE = 
4
LIST_MASK_DATA = 
8
LIST_SET_ITEM = 
16
LIST_MASK_WIDTH = 
32
LIST_MASK_FORMAT = 
64
LIST_STATE_DONTCARE = 
0
LIST_STATE_DROPHILITED = 
1
LIST_STATE_FOCUSED = 
2
LIST_STATE_SELECTED = 
4
LIST_STATE_CUT = 
8
LIST_HITTEST_ABOVE = 
1
LIST_HITTEST_BELOW = 
2
LIST_HITTEST_NOWHERE = 
4
LIST_HITTEST_ONITEMICON = 
32
LIST_HITTEST_ONITEMLABEL = 
128
LIST_HITTEST_ONITEMSTATEICON = 
512
LIST_HITTEST_TOLEFT = 
1024
LIST_HITTEST_TORIGHT = 
2048
LIST_HITTEST_ONITEM = 
672
LIST_GETSUBITEMRECT_WHOLEITEM = 
-1
LIST_NEXT_ABOVE = 
0
LIST_NEXT_ALL = 
1
LIST_NEXT_BELOW = 
2
LIST_NEXT_LEFT = 
3
LIST_NEXT_RIGHT = 
4
LIST_ALIGN_DEFAULT = 
0
LIST_ALIGN_LEFT = 
1
LIST_ALIGN_TOP = 
2
LIST_ALIGN_SNAP_TO_GRID = 
3
LIST_AUTOSIZE = 
-1
LIST_AUTOSIZE_USEHEADER = 
-2
LIST_RECT_BOUNDS = 
0
LIST_RECT_ICON = 
1
LIST_RECT_LABEL = 
2
LIST_FIND_UP = 
0
LIST_FIND_DOWN = 
1
LIST_FIND_LEFT = 
2
LIST_FIND_RIGHT = 
3
EVT_LIST_BEGIN_DRAG = 
10173
EVT_LIST_BEGIN_RDRAG = 
10174
EVT_LIST_BEGIN_LABEL_EDIT = 
10175
EVT_LIST_END_LABEL_EDIT = 
10176
EVT_LIST_DELETE_ITEM = 
10177
EVT_LIST_DELETE_ALL_ITEMS = 
10178
EVT_LIST_ITEM_SELECTED = 
10179
EVT_LIST_ITEM_DESELECTED = 
10180
EVT_LIST_KEY_DOWN = 
10181
EVT_LIST_INSERT_ITEM = 
10182
EVT_LIST_COL_CLICK = 
10183
EVT_LIST_ITEM_RIGHT_CLICK = 
10188
EVT_LIST_ITEM_MIDDLE_CLICK = 
10189
EVT_LIST_ITEM_ACTIVATED = 
10190
EVT_LIST_CACHE_HINT = 
10194
EVT_LIST_COL_RIGHT_CLICK = 
10184
EVT_LIST_COL_BEGIN_DRAG = 
10185
EVT_LIST_COL_DRAGGING = 
10186
EVT_LIST_COL_END_DRAG = 
10187
EVT_LIST_ITEM_FOCUSED = 
10191
EVT_LIST_ITEM_CHECKED = 
10192
EVT_LIST_ITEM_UNCHECKED = 
10193
BUFFER_VIRTUAL_AREA = 
1
BUFFER_CLIENT_AREA = 
2
BUFFER_USES_SHARED_BUFFER = 
4
EVT_SPINCTRL = 
10197
EVT_SPINCTRLDOUBLE = 
10198
TE_NO_VSCROLL = 
2
TE_READONLY = 
16
TE_MULTILINE = 
32
TE_PROCESS_TAB = 
64
TE_LEFT = 
0
TE_CENTER = 
256
TE_RIGHT = 
512
TE_CENTRE = 
256
TE_RICH = 
128
TE_PROCESS_ENTER = 
1024
TE_PASSWORD = 
2048
TE_AUTO_URL = 
4096
TE_NOHIDESEL = 
8192
TE_DONTWRAP = 
1073741824
TE_CHARWRAP = 
16384
TE_WORDWRAP = 
1
TE_BESTWRAP = 
0
TE_RICH2 = 
32768
TEXT_TYPE_ANY = 
0
EVT_TEXT = 
10201
EVT_TEXT_ENTER = 
10202
EVT_TEXT_URL = 
10203
EVT_TEXT_MAXLEN = 
10204
TR_NO_BUTTONS = 
0
TR_HAS_BUTTONS = 
1
TR_NO_LINES = 
4
TR_LINES_AT_ROOT = 
8
TR_TWIST_BUTTONS = 
16
TR_SINGLE = 
0
TR_MULTIPLE = 
32
TR_HAS_VARIABLE_ROW_HEIGHT = 
128
TR_EDIT_LABELS = 
512
TR_ROW_LINES = 
1024
TR_HIDE_ROOT = 
2048
TR_FULL_ROW_HIGHLIGHT = 
8192
TR_DEFAULT_STYLE = 
9
TREE_ITEMSTATE_NONE =

special values for the ‘state’ parameter of Wx::TreeCtrl#set_item_state

-1
TREE_ITEMSTATE_NEXT = 
-2
TREE_ITEMSTATE_PREV = 
-3
TREE_HITTEST_ABOVE = 
1
TREE_HITTEST_BELOW = 
2
TREE_HITTEST_NOWHERE = 
4
TREE_HITTEST_ONITEMBUTTON = 
8
TREE_HITTEST_ONITEMICON = 
16
TREE_HITTEST_ONITEMINDENT = 
32
TREE_HITTEST_ONITEMLABEL = 
64
TREE_HITTEST_ONITEMRIGHT = 
128
TREE_HITTEST_ONITEMSTATEICON = 
256
TREE_HITTEST_TOLEFT = 
512
TREE_HITTEST_TORIGHT = 
1024
TREE_HITTEST_ONITEMUPPERPART = 
2048
TREE_HITTEST_ONITEMLOWERPART = 
4096
TREE_HITTEST_ONITEM = 
80
EVT_TREE_BEGIN_DRAG = 
10205
EVT_TREE_BEGIN_RDRAG = 
10206
EVT_TREE_BEGIN_LABEL_EDIT = 
10207
EVT_TREE_END_LABEL_EDIT = 
10208
EVT_TREE_DELETE_ITEM = 
10209
EVT_TREE_GET_INFO = 
10210
EVT_TREE_SET_INFO = 
10211
EVT_TREE_ITEM_EXPANDED = 
10212
EVT_TREE_ITEM_EXPANDING = 
10213
EVT_TREE_ITEM_COLLAPSED = 
10214
EVT_TREE_ITEM_COLLAPSING = 
10215
EVT_TREE_SEL_CHANGED = 
10216
EVT_TREE_SEL_CHANGING = 
10217
EVT_TREE_KEY_DOWN = 
10218
EVT_TREE_ITEM_ACTIVATED = 
10219
EVT_TREE_ITEM_RIGHT_CLICK = 
10220
EVT_TREE_ITEM_MIDDLE_CLICK = 
10221
EVT_TREE_END_DRAG = 
10222
EVT_TREE_STATE_IMAGE_CLICK = 
10223
EVT_TREE_ITEM_GETTOOLTIP = 
10224
EVT_TREE_ITEM_MENU = 
10225
DEFAULT_VALIDATOR =

An empty, “null” Validator instance.

nil
NORMAL_FONT =

Equivalent to Wx::SystemSettings.get_font(Wx::SystemFont::SYS_DEFAULT_GUI_FONT)

Wx::SystemSettings.get_font(Wx::SystemFont::SYS_DEFAULT_GUI_FONT)
SMALL_FONT =

A font using the Wx::FONTFAMILY_SWISS family and 2 points smaller than Wx::NORMAL_FONT.

Wx::Font.new
ITALIC_FONT =

A font using the Wx::FONTFAMILY_ROMAN family and wxFONTSTYLE_ITALIC style and of the same size of Wx::NORMAL_FONT.

Wx::Font.new
SWISS_FONT =

A font identic to Wx::NORMAL_FONT except for the family used which is Wx::FONTFAMILY_SWISS.

Wx::Font.new
RED_PEN =

Red pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
CYAN_PEN =

Cyan pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
GREEN_PEN =

Green pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
BLACK_PEN =

Black pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
WHITE_PEN =

White pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
TRANSPARENT_PEN =

Transparent pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
BLACK_DASHED_PEN =

Black dashed pen. Except for the color and for the Wx::PENSTYLE_SHORT_DASH it has all standard attributes (1-pixel width, Wx::CAP_ROUND style, etc…).

Wx::Pen.new
GREY_PEN =

Grey pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
MEDIUM_GREY_PEN =

Medium-grey pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
LIGHT_GREY_PEN =

Light-grey pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
YELLOW_PEN =

Yellow pen. Except for the color it has all standard attributes (1-pixel width, Wx::PENSTYLE_SOLID and Wx::CAP_ROUND styles, etc…).

Wx::Pen.new
BLUE_BRUSH =

Blue brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
GREEN_BRUSH =

Green brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
WHITE_BRUSH =

White brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
BLACK_BRUSH =

Black brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
GREY_BRUSH =

Grey brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
MEDIUM_GREY_BRUSH =

Medium-grey brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
LIGHT_GREY_BRUSH =

Light-grey brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
TRANSPARENT_BRUSH =

Transparent brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
CYAN_BRUSH =

Cyan brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
RED_BRUSH =

Red brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
YELLOW_BRUSH =

Yellow brush Except for the color it has all standard attributes (Wx::BRUSHSTYLE_SOLID, no stipple bitmap, etc…).

Wx::Brush.new
STANDARD_CURSOR =

Standard cursor

Wx::Cursor.new
HOURGLASS_CURSOR =

Hourglass cursor

Wx::Cursor.new
CROSS_CURSOR =

Crosshair cursor

Wx::Cursor.new
BLACK = 
Wx::Colour.new
BLUE = 
Wx::Colour.new
CYAN = 
Wx::Colour.new
GREEN = 
Wx::Colour.new
YELLOW = 
Wx::Colour.new
LIGHT_GREY = 
Wx::Colour.new
RED = 
Wx::Colour.new
WHITE = 
Wx::Colour.new
BU_LEFT = 
64
BU_TOP = 
128
BU_RIGHT = 
256
BU_BOTTOM = 
512
BU_ALIGN_MASK = 
960
BU_EXACTFIT = 
1
BU_NOTEXT = 
2
BU_AUTODRAW = 
4
CHB_DEFAULT = 
0
CHB_TOP = 
16
CHB_BOTTOM = 
32
CHB_LEFT = 
64
CHB_RIGHT = 
128
CHB_ALIGN_MASK = 
240
EVT_CHOICEBOOK_PAGE_CHANGED = 
10227
EVT_CHOICEBOOK_PAGE_CHANGING = 
10226
CC_SPECIAL_DCLICK = 
256
CC_STD_BUTTON = 
512
EVT_DATE_CHANGED = 
10244
EVT_TIME_CHANGED = 
10245
DD_CHANGE_DIR = 
256
DD_DIR_MUST_EXIST = 
512
DD_MULTIPLE = 
1024
DD_SHOW_HIDDEN = 
1
DD_NEW_DIR_BUTTON = 
0
DD_DEFAULT_STYLE = 
536877120
DIR_DIALOG_DEFAULT_FOLDER_STR =

Initial folder for generic directory dialog.

"/"
DIR_SELECTOR_PROMPT_STR =

Default message for directory selector dialog.

"Select a directory"
DIR_DIALOG_NAME_STR =

Default name for directory selector dialog.

"wxDirCtrl"
DEFAULT_POSITION =

Global instance of a Point initialized with values (-1,-1).

Wx::Point.new(-1, -1)
DEFAULT_SIZE =

Global instance of a Size object initialized to (-1,-1).

Wx::Size.new(-1, -1)
IMAGELIST_DRAW_NORMAL = 
1
IMAGELIST_DRAW_TRANSPARENT = 
2
IMAGELIST_DRAW_SELECTED = 
4
IMAGELIST_DRAW_FOCUSED = 
8
IMAGE_LIST_NORMAL = 
0
IMAGE_LIST_SMALL = 
1
IMAGE_LIST_STATE = 
2
SW_NOBORDER = 
0
SW_BORDER = 
32
SW_3DSASH = 
64
SW_3DBORDER = 
128
SW_3D = 
192
EVT_SASH_DRAGGED = 
10279
EVT_SASH_DRAGGED_RANGE = 
10279
STB_SIZEGRIP = 
16
STB_SHOW_TIPS = 
32
STB_ELLIPSIZE_START = 
64
STB_ELLIPSIZE_MIDDLE = 
128
STB_ELLIPSIZE_END = 
256
STB_DEFAULT_STYLE = 
65840
SB_NORMAL = 
0
SB_FLAT = 
1
SB_RAISED = 
2
SB_SUNKEN = 
3
EXTEND_LAST_ON_EACH_LINE = 
1
REMOVE_LEADING_SPACES = 
2
WRAPSIZER_DEFAULT_FLAGS = 
3
NULL_ACCELERATOR_TABLE =

An empty accelerator table.

nil
FORMAT_INVALID = 
nil
FD_DEFAULT_STYLE = 
1
FD_OPEN = 
1
FD_SAVE = 
2
FD_OVERWRITE_PROMPT = 
4
FD_NO_FOLLOW = 
8
FD_FILE_MUST_EXIST = 
16
FD_CHANGE_DIR = 
128
FD_PREVIEW = 
256
FD_MULTIPLE = 
512
FD_SHOW_HIDDEN = 
1024
FILE_SELECTOR_DEFAULT_WILDCARD_STR =

Default wildcard string used in FileDialog corresponding to all files.

"*"
HD_ALLOW_REORDER = 
1
HD_ALLOW_HIDE = 
2
HD_BITMAP_ON_RIGHT = 
4
HD_DEFAULT_STYLE = 
1
COL_WIDTH_DEFAULT =

Special value used for column width meaning unspecified or default.

-1
COL_WIDTH_AUTOSIZE =

Size the column automatically to fit all values.

-2
COL_RESIZABLE =

Column can be resized (included in default flags).

1
COL_SORTABLE =

Column can be clicked to toggle the sort order by its contents.

2
COL_REORDERABLE =

Column can be dragged to change its order (included in default).

4
COL_HIDDEN =

Column is not shown at all.

8
COL_DEFAULT_FLAGS =

Default flags for HeaderColumn ctor.

5
MC_NO_AUTORESIZE = 
1
EVT_MEDIA_LOADED = 
10323
EVT_MEDIA_STOP = 
10324
EVT_MEDIA_FINISHED = 
10322
EVT_MEDIA_STATECHANGED = 
10319
EVT_MEDIA_PLAY = 
10320
EVT_MEDIA_PAUSE = 
10321
PB_USE_TEXTCTRL = 
2
PB_SMALL = 
32768
EVT_SEARCH_CANCEL = 
10199
EVT_SEARCH = 
10200
ST_NO_AUTORESIZE = 
1
ST_ELLIPSIZE_START = 
4
ST_ELLIPSIZE_MIDDLE = 
8
ST_ELLIPSIZE_END = 
16
TIMER_CONTINUOUS = 
0
TIMER_ONE_SHOT = 
1
EVT_TIMER = 
10001
ART_TOOLBAR = 
"wxART_TOOLBAR_C"
ART_MENU = 
"wxART_MENU_C"
ART_FRAME_ICON = 
"wxART_FRAME_ICON_C"
ART_CMN_DIALOG = 
"wxART_CMN_DIALOG_C"
ART_HELP_BROWSER = 
"wxART_HELP_BROWSER_C"
ART_MESSAGE_BOX = 
"wxART_MESSAGE_BOX_C"
ART_BUTTON = 
"wxART_BUTTON_C"
ART_LIST = 
"wxART_LIST_C"
ART_OTHER = 
"wxART_OTHER_C"
ART_ADD_BOOKMARK = 
"wxART_ADD_BOOKMARK"
ART_DEL_BOOKMARK = 
"wxART_DEL_BOOKMARK"
ART_HELP_SIDE_PANEL = 
"wxART_HELP_SIDE_PANEL"
ART_HELP_SETTINGS = 
"wxART_HELP_SETTINGS"
ART_HELP_BOOK = 
"wxART_HELP_BOOK"
ART_HELP_FOLDER = 
"wxART_HELP_FOLDER"
ART_HELP_PAGE = 
"wxART_HELP_PAGE"
ART_GO_BACK = 
"wxART_GO_BACK"
ART_GO_FORWARD = 
"wxART_GO_FORWARD"
ART_GO_UP = 
"wxART_GO_UP"
ART_GO_DOWN = 
"wxART_GO_DOWN"
ART_GO_TO_PARENT = 
"wxART_GO_TO_PARENT"
ART_GO_HOME = 
"wxART_GO_HOME"
ART_GOTO_FIRST = 
"wxART_GOTO_FIRST"
ART_GOTO_LAST = 
"wxART_GOTO_LAST"
ART_FILE_OPEN = 
"wxART_FILE_OPEN"
ART_FILE_SAVE = 
"wxART_FILE_SAVE"
ART_FILE_SAVE_AS = 
"wxART_FILE_SAVE_AS"
ART_PRINT = 
"wxART_PRINT"
ART_HELP = 
"wxART_HELP"
ART_TIP = 
"wxART_TIP"
ART_REPORT_VIEW = 
"wxART_REPORT_VIEW"
ART_LIST_VIEW = 
"wxART_LIST_VIEW"
ART_NEW_DIR = 
"wxART_NEW_DIR"
ART_HARDDISK = 
"wxART_HARDDISK"
ART_FLOPPY = 
"wxART_FLOPPY"
ART_CDROM = 
"wxART_CDROM"
ART_REMOVABLE = 
"wxART_REMOVABLE"
ART_FOLDER = 
"wxART_FOLDER"
ART_FOLDER_OPEN = 
"wxART_FOLDER_OPEN"
ART_GO_DIR_UP = 
"wxART_GO_DIR_UP"
ART_EXECUTABLE_FILE = 
"wxART_EXECUTABLE_FILE"
ART_NORMAL_FILE = 
"wxART_NORMAL_FILE"
ART_TICK_MARK = 
"wxART_TICK_MARK"
ART_CROSS_MARK = 
"wxART_CROSS_MARK"
ART_ERROR = 
"wxART_ERROR"
ART_QUESTION = 
"wxART_QUESTION"
ART_WARNING = 
"wxART_WARNING"
ART_INFORMATION = 
"wxART_INFORMATION"
ART_MISSING_IMAGE = 
"wxART_MISSING_IMAGE"
ART_COPY = 
"wxART_COPY"
ART_CUT = 
"wxART_CUT"
ART_PASTE = 
"wxART_PASTE"
ART_DELETE = 
"wxART_DELETE"
ART_NEW = 
"wxART_NEW"
ART_UNDO = 
"wxART_UNDO"
ART_REDO = 
"wxART_REDO"
ART_PLUS = 
"wxART_PLUS"
ART_MINUS = 
"wxART_MINUS"
ART_CLOSE = 
"wxART_CLOSE"
ART_QUIT = 
"wxART_QUIT"
ART_FIND = 
"wxART_FIND"
ART_FIND_AND_REPLACE = 
"wxART_FIND_AND_REPLACE"
ART_FULL_SCREEN = 
"wxART_FULL_SCREEN"
ART_EDIT = 
"wxART_EDIT"
ART_WX_LOGO = 
"wxART_WX_LOGO"
PU_CONTAINS_CONTROLS = 
1
WIZARD_EX_HELPBUTTON = 
16
WIZARD_VALIGN_TOP = 
1
WIZARD_VALIGN_CENTRE = 
2
WIZARD_VALIGN_BOTTOM = 
4
WIZARD_HALIGN_LEFT = 
8
WIZARD_HALIGN_CENTRE = 
16
WIZARD_HALIGN_RIGHT = 
32
WIZARD_TILE = 
64
EVT_WIZARD_PAGE_CHANGED = 
10310
EVT_WIZARD_PAGE_CHANGING = 
10311
EVT_WIZARD_CANCEL = 
10313
EVT_WIZARD_HELP = 
10315
EVT_WIZARD_FINISHED = 
10314
EVT_WIZARD_PAGE_SHOWN = 
10316
EVT_WIZARD_BEFORE_PAGE_CHANGED = 
10312
EVT_COLOUR_CHANGED = 
10146
EVT_DIALUP_CONNECTED =

connected event

10129
EVT_DIALUP_DISCONNECTED =

disconnected event

10130
SPLASH_CENTRE_ON_PARENT = 
1
SPLASH_CENTRE_ON_SCREEN = 
2
SPLASH_NO_CENTRE = 
0
SPLASH_TIMEOUT = 
4
SPLASH_NO_TIMEOUT = 
0
EVT_TOGGLEBUTTON = 
10141
BK_DEFAULT = 
0
BK_TOP = 
16
BK_BOTTOM = 
32
BK_LEFT = 
64
BK_RIGHT = 
128
BK_ALIGN_MASK = 
240
BK_HITTEST_NOWHERE =

No tab at the specified point.

1
BK_HITTEST_ONICON =

The point is over an icon.

2
BK_HITTEST_ONLABEL =

The point is over a tab label.

4
BK_HITTEST_ONITEM =

The point if over a tab item but not over its icon or label.

16
BK_HITTEST_ONPAGE =

The point is over the page area.

8
CAL_SUNDAY_FIRST = 
128
CAL_MONDAY_FIRST = 
1
CAL_SHOW_HOLIDAYS = 
2
CAL_NO_YEAR_CHANGE = 
4
CAL_NO_MONTH_CHANGE = 
12
CAL_SEQUENTIAL_MONTH_SELECTION = 
16
CAL_SHOW_SURROUNDING_WEEKS = 
32
CAL_SHOW_WEEK_NUMBERS = 
64
EVT_CALENDAR_SEL_CHANGED = 
10246
EVT_CALENDAR_PAGE_CHANGED = 
10247
EVT_CALENDAR_DOUBLECLICKED = 
10248
EVT_CALENDAR_WEEKDAY_CLICKED = 
10249
EVT_CALENDAR_WEEK_CLICKED = 
10250
DEFAULT_SPAN = 
nil
HL_CONTEXTMENU = 
1
HL_ALIGN_LEFT = 
2
HL_ALIGN_RIGHT = 
4
HL_ALIGN_CENTRE = 
8
HL_DEFAULT_STYLE = 
2097161
10306
MESSAGE_BOX_CAPTION_STR =

Default message box caption string.

"Message"
NULL_GRAPHICS_PEN = 
nil
NULL_GRAPHICS_BRUSH = 
nil
NULL_GRAPHICS_FONT = 
nil
NULL_GRAPHICS_BITMAP = 
nil
NULL_GRAPHICS_MATRIX = 
nil
NULL_GRAPHICS_PATH = 
nil
HF_TOOLBAR = 
1
HF_CONTENTS = 
2
HF_INDEX = 
4
HF_SEARCH = 
8
HF_BOOKMARKS = 
16
HF_OPEN_FILES = 
32
HF_PRINT = 
64
HF_FLAT_TOOLBAR = 
128
HF_MERGE_BOOKS = 
256
HF_ICONS_BOOK = 
512
HF_ICONS_BOOK_CHAPTER = 
1024
HF_ICONS_FOLDER = 
0
HF_DEFAULT_STYLE = 
95
HELP_NETSCAPE = 
1
PD_CAN_ABORT = 
1
PD_APP_MODAL = 
2
PD_AUTO_HIDE = 
4
PD_ELAPSED_TIME = 
8
PD_ESTIMATED_TIME = 
16
PD_SMOOTH = 
32
PD_REMAINING_TIME = 
64
PD_CAN_SKIP = 
128
SP_NOBORDER = 
0
SP_THIN_SASH = 
0
SP_NOSASH = 
16
SP_PERMIT_UNSPLIT = 
64
SP_LIVE_UPDATE = 
128
SP_3DSASH = 
256
SP_3DBORDER = 
512
SP_NO_XP_THEME = 
1024
SP_BORDER = 
512
SP_3D = 
768
SPLIT_DRAG_NONE = 
0
SPLIT_DRAG_DRAGGING = 
1
SPLIT_DRAG_LEFT_DOWN = 
2
EVT_SPLITTER_SASH_POS_CHANGED = 
10233
EVT_SPLITTER_SASH_POS_CHANGING = 
10234
EVT_SPLITTER_SASH_POS_RESIZE = 
10235
EVT_SPLITTER_DOUBLECLICKED = 
10236
EVT_SPLITTER_UNSPLIT = 
10237
PersistentWindow =

class alias

PersistentWindowBase
CP_DEFAULT_STYLE = 
2621440
CP_NO_TLW_RESIZE = 
2
EVT_COLLAPSIBLEPANE_CHANGED = 
10140
DP_DEFAULT =

default style on this platform, either DP_SPIN or DP_DROPDOWN

0
DP_SPIN =

a spin control-like date picker (not supported in generic version)

1
DP_DROPDOWN =

a combobox-like date picker (not supported on macOS <10.15.4)

2
DP_SHOWCENTURY =

always show century in the default date display (otherwise it depends on the system date format which may include the century or not)

4
DP_ALLOWNONE =

allow not having any valid date in the control (by default it always has some date, today initially if no valid date specified in ctor)

8
FRAME_SHAPED = 
16
TP_DEFAULT = 
0
DEFAULT_FRAME_STYLE = 
541072960
USER_ATTENTION_INFO =

Requests user attention,.

1
USER_ATTENTION_ERROR =

Results in a more drastic action.

2
FULLSCREEN_NOMENUBAR =

Don’t display the menu bar.

1
FULLSCREEN_NOTOOLBAR =

Don’t display toolbar bars.

2
FULLSCREEN_NOSTATUSBAR =

Don’t display the status bar.

4
FULLSCREEN_NOBORDER =

Don’t display any border.

8
FULLSCREEN_NOCAPTION =

Don’t display a caption.

16
FULLSCREEN_ALL =

Combination of all above, will display the least possible.

31
EL_ALLOW_NEW = 
256
EL_ALLOW_EDIT = 
512
EL_ALLOW_DELETE = 
1024
EL_NO_REORDER = 
2048
EL_DEFAULT_STYLE = 
1792
EVT_FIND = 
10148
EVT_FIND_NEXT = 
10149
EVT_FIND_REPLACE = 
10150
EVT_FIND_REPLACE_ALL = 
10151
EVT_FIND_CLOSE = 
10152
FNTP_FONTDESC_AS_LABEL = 
8
FNTP_USEFONT_FOR_LABEL = 
16
FONTBTN_DEFAULT_STYLE = 
24
FNTP_USE_TEXTCTRL = 
2
FNTP_DEFAULT_STYLE = 
24
EVT_FONTPICKER_CHANGED = 
10159
EVT_HEADER_CLICK = 
10160
EVT_HEADER_RIGHT_CLICK = 
10161
EVT_HEADER_MIDDLE_CLICK = 
10162
EVT_HEADER_DCLICK = 
10163
EVT_HEADER_RIGHT_DCLICK = 
10164
EVT_HEADER_MIDDLE_DCLICK = 
10165
EVT_HEADER_SEPARATOR_DCLICK = 
10166
EVT_HEADER_BEGIN_RESIZE = 
10167
EVT_HEADER_RESIZING = 
10168
EVT_HEADER_END_RESIZE = 
10169
EVT_HEADER_BEGIN_REORDER = 
10170
EVT_HEADER_END_REORDER = 
10171
EVT_HEADER_DRAGGING_CANCELLED = 
10172
GET_TEXT_FROM_USER_PROMPT_STR =

Default text dialog caption.

"Input Text"
GET_PASSWORD_FROM_USER_PROMPT_STR =

Default password dialog caption.

"Enter Password"
EVT_QUERY_LAYOUT_INFO = 
10317
EVT_CALCULATE_LAYOUT = 
10318
CLRP_USE_TEXTCTRL = 
2
CLRP_DEFAULT_STYLE = 
0
CLRP_SHOW_LABEL = 
8
CLRP_SHOW_ALPHA = 
16
EVT_COLOURPICKER_CHANGED = 
10143
EVT_COLOURPICKER_CURRENT_CHANGED = 
10144
EVT_COLOURPICKER_DIALOG_CANCELLED = 
10145
EVT_TASKBAR_MOVE = 
10131
EVT_TASKBAR_LEFT_DOWN = 
10132
EVT_TASKBAR_LEFT_UP = 
10133
EVT_TASKBAR_RIGHT_DOWN = 
10134
EVT_TASKBAR_RIGHT_UP = 
10135
EVT_TASKBAR_LEFT_DCLICK = 
10136
EVT_TASKBAR_RIGHT_DCLICK = 
10137
EVT_TASKBAR_CLICK = 
10134
EVT_TASKBAR_BALLOON_TIMEOUT = 
10138
EVT_TASKBAR_BALLOON_CLICK = 
10139
DIRCTRL_DIR_ONLY = 
16
DIRCTRL_SELECT_FIRST = 
32
DIRCTRL_SHOW_FILTERS = 
64
DIRCTRL_3D_INTERNAL = 
128
DIRCTRL_EDIT_LABELS = 
256
DIRCTRL_MULTIPLE = 
512
DIRCTRL_DEFAULT_STYLE = 
128
EVT_DIRCTRL_SELECTIONCHANGED = 
10229
EVT_DIRCTRL_FILEACTIVATED = 
10230
CHOICE_WIDTH = 
150
CHOICE_HEIGHT = 
200
CHOICEDLG_STYLE = 
536877141

Art creation methods collapse

Dialog shortcuts collapse

Mouse / keyboard information collapse

System information collapse

Managing stock IDs collapse

Logging methods collapse

Class Method Summary collapse

Class Method Details

.about_box(info, parent = nil) ⇒ void

This method returns an undefined value.

This function shows the standard about dialog containing the information specified in info.

If the current platform has a native about dialog which is capable of showing all the fields in info, the native dialog is used, otherwise the function falls back to the generic wxWidgets version of the dialog, i.e. does the same thing as generic_about_box. Here is an example of how this function may be used:

def show_simple_about_dialog(event)
    info = Wx::AboutDialogInfo.new
    info.name = 'My Program'
    info.version = '1.2.3 Beta'
    info.description = 'This program does something great.'
    info.copyright = '(C) 2007 Me <my@email.addre.ss>'
       
    Wx.about_box(info)
  end

Please see the Dialogs Sample for more examples of using this function and AboutDialogInfo for the description of the information which can be shown in the about dialog.

Parameters:



29
 
# File 'lib/wx/doc/gen/about_dialog_info.rb', line 29

def self.about_box(info, parent=nil) end

.auto_buffered_paint_dc_factory(window) ⇒ Wx::DC

Check if the window is natively double buffered and will return a PaintDC if it is, a BufferedPaintDC otherwise.

It is the caller’s responsibility to delete the DC pointer when finished with it.

Parameters:

Returns:



23
 
# File 'lib/wx/doc/gen/memory_dc.rb', line 23

def self.auto_buffered_paint_dc_factory(window) end

.begin_busy_cursor(cursor = Wx::HOURGLASS_CURSOR) ⇒ void

This method returns an undefined value.

Changes the cursor to the given cursor for all windows in the application.

Use end_busy_cursor to revert the cursor back to its previous state. These two calls can be nested, and a counter ensures that only the outer calls take effect.

Parameters:

  • cursor (Wx::Cursor) (defaults to: Wx::HOURGLASS_CURSOR)

See Also:



36
 
# File 'lib/wx/doc/gen/utils.rb', line 36

def self.begin_busy_cursor(cursor) end

.bell ⇒ void

This method returns an undefined value.

Ring the system bell.

Note:

This function is categorized as a GUI one and so is not thread-safe. 



61
 
# File 'lib/wx/doc/gen/utils.rb', line 61

def self.bell; end

.Bitmap(name, bmp_type = nil, art_path: nil, art_section: nil) ⇒ Wx::Bitmap

Searches for an art file with basename ‘name’ and creates a Bitmap if found. Raises an ArgumentError if not found. Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to determine the values for the ‘art_path’ and ‘art_section’ arguments if not specified here (‘art_path’ is set to the absolute path to the folder holding the caller’s code and ‘art_section’ to the basename of the caller’s source file). The ‘art_type’ argument is set to :bitmap.

Parameters:

  • name (String, Symbol) —

    base name of art file

  • bmp_type (Wx::BitmapType, nil) (defaults to: nil) —

    bitmap type for art file (nil means any supported type)

  • art_path (String, nil) (defaults to: nil) —

    base path to look up the art file

  • art_section (String, nil) (defaults to: nil) —

    optional owner folder name for art files

Returns:

See Also:

  • Wx::ArtLocator::find_art


31
 
# File 'lib/wx/doc/bitmap.rb', line 31

def self.Bitmap(name, bmp_type = nil, art_path: nil, art_section: nil); end

.check_os_version(majorVsn, minorVsn = 0, microVsn = 0) ⇒ Boolean

Returns true if the version of the operating system on which the program is running under is the same or later than the given version.

Parameters:

  • majorVsn (Integer)
  • minorVsn (Integer) (defaults to: 0)
  • microVsn (Integer) (defaults to: 0)

Returns:

  • (Boolean)

See Also:



240
 
# File 'lib/wx/doc/gen/utils.rb', line 240

def self.check_os_version(majorVsn, minorVsn=0, microVsn=0) end

.colour_display ⇒ Boolean

Returns true if the display is colour, false otherwise.

Note:

Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_depth to retrieve the depth of the appropriate display and compare it with 1 instead.

Returns:

  • (Boolean) 


314
 
# File 'lib/wx/doc/gen/gdi_common.rb', line 314

def self.colour_display; end

.create_dynamic_object(className) ⇒ Wx::Object

Creates and returns an object of the given class, if the class has been registered with the dynamic class system using DECLARE…

and IMPLEMENT… macros.

Parameters:

  • className (String)

Returns:



14
 
# File 'lib/wx/doc/gen/object.rb', line 14

def self.create_dynamic_object(className) end

.create_file_tip_provider(filename, currentTip) ⇒ Wx::TipProvider

This function creates a TipProvider which may be used with show_tip.

Parameters:

  • filename (String) —

    The name of the file containing the tips, one per line.

  • currentTip (Integer) —

    The index of the first tip to show. Normally this index is remembered between the 2 program runs.

Returns:

See Also:

  • Overview


16
 
# File 'lib/wx/doc/gen/tip_provider.rb', line 16

def self.create_file_tip_provider(filename, currentTip) end

.create_persistent_object(obj) ⇒ Wx::PersistentObject

Function used to create the correct persistent adapter for the given object.

This is a compatibility function that simply redirects the call to the object itself. Any object class supporting persistence should implement the #create_persistent_object method to return a Wx::PersistentObject instance for the object it is called for. This method raises a NoImplementError if the object class does not support persistence.

Parameters:

  • obj (::Object)

Returns:

See Also:

  • Custom Persistent Windows


19
 
# File 'lib/wx/doc/persistence_manager.rb', line 19

def self.create_persistent_object(obj) end

.Cursor(name, bmp_type = nil, art_path: nil, art_section: nil) ⇒ Wx::Cursor

Searches for an art file with basename ‘name’ and creates a Cursor if found. Raises an ArgumentError if not found. Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to determine the values for the ‘art_path’ and ‘art_section’ arguments if not specified here (‘art_path’ is set to the absolute path to the folder holding the caller’s code and ‘art_section’ to the basename of the caller’s source file). The ‘art_type’ argument is set to :cursor.

Parameters:

  • name (String, Symbol) —

    base name of art file

  • bmp_type (Wx::BitmapType, nil) (defaults to: nil) —

    bitmap type for art file (nil means any supported type)

  • art_path (String, nil) (defaults to: nil) —

    base path to look up the art file

  • art_section (String, nil) (defaults to: nil) —

    optional owner folder name for art files

Returns:

See Also:

  • Wx::ArtLocator::find_art


24
 
# File 'lib/wx/doc/cursor.rb', line 24

def self.Cursor(name, bmp_type = nil, art_path: nil, art_section: nil); end

.deg_to_rad(deg) ⇒ Float

Convert degrees to radians.

Parameters:

  • deg (Float) —

    degrees

Returns:

  • (Float) —

    radians



18
 
# File 'lib/wx/doc/geometry.rb', line 18

def self.deg_to_rad(deg) end

.dir_selector(message = Wx::DIR_SELECTOR_PROMPT_STR, default_path = (''), style = 0, pos = Wx::DEFAULT_POSITION, parent = nil) ⇒ String

Pops up a directory selector dialog.

The arguments have the same meaning as those of Wx::DirDialog#initialize. The message is displayed at the top, and the default_path, if specified, is set as the initial selection. The application must check for an empty return value (if the user pressed Cancel). For example:

dir = Wx.dir_selector('Choose a folder')
  unless dir.empty?
    ...
  end

Parameters:

  • message (String) (defaults to: Wx::DIR_SELECTOR_PROMPT_STR)
  • default_path (String) (defaults to: (''))
  • style (Integer) (defaults to: 0)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • parent (Wx::Window) (defaults to: nil)

Returns:

  • (String) 


56
 
# File 'lib/wx/doc/gen/dir_dialog.rb', line 56

def self.dir_selector(message=Wx::DIR_SELECTOR_PROMPT_STR, default_path=(''), style=0, pos=Wx::DEFAULT_POSITION, parent=nil) end

.display_depth ⇒ Integer

Returns the depth of the display (a value of 1 denotes a monochrome display).

Note:

Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_depth to retrieve the depth of the appropriate display instead.

Returns:

  • (Integer) 


324
 
# File 'lib/wx/doc/gen/gdi_common.rb', line 324

def self.display_depth; end

.dump_window(window) ⇒ String

Return a string with human-readable platform-specific description of the window useful for diagnostic purposes.

The string returned from this function doesn’t have any fixed form and can vary between different wxWidgets ports and versions, but contains some useful description of the window and uniquely identifies it. This can be useful to include in debug or tracing messages.

Parameters:

  • window (Wx::Window) —

    Window pointer which is allowed to be NULL.

Returns:

  • (String) 


150
 
# File 'lib/wx/doc/gen/window.rb', line 150

def self.dump_window(window) end

.enable_top_level_windows(enable = true) ⇒ void

This method returns an undefined value.

This function enables or disables all top level windows.

It is used by safe_yield.

Parameters:

  • enable (Boolean) (defaults to: true) 


102
 
# File 'lib/wx/doc/gen/utils.rb', line 102

def self.enable_top_level_windows(enable=true) end

.end_busy_cursor ⇒ void

This method returns an undefined value.

Changes the cursor back to the original cursor, for all windows in the application.

Use with begin_busy_cursor.

See Also:



44
 
# File 'lib/wx/doc/gen/utils.rb', line 44

def self.end_busy_cursor; end

.file_selector(message, default_path = '', default_filename = '', default_extension = '', wildcard = '', flags = 0, parent = nil, x = Wx::DEFAULT_COORD, y = Wx::DEFAULT_COORD) ⇒ String

Note:

Wx::FD_MULTIPLE can only be used with Wx::FileDialog and not here since this function only returns a single file name.

Pops up a file selector box.

In Windows, this is the common file selector dialog. In X, this is a file selector box with the same functionality. The path and filename are distinct elements of a full file pathname. If path is empty, the current directory will be used. If filename is empty, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename. Flags may be a combination of Wx::FD_OPEN, Wx::FD_SAVE, Wx::FD_OVERWRITE_PROMPT or Wx::FD_FILE_MUST_EXIST.

Both the Unix and Windows versions implement a wildcard filter. Typing a filename containing wildcards (, ?) in the filename text item, and clicking on Ok, will result in only those files matching the pattern being displayed. The wildcard may be a specification for multiple types of file with a description for each, such as: "BMP files (.bmp)|.bmp|GIF files (.gif)|*.gif"

The application must check for an empty return value (the user pressed Cancel). For example: filename = Wx::file_selector("Choose a file to open") unless filename.empty? # work with the file ... end # else: cancelled by user

Returns:

  • (String) —

    selected file name



222
223
 
# File 'lib/wx/doc/functions.rb', line 222

def self.file_selector(message, default_path='', default_filename='', default_extension='', wildcard='',
flags=0, parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD) end

.file_selector_ex(message = 'Select a file', default_path = '', default_filename = '', indexDefaultExtension = nil, wildcard = '*', flags = 0, parent = nil, x = Wx::DEFAULT_COORD, y = Wx::DEFAULT_COORD) ⇒ String

An extended version of file_selector.

Returns:

  • (String) —

    selected file name



227
228
 
# File 'lib/wx/doc/functions.rb', line 227

def self.file_selector_ex(message='Select a file', default_path='', default_filename='', indexDefaultExtension=nil,
wildcard='*', flags=0, parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD) end

.find_menu_item_id(frame, menuString, itemString) ⇒ Integer

Find a menu item identifier associated with the given frame’s menu bar.

Parameters:

  • frame (Wx::Frame)
  • menuString (String)
  • itemString (String)

Returns:

  • (Integer) 


116
 
# File 'lib/wx/doc/gen/utils.rb', line 116

def self.find_menu_item_id(frame, menuString, itemString) end

.find_window_at_point(pt) ⇒ Wx::Window

Find the deepest window at the given mouse position in screen coordinates, returning the window if found, or NULL if not.

This function takes child windows at the given position into account even if they are disabled. The hidden children are however skipped by it.

Parameters:

Returns:



148
 
# File 'lib/wx/doc/functions.rb', line 148

def self.find_window_at_point(point) end

.find_window_at_pointer(pt) ⇒ Wx::Window

Find the deepest window at the mouse pointer position, returning the window and current pointer position in screen coordinates.

Parameters:

Returns:



132
 
# File 'lib/wx/doc/gen/window.rb', line 132

def self.find_window_at_pointer(pt) end

.from_string(string, colour) ⇒ Boolean

Converts string to a Colour best represented by the given string.

Returns true on success.

Parameters:

Returns:

  • (Boolean)

See Also:

  • wxColour&)


40
 
# File 'lib/wx/doc/gen/colour.rb', line 40

def self.from_string(string, colour) end

.generic_about_box(info, parent = nil) ⇒ void

This method returns an undefined value.

Show generic about dialog.

This function does the same thing as about_box except that it always uses the generic wxWidgets version of the dialog instead of the native one.

Parameters:



39
 
# File 'lib/wx/doc/gen/about_dialog_info.rb', line 39

def self.generic_about_box(info, parent=nil) end

.get_active_window ⇒ Wx::Window

Gets the currently active window (implemented for MSW and GTK only currently, always returns NULL in the other ports).

Returns:



150
 
# File 'lib/wx/doc/functions.rb', line 150

def self.get_active_window; end

.get_app ⇒ Wx::App?

Returns the global app object Returns nil if no app instance is active.

Returns:

  • (Wx::App, nil) —

    the global app object



108
 
# File 'lib/wx/doc/functions.rb', line 108

def self.get_app; end

.get_client_display_rect ⇒ Wx::Rect

Returns the dimensions of the work area on the display.

On Windows this means the area not covered by the taskbar, etc. Other platforms are currently defaulting to the whole display until a way is found to provide this info for all window managers, etc.

Returns:

See Also:

  • Display


340
 
# File 'lib/wx/doc/gen/gdi_common.rb', line 340

def self.get_client_display_rect; end

.get_colour_from_user(parent, colInit, caption = (''), data = nil) ⇒ Wx::Colour

Shows the colour selection dialog and returns the colour selected by user or invalid colour (use Wx::Colour#is_ok to test whether a colour is valid) if the dialog was cancelled.

Parameters:

  • parent (Wx::Window) —

    The parent window for the colour selection dialog.

  • colInit (Wx::Colour, String, Symbol) —

    If given, this will be the colour initially selected in the dialog.

  • caption (String) (defaults to: ('')) —

    If given, this will be used for the dialog caption.

  • data (Wx::ColourData) (defaults to: nil) —

    Optional object storing additional colour dialog settings, such as custom colours. If none is provided the same settings as the last time are used.

Returns:



19
 
# File 'lib/wx/doc/gen/colour_dialog.rb', line 19

def self.get_colour_from_user(parent, colInit, caption=(''), data=nil) end

.get_cpu_architecture_name ⇒ String

Returns the CPU architecture name.

This can be, for example, “x86_64”, “arm64”, or “i86pc”. The name for the same CPU running on the same hardware can vary across operating systems. The returned string may be empty if the CPU architecture couldn’t be recognized.

Returns:

  • (String)

See Also:



267
 
# File 'lib/wx/doc/gen/utils.rb', line 267

def self.get_cpu_architecture_name; end

.get_display_ppi ⇒ Wx::Size

Returns the display resolution in pixels per inch.

The x component of the returned Size object contains the horizontal resolution and the y one the vertical resolution.

Note:

Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_ppi to retrieve the resolution of the appropriate display instead.

Returns:

See Also:

  • Display


353
 
# File 'lib/wx/doc/gen/gdi_common.rb', line 353

def self.get_display_ppi; end

.get_display_size ⇒ Wx::Size

Returns the display size in pixels.

Note:

Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_geometry to retrieve the size of the appropriate display instead.

Returns:

See Also:

  • Display


364
 
# File 'lib/wx/doc/gen/gdi_common.rb', line 364

def self.get_display_size; end

.get_display_size_mm ⇒ Wx::Size

Returns the display size in millimeters.

Returns:

See Also:

  • Display


371
 
# File 'lib/wx/doc/gen/gdi_common.rb', line 371

def self.get_display_size_mm; end

.get_email_address ⇒ String

Copies the user’s email address into the supplied buffer, by concatenating the values returned by get_full_host_name and get_user_id.

true if successful, false otherwise.

Returns:

  • (String) 


129
 
# File 'lib/wx/doc/functions.rb', line 129

def self.get_email_address; end

.get_font_from_user(parent, fontInit, caption = ('')) ⇒ Wx::Font

Shows the font selection dialog and returns the font selected by user or invalid font (use Wx::Font#is_ok to test whether a font is valid) if the dialog was cancelled.

Parameters:

  • parent (Wx::Window) —

    The parent window for the font selection dialog.

  • fontInit (Wx::Font, Wx::FontInfo) —

    If given, this will be the font initially selected in the dialog.

  • caption (String) (defaults to: ('')) —

    If given, this will be used for the dialog caption.

Returns:



14
 
# File 'lib/wx/doc/gen/font_dialog.rb', line 14

def self.get_font_from_user(parent, fontInit, caption=('')) end

.get_free_memory ⇒ Integer

Returns the amount of free memory in bytes under environments which support it, and -1 if not supported or failed to perform measurement.

Returns:

  • (Integer) 


175
 
# File 'lib/wx/doc/gen/utils.rb', line 175

def self.get_free_memory; end

.get_full_host_name ⇒ String

Returns the FQDN (fully qualified domain host name) or an empty string on error.

Returns:

  • (String)

See Also:



133
 
# File 'lib/wx/doc/functions.rb', line 133

def self.get_full_host_name; end

.get_home_dir ⇒ String

Return the (current) user’s home directory.

Returns:

  • (String)

See Also:



139
 
# File 'lib/wx/doc/functions.rb', line 139

def self.get_home_dir; end

.get_host_name ⇒ String

Copies the current host machine’s name into the supplied buffer.

Please note that the returned name is not fully qualified, i.e. it does not include the domain name. The hostname if successful or an empty string otherwise.

Returns:

  • (String)

See Also:



131
 
# File 'lib/wx/doc/functions.rb', line 131

def self.get_host_name; end

.get_key_state(key) ⇒ Boolean

For normal keys, returns true if the specified key is currently down.

For togglable keys (Caps Lock, Num Lock and Scroll Lock), returns true if the key is toggled such that its LED indicator is lit. There is currently no way to test whether togglable keys are up or down. Even though there are virtual key codes defined for mouse buttons, they cannot be used with this function currently. In WXGTK, this function can be only used with modifier keys (Wx::KeyCode::K_ALT, Wx::KeyCode::K_CONTROL and Wx::KeyCode::K_SHIFT) when not using X11 backend currently.

Parameters:

Returns:

  • (Boolean) 


146
 
# File 'lib/wx/doc/functions.rb', line 146

def self.get_key_state(key) end

.get_library_version_info ⇒ Wx::VersionInfo

Get wxWidgets version information.

Returns:

See Also:



76
 
# File 'lib/wx/doc/gen/utils.rb', line 76

def self.get_library_version_info; end

.get_locale ⇒ Wx::Locale

Get the current locale object (note that it may be NULL!)

Returns:



3783
 
# File 'lib/wx/doc/gen/locale.rb', line 3783

def self.get_locale; end

.get_mouse_position ⇒ Wx::Point

Returns the mouse position in screen coordinates.

Returns:



152
 
# File 'lib/wx/doc/functions.rb', line 152

def self.get_mouse_position; end

.get_mouse_state ⇒ Wx::MouseState

Returns the current state of the mouse.

Returns a MouseState instance that contains the current position of the mouse pointer in screen coordinates, as well as boolean values indicating the up/down status of the mouse buttons and the modifier keys.

Returns:



154
 
# File 'lib/wx/doc/functions.rb', line 154

def self.get_mouse_state; end

.get_native_cpu_architecture_name ⇒ String

In some situations the current process and native CPU architecture may be different.

This returns the native CPU architecture regardless of the current process CPU architecture. Common examples for CPU architecture differences are the following:

  • Win32 process in x64 Windows (WoW)

  • Win32 or x64 process on ARM64 Windows (WoW64)

  • x86_64 process on ARM64 macOS (Rosetta 2)

The returned string may be empty if the CPU architecture couldn’t be recognized.

Returns:

  • (String)

See Also:



281
 
# File 'lib/wx/doc/gen/utils.rb', line 281

def self.get_native_cpu_architecture_name; end

.get_number_from_user(message, prompt, caption, value, min = 0, max = 100, parent = nil, pos = Wx::DEFAULT_POSITION) ⇒ Integer

Shows a dialog asking the user for numeric input.

The dialogs title is set to caption, it contains a (possibly) multiline message above the single line prompt and the zone for entering the number. The number entered must be in the range min to max (both of which should be positive) and value is the initial value of it. If the user enters an invalid value, it is forced to fall into the specified range. If the user cancels the dialog, the function returns -1. If it is important to distinguish between cancelling the dialog and actually entering -1 in it, i.e. if -1 is a valid input value, this convenience function can’t be used and NumberEntryDialog should be used directly instead. Dialog is centered on its parent unless an explicit position is given in pos.

Parameters:

  • message (String)
  • prompt (String)
  • caption (String)
  • value (Integer)
  • min (Integer) (defaults to: 0)
  • max (Integer) (defaults to: 100)
  • parent (Wx::Window) (defaults to: nil)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)

Returns:

  • (Integer)

See Also:



24
 
# File 'lib/wx/doc/gen/number_entry_dialog.rb', line 24

def self.get_number_from_user(message, prompt, caption, value, min=0, max=100, parent=nil, pos=Wx::DEFAULT_POSITION) end

.get_os_description ⇒ String

Returns the string containing the description of the current platform in a user-readable form.

For example, this function may return strings like “Windows 10 (build 10240), 64-bit edition” or “Linux 4.1.4 i386”.

Returns:

  • (String)

See Also:

  • get_os_version


229
 
# File 'lib/wx/doc/gen/utils.rb', line 229

def self.get_os_description; end

.get_password_from_user(message, caption = Wx::GET_PASSWORD_FROM_USER_PROMPT_STR, default_value = (''), parent = nil, x = Wx::DEFAULT_COORD, y = Wx::DEFAULT_COORD, centre = true) ⇒ String

Similar to get_text_from_user but the text entered in the dialog is not shown on screen but replaced with stars.

This is intended to be used for entering passwords as the function name implies.

Parameters:

  • message (String)
  • caption (String) (defaults to: Wx::GET_PASSWORD_FROM_USER_PROMPT_STR)
  • default_value (String) (defaults to: (''))
  • parent (Wx::Window) (defaults to: nil)
  • x (Integer) (defaults to: Wx::DEFAULT_COORD)
  • y (Integer) (defaults to: Wx::DEFAULT_COORD)
  • centre (Boolean) (defaults to: true)

Returns:

  • (String) 


43
 
# File 'lib/wx/doc/gen/text_entry_dialog.rb', line 43

def self.get_password_from_user(message, caption=Wx::GET_PASSWORD_FROM_USER_PROMPT_STR, default_value=(''), parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD, centre=true) end

.get_selected_choices(message, caption, choices, parent = nil, initial_selections: [], pos: Wx::DEFAULT_POSITION) ⇒ Array<Integer>?

Returns selected choice indexes (can be empty array if none selected) or nil if cancelled.

Parameters:

  • message (String)
  • caption (String)
  • choices (Array<String>) —

    choice strings

  • parent (Wx::Window, nil) (defaults to: nil)
  • initial_selections (Array<Integer>) (defaults to: []) —

    array of initial choice indexes

  • pos (Wx::Point, Array(Integer,Integer)) (defaults to: Wx::DEFAULT_POSITION)

Returns:

  • (Array<Integer>, nil) —

    selected choice indexes (can be empty array if none selected) or nil if cancelled



193
194
195
 
# File 'lib/wx/doc/functions.rb', line 193

def self.get_selected_choices(message, caption, choices, parent = nil,
initial_selections: [],
pos:  Wx::DEFAULT_POSITION) end

.get_single_choice(message, caption, choices, parent = nil, initial_selection: 0, pos: Wx::DEFAULT_POSITION) ⇒ String

Get the user selection as a string.

Parameters:

  • message (String)
  • caption (String)
  • choices (Array<String>) —

    choice strings

  • parent (Wx::Window, nil) (defaults to: nil)
  • initial_selection (Integer) (defaults to: 0) —

    initial choice index

  • pos (Wx::Point, Array(Integer,Integer)) (defaults to: Wx::DEFAULT_POSITION)

Returns:

  • (String) —

    selected choice or ” if cancelled



170
171
172
 
# File 'lib/wx/doc/functions.rb', line 170

def self.get_single_choice(message, caption, choices, parent = nil,
initial_selection: 0,
pos:  Wx::DEFAULT_POSITION) end

.get_single_choice_index(message, caption, choices, parent = nil, initial_selection: 0, pos: Wx::DEFAULT_POSITION) ⇒ Integer

Get the user selection as an index.

Parameters:

  • message (String)
  • caption (String)
  • choices (Array<String>) —

    choice strings

  • parent (Wx::Window, nil) (defaults to: nil)
  • initial_selection (Integer) (defaults to: 0)
  • pos (Wx::Point, Array(Integer,Integer)) (defaults to: Wx::DEFAULT_POSITION)

Returns:

  • (Integer) —

    selected choice index or -1 if cancelled



182
183
184
 
# File 'lib/wx/doc/functions.rb', line 182

def self.get_single_choice_index(message, caption, choices, parent = nil,
initial_selection: 0,
pos:  Wx::DEFAULT_POSITION) end

.get_stock_accelerator(id) ⇒ Wx::AcceleratorEntry

Returns the accelerator that should be used for given stock UI element (e.g. “Ctrl+X” for Wx::ID_CUT)

Parameters:

  • id (Integer) —

    stock UI element ID

Returns:



274
 
# File 'lib/wx/doc/functions.rb', line 274

def self.get_stock_accelerator(id) end

.get_stock_help_string(id, client = Wx::STOCK_MENU) ⇒ String

Returns a help string for the given stock UI element and for the given “context”.

Parameters:

  • id (Integer) —

    stock UI element ID

  • client (Integer) (defaults to: Wx::STOCK_MENU) —

    context (currently only STOCK_MENU)

Returns:

  • (String) 


282
 
# File 'lib/wx/doc/functions.rb', line 282

def self.get_stock_help_string(id, client = Wx::STOCK_MENU) end

.get_stock_label(id, flags = Wx::STOCK_WITH_MNEMONIC) ⇒ String

Returns label that should be used for given id element.

Parameters:

  • id (Integer) —

    Given id of the wxMenuItem, wxButton, wxToolBar tool, etc.

  • flags (Integer) (defaults to: Wx::STOCK_WITH_MNEMONIC) —

    Combination of the elements of STOCK_xxx flags.

Returns:

  • (String) 


268
 
# File 'lib/wx/doc/functions.rb', line 268

def self.get_stock_label(id, flags = Wx::STOCK_WITH_MNEMONIC) end

.get_text_from_user(message, caption = Wx::GET_TEXT_FROM_USER_PROMPT_STR, default_value = (''), parent = nil, x = Wx::DEFAULT_COORD, y = Wx::DEFAULT_COORD, centre = true) ⇒ String

Pop up a dialog box with title set to caption, message, and a default_value.

The user may type in text and press OK to return this text, or press Cancel to return the empty string. If centre is true, the message text (which may include new line characters) is centred; if false, the message is left-justified. This function is a wrapper around TextEntryDialog and while it is usually more convenient to use, using the dialog directly is more flexible, e.g. it allows you to specify the TE_MULTILINE to allow the user enter multiple lines of text while this function is limited to single line entry only.

Parameters:

  • message (String)
  • caption (String) (defaults to: Wx::GET_TEXT_FROM_USER_PROMPT_STR)
  • default_value (String) (defaults to: (''))
  • parent (Wx::Window) (defaults to: nil)
  • x (Integer) (defaults to: Wx::DEFAULT_COORD)
  • y (Integer) (defaults to: Wx::DEFAULT_COORD)
  • centre (Boolean) (defaults to: true)

Returns:

  • (String) 


30
 
# File 'lib/wx/doc/gen/text_entry_dialog.rb', line 30

def self.get_text_from_user(message, caption=Wx::GET_TEXT_FROM_USER_PROMPT_STR, default_value=(''), parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD, centre=true) end

.get_top_level_parent(window) ⇒ Wx::Window

Returns the first top level parent of the given window, or in other words, the frame or dialog containing it, or NULL.

Notice that if window is itself already a TLW, it is returned directly.

Parameters:

Returns:



143
 
# File 'lib/wx/doc/gen/window.rb', line 143

def self.get_top_level_parent(window) end

.get_user_home(user = ('')) ⇒ String

Returns the home directory for the given user.

If the user is empty (default value), this function behaves like get_home_dir (i.e. returns the current user home directory). If the home directory couldn’t be determined, an empty string is returned.

Parameters:

  • user (String) (defaults to: (''))

Returns:

  • (String) 


206
 
# File 'lib/wx/doc/gen/utils.rb', line 206

def self.get_user_home(user=('')) end

.get_user_id ⇒ String

This function returns the “user id” also known as “login name” under Unix (i.e.

something like “jsmith”). It uniquely identifies the current user (on this system). Under Windows or NT, this function first looks in the environment variables USER and LOGNAME; if neither of these is found, the entry UserId in the wxWidgets section of the WIN.INI file is tried. The login name if successful or an empty string otherwise.

Returns:

  • (String)

See Also:



135
 
# File 'lib/wx/doc/functions.rb', line 135

def self.get_user_id; end

.get_user_name ⇒ String

This function returns the full user name (something like “Mr. John Smith”).

Under Windows or NT, this function looks for the entry UserName in the wxWidgets section of the WIN.INI file. If PenWindows is running, the entry Current in the section User of the PENWIN.INI file is used. The full user name if successful or an empty string otherwise.

Returns:

  • (String)

See Also:



137
 
# File 'lib/wx/doc/functions.rb', line 137

def self.get_user_name; end

.Icon(name, bmp_type = nil, desired_width = -1,, desired_height = -1,, art_path: nil, art_section: nil) ⇒ Wx::Icon

Searches for an art file with basename ‘name’ and creates an Icon if found. Raises an ArgumentError if not found. Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to determine the values for the ‘art_path’ and ‘art_section’ arguments if not specified here (‘art_path’ is set to the absolute path to the folder holding the caller’s code and ‘art_section’ to the basename of the caller’s source file). The ‘art_type’ argument is set to :icon.

Parameters:

  • name (String, Symbol) —

    base name of art file

  • bmp_type (Wx::BitmapType, nil) (defaults to: nil) —

    bitmap type for art file (nil means any supported type)

  • desired_width (Integer) (defaults to: -1,)
  • desired_height (Integer) (defaults to: -1,)
  • art_path (String, nil) (defaults to: nil) —

    base path to look up the art file

  • art_section (String, nil) (defaults to: nil) —

    optional owner folder name for art files

Returns:

See Also:

  • Wx::ArtLocator::find_art


26
 
# File 'lib/wx/doc/icon.rb', line 26

def self.Icon(name, bmp_type = nil, desired_width=-1, desired_height=-1, art_path: nil, art_section: nil); end

.Image(name, bmp_type = nil, index = -1,, art_path: nil, art_section: nil) ⇒ Wx::Image

Searches for an art file with basename ‘name’ and creates an Image if found. Raises an ArgumentError if not found. Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to determine the values for the ‘art_path’ and ‘art_section’ arguments if not specified here (‘art_path’ is set to the absolute path to the folder holding the caller’s code and ‘art_section’ to the basename of the caller’s source file). The ‘art_type’ argument is set to :image.

Parameters:

  • name (String, Symbol) —

    base name of art file

  • bmp_type (Wx::BitmapType, nil) (defaults to: nil) —

    bitmap type for art file (nil means any supported type)

  • index (Integer) (defaults to: -1,) —

    Index of the image to load in the case that the image file contains multiple images. This is only used by GIF, ICO and TIFF handlers. The default value (-1) means “choose the default image” and is interpreted as the first image (index=0) by the GIF and TIFF handler and as the largest and most colourful one by the ICO handler.

  • art_path (String, nil) (defaults to: nil) —

    base path to look up the art file

  • art_section (String, nil) (defaults to: nil) —

    optional owner folder name for art files

Returns:

See Also:

  • Wx::ArtLocator::find_art


123
 
# File 'lib/wx/doc/image.rb', line 123

def self.Image(name, bmp_type = nil, index=-1, art_path: nil, art_section: nil); end

.info_message_box(parent) ⇒ void

This method returns an undefined value.

Shows a message box with the information about the wxWidgets build used, including its version, most important build parameters and the version of the underlying GUI toolkit.

This is mainly used for diagnostic purposes and can be invoked by Ctrl-Alt-middle clicking on any Window which doesn’t otherwise handle this event.

Parameters:

See Also:



69
 
# File 'lib/wx/doc/gen/utils.rb', line 69

def self.info_message_box(parent) end

.is_busy ⇒ Boolean

Returns true if between two begin_busy_cursor and end_busy_cursor calls.

Returns:

  • (Boolean)

See Also:

  • BusyCursor.


51
 
# File 'lib/wx/doc/gen/utils.rb', line 51

def self.is_busy; end

.is_drag_result_ok(res) ⇒ Boolean

Returns true if res indicates that something was done during a DnD operation, i.e.

is neither error nor none nor cancel.

Parameters:

Returns:

  • (Boolean) 


59
 
# File 'lib/wx/doc/gen/drag_drop.rb', line 59

def self.is_drag_result_ok(res) end

.is_platform64bit ⇒ Boolean

Returns true if the operating system the program is running under is 64 bit.

The check is performed at run-time and may differ from the value available at compile-time (at compile-time you can just check if sizeof(void*) == 8) since the program could be running in emulation mode or in a mixed 32/64 bit system.

Note:

This function is not 100% reliable on some systems given the fact that there isn't always a standard way to do a reliable check on the OS bitness.

Returns:

  • (Boolean) 


252
 
# File 'lib/wx/doc/gen/utils.rb', line 252

def self.is_platform64bit; end

.is_platform_little_endian ⇒ Boolean

Returns true if the current platform is little endian (instead of big endian).

The check is performed at run-time.

Returns:

  • (Boolean)

See Also:

  • Order Functions and Macros


259
 
# File 'lib/wx/doc/gen/utils.rb', line 259

def self.is_platform_little_endian; end

.is_running_under_wine ⇒ Boolean

Returns true only for MSW programs running under Wine.

This function can be used to check for some functionality not implemented when using Wine.

Category: Application and System configuration

Returns:

  • (Boolean) 


180
 
# File 'lib/wx/doc/gen/platform_info.rb', line 180

def self.is_running_under_wine; end

.is_stock_id(id) ⇒ true, false

Returns true if the ID is in the list of recognized stock actions

Parameters:

  • id (Integer) —

    ID to check

Returns:

  • (true, false) 


245
 
# File 'lib/wx/doc/functions.rb', line 245

def self.is_stock_id(id) end

.is_stock_label(id, label) ⇒ true, false

Returns true if the label is empty or label of a stock button with given ID

Parameters:

  • id (Integer) —

    ID to check

  • label (String) —

    to check

Returns:

  • (true, false) 


252
 
# File 'lib/wx/doc/functions.rb', line 252

def self.is_stock_label(id, label) end

.launch_default_application(document, flags = 0) ⇒ Boolean

Opens the document in the application associated with the files of this type.

The flags parameter is currently not used Returns true if the application was successfully launched.

Parameters:

  • document (String)
  • flags (Integer) (defaults to: 0)

Returns:

  • (Boolean)

See Also:



132
 
# File 'lib/wx/doc/gen/utils.rb', line 132

def self.launch_default_application(document, flags=0) end

.launch_default_browser(url, flags = 0) ⇒ Boolean

Opens the url in user’s default browser.

If the flags parameter contains BROWSER_NEW_WINDOW flag, a new window is opened for the URL (currently this is only supported under Windows). And unless the flags parameter contains BROWSER_NOBUSYCURSOR flag, a busy cursor is shown while the browser is being launched (using BusyCursor). The parameter url is interpreted as follows:

  • if it has a valid scheme (e.g. "file:", "http:" or "mailto:") it is passed to the appropriate browser configured in the user system.

  • if it has no valid scheme (e.g. it’s a local file path without the "file:" prefix), then FileExists and DirExists are used to test if it’s a local file/directory; if it is, then the browser is called with the url parameter eventually prefixed by "file:".

  • if it has no valid scheme and it’s not a local file/directory, then "http:" is prepended and the browser is called.

Returns true if the application was successfully launched.

Note:

For some configurations of the running user, the application which is launched to open the given URL may be URL-dependent (e.g. a browser may be used for local URLs while another one may be used for remote URLs).

Parameters:

  • url (String)
  • flags (Integer) (defaults to: 0)

Returns:

  • (Boolean)

See Also:



156
 
# File 'lib/wx/doc/gen/utils.rb', line 156

def self.launch_default_browser(url, flags=0) end

.load_file_selector(what, extension, default_name = '', parent = nil) ⇒ Object

Shows a file dialog asking the user for a file name for saving a file.

See Also:

  • Wx::FileDialog


232
 
# File 'lib/wx/doc/functions.rb', line 232

def self.load_file_selector(what,  extension, default_name='', parent=nil) end

.log_debug(fmt, *args, filename: nil, line: 0, func: nil, component: nil) ⇒ void

This method returns an undefined value.

Log a Wx debug message to the current Wx log output

Parameters:

  • fmt (String) —

    message (formatting) string

  • args (Array<Object>) —

    optional message arguments

  • filename (String) (defaults to: nil) —

    optional file name for log info

  • line (Integer) (defaults to: 0) —

    optional line number for log info

  • func (String) (defaults to: nil) —

    optional function name for log info

  • component (String) (defaults to: nil) —

    optional component name for log info



88
 
# File 'lib/wx/doc/functions.rb', line 88

def self.log_debug(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end

.log_error(fmt, *args, filename: nil, line: 0, func: nil, component: nil) ⇒ void

This method returns an undefined value.

Log a Wx Error message to the current Wx log output

Parameters:

  • fmt (String) —

    message (formatting) string

  • args (Array<Object>) —

    optional message arguments

  • filename (String) (defaults to: nil) —

    optional file name for log info

  • line (Integer) (defaults to: 0) —

    optional line number for log info

  • func (String) (defaults to: nil) —

    optional function name for log info

  • component (String) (defaults to: nil) —

    optional component name for log info



57
 
# File 'lib/wx/doc/functions.rb', line 57

def self.log_error(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end

.log_generic(lvl, fmt, *args, filename: nil, line: 0, func: nil, component: nil) ⇒ void

This method returns an undefined value.

Log a Wx message with the given logging level to the current Wx log output

Parameters:

  • lvl (Integer) —

    logging level (like LOG_Message)

  • fmt (String) —

    message (formatting) string

  • args (Array<Object>) —

    optional message arguments

  • filename (String) (defaults to: nil) —

    optional file name for log info

  • line (Integer) (defaults to: 0) —

    optional line number for log info

  • func (String) (defaults to: nil) —

    optional function name for log info

  • component (String) (defaults to: nil) —

    optional component name for log info



27
 
# File 'lib/wx/doc/functions.rb', line 27

def self.log_generic(lvl, fmt, *args, filename: nil, line: 0, func: nil, component: nil) end

.log_info(fmt, *args, filename: nil, line: 0, func: nil, component: nil) ⇒ void

This method returns an undefined value.

Log a Wx low priority informational message to the current Wx log output

Parameters:

  • fmt (String) —

    message (formatting) string

  • args (Array<Object>) —

    optional message arguments

  • filename (String) (defaults to: nil) —

    optional file name for log info

  • line (Integer) (defaults to: 0) —

    optional line number for log info

  • func (String) (defaults to: nil) —

    optional function name for log info

  • component (String) (defaults to: nil) —

    optional component name for log info



37
 
# File 'lib/wx/doc/functions.rb', line 37

def self.log_info(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end

.log_message(fmt, *args, filename: nil, line: 0, func: nil, component: nil) ⇒ void

This method returns an undefined value.

Log a Wx Informational message to the current Wx log output

Parameters:

  • fmt (String) —

    message (formatting) string

  • args (Array<Object>) —

    optional message arguments

  • filename (String) (defaults to: nil) —

    optional file name for log info

  • line (Integer) (defaults to: 0) —

    optional line number for log info

  • func (String) (defaults to: nil) —

    optional function name for log info

  • component (String) (defaults to: nil) —

    optional component name for log info



47
 
# File 'lib/wx/doc/functions.rb', line 47

def self.log_message(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end

.log_status(win, fmt, *args) ⇒ nil .log_status(fmt, *args) ⇒ nil

Log a Wx Status message - this is directed to the status bar of the specified Frame window, or the application main window if not specified. Based on Wx::Widgets code in src/generic/logg.cpp, WxLogGui::DoLog

Overloads:

  • .log_status(win, fmt, *args) ⇒ nil

    Parameters:

    • win (Wx::Frame) —

      window to log to

    • fmt (String) —

      message (formatting) string

    • args (Array<Object>) —

      optional message arguments

  • .log_status(fmt, *args) ⇒ nil

    Parameters:

    • fmt (String) —

      message (formatting) string

    • args (Array<Object>) —

      optional message arguments

Returns:

  • (nil) 


101
 
# File 'lib/wx/doc/functions.rb', line 101

def self.log_status(fmt, *args) end

.log_verbose(fmt, *args, filename: nil, line: 0, func: nil, component: nil) ⇒ void

This method returns an undefined value.

Log a Wx verbose informational message to the current Wx log output (needs explicit activation to be shown)

Parameters:

  • fmt (String) —

    message (formatting) string

  • args (Array<Object>) —

    optional message arguments

  • filename (String) (defaults to: nil) —

    optional file name for log info

  • line (Integer) (defaults to: 0) —

    optional line number for log info

  • func (String) (defaults to: nil) —

    optional function name for log info

  • component (String) (defaults to: nil) —

    optional component name for log info



78
 
# File 'lib/wx/doc/functions.rb', line 78

def self.log_verbose(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end

.log_warning(fmt, *args, filename: nil, line: 0, func: nil, component: nil) ⇒ void

This method returns an undefined value.

Log a Wx Warning message to the current Wx log output

Parameters:

  • fmt (String) —

    message (formatting) string

  • args (Array<Object>) —

    optional message arguments

  • filename (String) (defaults to: nil) —

    optional file name for log info

  • line (Integer) (defaults to: 0) —

    optional line number for log info

  • func (String) (defaults to: nil) —

    optional function name for log info

  • component (String) (defaults to: nil) —

    optional component name for log info



67
 
# File 'lib/wx/doc/functions.rb', line 67

def self.log_warning(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end

.message_box(message, caption = Wx::MESSAGE_BOX_CAPTION_STR, style = (Wx::OK|Wx::GeometryCentre::CENTRE), parent = nil, x = Wx::DEFAULT_COORD, y = Wx::DEFAULT_COORD) ⇒ Integer

Show a general purpose message dialog.

This is a convenient function which is usually used instead of using MessageDialog directly. Notice however that some of the features, such as extended text and custom labels for the message box buttons, are not provided by this function but only by MessageDialog. The return value is one of: YES, NO, CANCEL, OK or HELP (notice that this return value is different from the return value of Wx::MessageDialog#show_modal). For example:

answer = Wx.message_box("Quit program?", "Confirm",
                           Wx::YES_NO | Wx::CANCEL, main_frame)
  main_frame.close if answer == Wx::YES

message may contain newline characters, in which case the message will be split into separate lines, to cater for large messages.

Parameters:

  • message (String) —

    Message to show in the dialog.

  • caption (String) (defaults to: Wx::MESSAGE_BOX_CAPTION_STR) —

    The dialog title.

  • style (Integer) (defaults to: (Wx::OK|Wx::GeometryCentre::CENTRE)) —

    Combination of style flags described in MessageDialog documentation.

  • parent (Wx::Window) (defaults to: nil) —

    Parent window.

  • x (Integer) (defaults to: Wx::DEFAULT_COORD) —

    Horizontal dialog position (ignored under MSW). Use DEFAULT_COORD for x and y to let the system position the window.

  • y (Integer) (defaults to: Wx::DEFAULT_COORD) —

    Vertical dialog position (ignored under MSW).

Returns:

  • (Integer) 


32
 
# File 'lib/wx/doc/gen/message_dialog.rb', line 32

def self.message_box(message, caption=Wx::MESSAGE_BOX_CAPTION_STR, style=(Wx::OK|Wx::GeometryCentre::CENTRE), parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD) end

.new_event_type ⇒ Wx::GenericCollapsiblePane::EventType

Generates a new unique event type.

Usually this function is only used by define_event and not called directly.

Returns:

  • (Wx::GenericCollapsiblePane::EventType) 


687
 
# File 'lib/wx/doc/gen/event.rb', line 687

def self.new_event_type; end

.persistent_register_and_restore(obj, name = nil) ⇒ Boolean

A shorter synonym for Wx::PersistenceManager#register_and_restore.

This function simply calls Wx::PersistenceManager#register_and_restore but using it results in slightly shorter code as it calls Wx::PersistenceManager.get internally. As an additional convenience, this function can also set the window name.

Returns true if the settings were restored or false otherwise (this will always be the case when the program runs for the first time, for example).

Parameters:

  • obj (Wx::Window) —

    window to register with persistence manager and to try to restore the settings for.

  • name (String) (defaults to: nil) —

    If specified non-empty, window name is changed to the provided value before registering it.

Returns:

  • (Boolean) 


31
 
# File 'lib/wx/doc/persistence_manager.rb', line 31

def self.persistent_register_and_restore(obj, name=nil) end

.post_event(dest, event) ⇒ void

This method returns an undefined value.

In a GUI application, this function posts event to the specified dest object using Wx::EvtHandler#add_pending_event.

Otherwise, it dispatches event immediately using Wx::EvtHandler#process_event. See the respective documentation for details (and caveats). Because of limitation of Wx::EvtHandler#add_pending_event this function is not thread-safe for event objects having String fields, use queue_event instead.

Parameters:



695
 
# File 'lib/wx/doc/gen/event.rb', line 695

def self.post_event(dest, event) end

.ptr_addr(obj) ⇒ String

Returns the pointer address of the underlying C++ object as a hex string - useful for debugging

Parameters:

  • obj (::Object) —

    wrapped object

Returns:

  • (String) —

    string with address in hex format



114
 
# File 'lib/wx/doc/functions.rb', line 114

def self.ptr_addr(obj) end

.rad_to_deg(rad) ⇒ Float

Convert radians to degrees.

Parameters:

  • rad (Float) —

    radians

Returns:

  • (Float) —

    degrees



23
 
# File 'lib/wx/doc/geometry.rb', line 23

def self.rad_to_deg(rad) end

.register_id(id) ⇒ void

This method returns an undefined value.

Ensures that Ids subsequently generated by new_id do not clash with the given id.

Parameters:

  • id (Integer) 


121
 
# File 'lib/wx/doc/gen/utils.rb', line 121

def self.register_id(id) end

.safe_yield(win = nil, only_if_needed = false) ⇒ Object 



124
 
# File 'lib/wx/doc/functions.rb', line 124

def self.safe_yield(win = nil, only_if_needed = false) end

.save_file_selector(what, extension, default_name = '', parent = nil) ⇒ Object

Shows a file dialog asking the user for a file name for opening a file.

See Also:

  • Wx::FileDialog


236
 
# File 'lib/wx/doc/functions.rb', line 236

def self.save_file_selector(what, extension, default_name='', parent=nil) end

.set_cursor(cursor) ⇒ void

This method returns an undefined value.

Globally sets the cursor; only has an effect on Windows, Mac and GTK+.

You should call this function with NULL_CURSOR to restore the system cursor.

Parameters:

See Also:



333
 
# File 'lib/wx/doc/gen/gdi_common.rb', line 333

def self.set_cursor(cursor) end

.show_tip(parent, tipProvider, showAtStartup = true) ⇒ Boolean

This function shows a “startup tip” to the user.

The return value is the state of the “Show tips at startup” checkbox.

Parameters:

  • parent (Wx::Window) —

    The parent window for the modal dialog.

  • tipProvider (Wx::TipProvider) —

    An object which is used to get the text of the tips. It may be created with the create_file_tip_provider function.

  • showAtStartup (Boolean) (defaults to: true) —

    Should be true if startup tips are shown, false otherwise. This is used as the initial value for “Show tips at startup” checkbox which is shown in the tips dialog.

Returns:

  • (Boolean)

See Also:

  • Overview


26
 
# File 'lib/wx/doc/gen/tip_provider.rb', line 26

def self.show_tip(parent, tipProvider, showAtStartup=true) end

.shutdown(flags = Wx::SHUTDOWN_POWEROFF) ⇒ Boolean

This function shuts down or reboots the computer depending on the value of the flags.

Note:

Note that performing the shutdown requires the corresponding access rights (superuser under Unix, SE_SHUTDOWN privilege under Windows) and that this function is only implemented under Unix and MSW.

true on success, false if an error occurred.

Parameters:

  • flags (Integer) (defaults to: Wx::SHUTDOWN_POWEROFF) —

    One of SHUTDOWN_POWEROFF, SHUTDOWN_REBOOT or SHUTDOWN_LOGOFF (currently implemented only for MSW) possibly combined with SHUTDOWN_FORCE which forces shutdown under MSW by forcefully terminating all the applications. As doing this can result in a data loss, this flag shouldn’t be used unless really necessary.

Returns:

  • (Boolean) 


294
 
# File 'lib/wx/doc/gen/utils.rb', line 294

def self.shutdown(flags=Wx::SHUTDOWN_POWEROFF) end

.strip_menu_codes(str, flags = Wx::Strip_All) ⇒ String

Strips any menu codes from str and returns the result.

By default, the functions strips both the mnemonics character ('&') which is used to indicate a keyboard shortkey, and the accelerators, which are used only in the menu items and are separated from the main text by the \t (TAB) character. By using flags of Strip_Mnemonics or Strip_Accel to strip only the former or the latter part, respectively. Notice that in most cases Wx::MenuItem.get_label_from_text or Wx::Control#get_label_text can be used instead.

Parameters:

  • str (String)
  • flags (Integer) (defaults to: Wx::Strip_All)

Returns:

  • (String) 


165
 
# File 'lib/wx/doc/gen/utils.rb', line 165

def self.strip_menu_codes(str, flags=Wx::Strip_All) end

.to_string(colour) ⇒ String

Converts the given Colour into a string.

Parameters:

Returns:

  • (String)

See Also:

  • wxString&
  • wxColour*)


49
 
# File 'lib/wx/doc/gen/colour.rb', line 49

def self.to_string(colour) end

.xrcid(str) ⇒ Integer

Converts a string XRC id into a Wx id

Parameters:

  • str (String) —

    XRC id string

Returns:

  • (Integer) —

    Wx Id



119
 
# File 'lib/wx/doc/functions.rb', line 119

def self.xrcid(str) end