# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx # Possible values for {Wx::SystemSettings.get_font} parameter. # # These values map 1:1 the native values supported by the Windows' GetStockObject function. Note that other ports (other than WXMSW) will try to provide meaningful fonts but they usually map the same font to various wxSYS_*_FONT values. # class SystemFont < Wx::Enum # Original equipment manufacturer dependent fixed-pitch font. # SYS_OEM_FIXED_FONT = Wx::SystemFont.new(10) # Windows fixed-pitch (monospaced) font. # SYS_ANSI_FIXED_FONT = Wx::SystemFont.new(11) # Windows variable-pitch (proportional) font. # SYS_ANSI_VAR_FONT = Wx::SystemFont.new(12) # System font. # SYS_SYSTEM_FONT = Wx::SystemFont.new(13) # Device-dependent font. # SYS_DEVICE_DEFAULT_FONT = Wx::SystemFont.new(14) # Default font for user interface objects such as menus and dialog boxes. # SYS_DEFAULT_GUI_FONT = Wx::SystemFont.new(17) end # SystemFont # Possible values for {Wx::SystemSettings.get_colour} parameter. # # These values map 1:1 the native values supported by the Windows' GetSysColor function. Note that other ports (other than WXMSW) will try to provide meaningful colours but they usually map the same colour to various wxSYS_COLOUR_* values. # class SystemColour < Wx::Enum # The scrollbar grey area. # SYS_COLOUR_SCROLLBAR = Wx::SystemColour.new(0) # The desktop colour. # SYS_COLOUR_DESKTOP = Wx::SystemColour.new(1) # Active window caption colour. # SYS_COLOUR_ACTIVECAPTION = Wx::SystemColour.new(2) # Inactive window caption colour. # SYS_COLOUR_INACTIVECAPTION = Wx::SystemColour.new(3) # Menu background colour. # SYS_COLOUR_MENU = Wx::SystemColour.new(4) # Window background colour. # SYS_COLOUR_WINDOW = Wx::SystemColour.new(5) # Window frame colour. # SYS_COLOUR_WINDOWFRAME = Wx::SystemColour.new(6) # Colour of the text used in the menus. # SYS_COLOUR_MENUTEXT = Wx::SystemColour.new(7) # Colour of the text used in generic windows. # SYS_COLOUR_WINDOWTEXT = Wx::SystemColour.new(8) # Colour of the text used in captions, size boxes and scrollbar arrow boxes. # SYS_COLOUR_CAPTIONTEXT = Wx::SystemColour.new(9) # Active window border colour. # SYS_COLOUR_ACTIVEBORDER = Wx::SystemColour.new(10) # Inactive window border colour. # SYS_COLOUR_INACTIVEBORDER = Wx::SystemColour.new(11) # Background colour for MDI applications. # SYS_COLOUR_APPWORKSPACE = Wx::SystemColour.new(12) # Colour of item(s) selected in a control. # SYS_COLOUR_HIGHLIGHT = Wx::SystemColour.new(13) # Colour of the text of item(s) selected in a control. # SYS_COLOUR_HIGHLIGHTTEXT = Wx::SystemColour.new(14) # Face shading colour on push buttons. # SYS_COLOUR_BTNFACE = Wx::SystemColour.new(15) # Edge shading colour on push buttons. # SYS_COLOUR_BTNSHADOW = Wx::SystemColour.new(16) # Colour of greyed (disabled) text. # SYS_COLOUR_GRAYTEXT = Wx::SystemColour.new(17) # Colour of the text on push buttons. # SYS_COLOUR_BTNTEXT = Wx::SystemColour.new(18) # Colour of the text in inactive captions. # SYS_COLOUR_INACTIVECAPTIONTEXT = Wx::SystemColour.new(19) # Highlight colour for buttons. # SYS_COLOUR_BTNHIGHLIGHT = Wx::SystemColour.new(20) # Dark shadow colour for three-dimensional display elements. # SYS_COLOUR_3DDKSHADOW = Wx::SystemColour.new(21) # Light colour for three-dimensional display elements. # SYS_COLOUR_3DLIGHT = Wx::SystemColour.new(22) # Text colour for tooltip controls. # SYS_COLOUR_INFOTEXT = Wx::SystemColour.new(23) # Background colour for tooltip controls. # SYS_COLOUR_INFOBK = Wx::SystemColour.new(24) # Background colour for list-like controls. # SYS_COLOUR_LISTBOX = Wx::SystemColour.new(25) # Colour for a hyperlink or hot-tracked item. # SYS_COLOUR_HOTLIGHT = Wx::SystemColour.new(26) # Right side colour in the colour gradient of an active window's title bar. # SYS_COLOUR_GRADIENTACTIVECAPTION = Wx::SystemColour.new(27) # Right side colour in the colour gradient of an inactive window's title bar. # SYS_COLOUR_GRADIENTINACTIVECAPTION = Wx::SystemColour.new(28) # The colour used to highlight menu items when the menu appears as a flat menu. # SYS_COLOUR_MENUHILIGHT = Wx::SystemColour.new(29) # The background colour for the menu bar when menus appear as flat menus. # SYS_COLOUR_MENUBAR = Wx::SystemColour.new(30) # Text colour for list-like controls. # SYS_COLOUR_LISTBOXTEXT = Wx::SystemColour.new(31) # Text colour for the unfocused selection of list-like controls. # SYS_COLOUR_LISTBOXHIGHLIGHTTEXT = Wx::SystemColour.new(32) # Synonym for {Wx::SystemColour::SYS_COLOUR_DESKTOP}. # SYS_COLOUR_BACKGROUND = Wx::SystemColour.new(1) # Synonym for {Wx::SystemColour::SYS_COLOUR_BTNFACE}. # SYS_COLOUR_3DFACE = Wx::SystemColour.new(15) # Synonym for {Wx::SystemColour::SYS_COLOUR_BTNSHADOW}. # SYS_COLOUR_3DSHADOW = Wx::SystemColour.new(16) # Synonym for {Wx::SystemColour::SYS_COLOUR_BTNHIGHLIGHT}. # SYS_COLOUR_BTNHILIGHT = Wx::SystemColour.new(20) # Synonym for {Wx::SystemColour::SYS_COLOUR_BTNHIGHLIGHT}. # SYS_COLOUR_3DHIGHLIGHT = Wx::SystemColour.new(20) # Synonym for {Wx::SystemColour::SYS_COLOUR_BTNHIGHLIGHT}. # SYS_COLOUR_3DHILIGHT = Wx::SystemColour.new(20) # Synonym for {Wx::SystemColour::SYS_COLOUR_BTNFACE}. # SYS_COLOUR_FRAMEBK = Wx::SystemColour.new(15) end # SystemColour # Possible values for {Wx::SystemSettings.get_metric} index parameter. # # # class SystemMetric < Wx::Enum # Number of buttons on mouse, or zero if no mouse was installed. # SYS_MOUSE_BUTTONS = Wx::SystemMetric.new(1) # Width of single border. # SYS_BORDER_X = Wx::SystemMetric.new(2) # Height of single border. # SYS_BORDER_Y = Wx::SystemMetric.new(3) # Width of cursor. # SYS_CURSOR_X = Wx::SystemMetric.new(4) # Height of cursor. # SYS_CURSOR_Y = Wx::SystemMetric.new(5) # Width in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click. # SYS_DCLICK_X = Wx::SystemMetric.new(6) # Height in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click. # SYS_DCLICK_Y = Wx::SystemMetric.new(7) # Width in pixels of a rectangle centered on a drag point to allow for limited movement of the mouse pointer before a drag operation begins. # SYS_DRAG_X = Wx::SystemMetric.new(8) # Height in pixels of a rectangle centered on a drag point to allow for limited movement of the mouse pointer before a drag operation begins. # SYS_DRAG_Y = Wx::SystemMetric.new(9) # Width of a 3D border, in pixels. # SYS_EDGE_X = Wx::SystemMetric.new(10) # Height of a 3D border, in pixels. # SYS_EDGE_Y = Wx::SystemMetric.new(11) # Width of arrow bitmap on horizontal scrollbar. # SYS_HSCROLL_ARROW_X = Wx::SystemMetric.new(12) # Height of arrow bitmap on horizontal scrollbar. # SYS_HSCROLL_ARROW_Y = Wx::SystemMetric.new(13) # Width of horizontal scrollbar thumb. # SYS_HTHUMB_X = Wx::SystemMetric.new(14) # The default width of an icon. # SYS_ICON_X = Wx::SystemMetric.new(15) # The default height of an icon. # SYS_ICON_Y = Wx::SystemMetric.new(16) # Width of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged. # SYS_ICONSPACING_X = Wx::SystemMetric.new(17) # Height of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged. # SYS_ICONSPACING_Y = Wx::SystemMetric.new(18) # Minimum width of a window. # SYS_WINDOWMIN_X = Wx::SystemMetric.new(19) # Minimum height of a window. # SYS_WINDOWMIN_Y = Wx::SystemMetric.new(20) # Width of the screen in pixels. # SYS_SCREEN_X = Wx::SystemMetric.new(21) # Height of the screen in pixels. # SYS_SCREEN_Y = Wx::SystemMetric.new(22) # Width of the window frame for a {Wx::THICK_FRAME} window. # SYS_FRAMESIZE_X = Wx::SystemMetric.new(23) # Height of the window frame for a {Wx::THICK_FRAME} window. # SYS_FRAMESIZE_Y = Wx::SystemMetric.new(24) # Recommended width of a small icon (in window captions, and small icon view). # SYS_SMALLICON_X = Wx::SystemMetric.new(25) # Recommended height of a small icon (in window captions, and small icon view). # SYS_SMALLICON_Y = Wx::SystemMetric.new(26) # Height of horizontal scrollbar in pixels. # SYS_HSCROLL_Y = Wx::SystemMetric.new(27) # Width of vertical scrollbar in pixels. # SYS_VSCROLL_X = Wx::SystemMetric.new(28) # Width of arrow bitmap on a vertical scrollbar. # SYS_VSCROLL_ARROW_X = Wx::SystemMetric.new(29) # Height of arrow bitmap on a vertical scrollbar. # SYS_VSCROLL_ARROW_Y = Wx::SystemMetric.new(30) # Height of vertical scrollbar thumb. # SYS_VTHUMB_Y = Wx::SystemMetric.new(31) # Height of normal caption area. # SYS_CAPTION_Y = Wx::SystemMetric.new(32) # Height of single-line menu bar. # SYS_MENU_Y = Wx::SystemMetric.new(33) # 1 if there is a network present, 0 otherwise. # SYS_NETWORK_PRESENT = Wx::SystemMetric.new(34) # 1 if PenWindows is installed, 0 otherwise. # SYS_PENWINDOWS_PRESENT = Wx::SystemMetric.new(35) # Non-zero if the user requires an application to present information visually in situations where it would otherwise present the information only in audible form; zero otherwise. # SYS_SHOW_SOUNDS = Wx::SystemMetric.new(36) # Non-zero if the meanings of the left and right mouse buttons are swapped; zero otherwise. # SYS_SWAP_BUTTONS = Wx::SystemMetric.new(37) # Maximal time, in milliseconds, which may pass between subsequent clicks for a double click to be generated. # SYS_DCLICK_MSEC = Wx::SystemMetric.new(38) # Time, in milliseconds, for how long a blinking caret should stay visible during a single blink cycle before it disappears. # SYS_CARET_ON_MSEC = Wx::SystemMetric.new(39) # Time, in milliseconds, for how long a blinking caret should stay invisible during a single blink cycle before it reappears. # SYS_CARET_OFF_MSEC = Wx::SystemMetric.new(40) # Time, in milliseconds, for how long a caret should blink after a user interaction. # SYS_CARET_TIMEOUT_MSEC = Wx::SystemMetric.new(41) end # SystemMetric # Possible values for {Wx::SystemSettings.has_feature} parameter. # # # class SystemFeature < Wx::Enum # # SYS_CAN_DRAW_FRAME_DECORATIONS = Wx::SystemFeature.new(1) # # SYS_CAN_ICONIZE_FRAME = Wx::SystemFeature.new(2) # # SYS_TABLET_PRESENT = Wx::SystemFeature.new(3) end # SystemFeature # Values for different screen designs. # # See {Wx::SystemSettings.get_screen_type}. # class SystemScreenType < Wx::Enum # Undefined screen type. # SYS_SCREEN_NONE = Wx::SystemScreenType.new(0) # Tiny screen, less than 320x240. # SYS_SCREEN_TINY = Wx::SystemScreenType.new(1) # PDA screen, 320x240 or more but less than 640x480. # SYS_SCREEN_PDA = Wx::SystemScreenType.new(2) # Small screen, 640x480 or more but less than 800x600. # SYS_SCREEN_SMALL = Wx::SystemScreenType.new(3) # Desktop screen, 800x600 or more. # SYS_SCREEN_DESKTOP = Wx::SystemScreenType.new(4) end # SystemScreenType # {Wx::SystemSettings} allows the application to ask for details about the system. # # This can include settings such as standard colours, fonts, and user interface element sizes. # # Category: Application and System configuration # @see Wx::Font # @see Wx::Colour # @see Wx::SystemOptions # # class SystemSettings < ::Object # Default constructor. # # You don't need to create an instance of {Wx::SystemSettings} since all of its functions are static. # @return [Wx::SystemSettings] def initialize; end # Returns a system colour. # # The returned colour is always valid. # @param index [Wx::SystemColour] Can be one of the {Wx::SystemColour} enum values. # @return [Wx::Colour] def self.get_colour(index) end # Returns a system font. # # The returned font is always valid. # @param index [Wx::SystemFont] Can be one of the {Wx::SystemFont} enum values. # @return [Wx::Font] def self.get_font(index) end # Returns the value of a system metric, or -1 if the metric is not supported on the current system. # # The value of win determines if the metric returned is a global value or a {Wx::Window} based value, in which case it might determine the widget, the display the window is on, or something similar. The window given should be as close to the metric as possible (e.g. a {Wx::TopLevelWindow} in case of the {Wx::SystemMetric::SYS_CAPTION_Y} metric). # index can be one of the {Wx::SystemMetric} enum values. # win is a pointer to the window for which the metric is requested. Specifying the win parameter is encouraged, because some metrics on some ports are not supported without one, or they might be capable of reporting better values if given one. If a window does not make sense for a metric, one should still be given, as for example it might determine which displays cursor width is requested with {Wx::SystemMetric::SYS_CURSOR_X}. # @param index [Wx::SystemMetric] # @param win [Wx::Window] # @return [Integer] def self.get_metric(index, win=nil) end # Returns the screen type. # # The return value is one of the {Wx::SystemScreenType} enum values. # @return [Wx::SystemScreenType] def self.get_screen_type; end # Returns true if the port has certain feature. # # See the {Wx::SystemFeature} enum values. # @param index [Wx::SystemFeature] # @return [Boolean] def self.has_feature(index) end end # SystemSettings end