wxsystemvalues()

wxsystemvalues()
	Chapter 11. The wxWidgets-based (WXWN) Components

wxsystemvalues()

Description

Retrieves the system values corresponding to the parameters passed. These are returned in the pre-initialized objects passed to the specified parameters.

Prototype

wxsystemvalues ( integer rgb_background, integer rgb_activeborder, integer rgb_inactiveborder, integer rgb_windowframe, integer rgb_activecaption, integer rgb_captiontext, integer rgb_inactivecaption, integer rgb_inactivecaptiontext, integer rgb_menu, integer rgb_menutext, integer rgb_window, integer rgb_appworkspace, integer rgb_windowtext, integer rgb_scrollbar, integer rgb_3ddarkshadow, integer rgb_3dlight, integer rgb_highlight, integer rgb_highlighttext, integer rgb_graytext, integer rgb_buttonface, integer rgb_buttonshadow, integer rgb_buttontext, integer rgb_buttonhighlight, integer rgb_infotext, integer rgb_infobackground, integer metric_networkpresent, integer metric_penwindowspresent, integer metric_showsounds, integer metric_mousebuttons, integer metric_swapbuttons, integer metric_doubleclick_x, integer metric_doubleclick_y, integer metric_drag_x, integer metric_drag_y, integer metric_screen_x, integer metric_screen_y, integer metric_windowminimum_x, integer metric_windowminimum_y, integer metric_border_x, integer metric_border_y, integer metric_framesize_x, integer metric_framesize_y, integer metric_edge_x, integer metric_edge_y, integer metric_caption_y, integer metric_menu_y, integer metric_hscroll_arrow_x, integer metric_hscroll_arrow_y, integer metric_hscroll_y, integer metric_hthumb_x, integer metric_vscroll_arrow_x, integer metric_vscroll_arrow_y, integer metric_vscroll_x, integer metric_vthumb_y, integer metric_cursor_x, integer metric_cursor_y, integer metric_icon_x, integer metric_icon_y, integer metric_iconspacing_x, integer metric_iconspacing_y, integer metric_smallicon_x, integer metric_smallicon_y, integer error )

Parameters

Parameter	Default value	Type name	Description
rgb_background	`.nul`	integer	Retrieves the desktop color.
rgb_activeborder	`.nul`	integer	Retrieves the active window border color.
rgb_inactiveborder	`.nul`	integer	Retrieves the inactive window border color.
rgb_windowframe	`.nul`	integer	Retrieves the window frame color.
rgb_activecaption	`.nul`	integer	Retrieves the active window caption color.
rgb_captiontext	`.nul`	integer	Retrieves the color for text in caption, size box and scrollbar arrow box.
rgb_inactivecaption	`.nul`	integer	Retrieves the color of the inactive window caption.
rgb_inactivecaptiontext	`.nul`	integer	Retrieves the color of text in inactive window captions.
rgb_menu	`.nul`	integer	Retrieves the menu background color.
rgb_menutext	`.nul`	integer	Retrieves the menu text color.
rgb_window	`.nul`	integer	Retrieves the window background color.
rgb_appworkspace	`.nul`	integer	Retrieves the background color for MDI applications.
rgb_windowtext	`.nul`	integer	Retrieves the color for text in windows.
rgb_scrollbar	`.nul`	integer	Retrieves the color for the scrollbar gray area.
rgb_3ddarkshadow	`.nul`	integer	Retrieves the color of dark shadow for three-dimensional display elements.
rgb_3dlight	`.nul`	integer	Retrieves the light color for three-dimensional display elements.
rgb_highlight	`.nul`	integer	Retrieves the color for items selected in a control.
rgb_highlighttext	`.nul`	integer	Retrieves the color for text of items selected in a control.
rgb_graytext	`.nul`	integer	Retrieves the color for gray (disabled) text.
rgb_buttonface	`.nul`	integer	Retrieves the color used for face shading on push buttons.
rgb_buttonshadow	`.nul`	integer	Retrieves the color for edge shading on push buttons.
rgb_buttontext	`.nul`	integer	Retrieves the color of text on push buttons.
rgb_buttonhighlight	`.nul`	integer	Retrieves the highlight color for buttons.
rgb_infotext	`.nul`	integer	Retrieves the text color for tool tip controls.
rgb_infobackground	`.nul`	integer	Retrieves the background color for tool tip controls.
metric_networkpresent	`.nul`	integer	Returns `1` if a network is present, `0` otherwise.
metric_penwindowspresent	`.nul`	integer	Returns `1` if PenWindows is installed, `0` otherwise.
metric_showsounds	`.nul`	integer	Returns 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.
metric_mousebuttons	`.nul`	integer	Returns the number of buttons on the mouse, or zero if no mouse was installed.
metric_swapbuttons	`.nul`	integer	Returns non-zero if the meanings of the left and right mouse buttons are swapped; zero otherwise.
metric_doubleclick_x	`.nul`	integer	Returns the width in pixels of the rectangle within which two successive mouse clicks must fall to generate a double-click.
metric_doubleclick_y	`.nul`	integer	Returns the height in pixels of the rectangle within which two successive mouse clicks must fall to generate a double-click.
metric_drag_x	`.nul`	integer	Returns the 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.
metric_drag_y	`.nul`	integer	Returns the 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.
metric_screen_x	`.nul`	integer	Returns the width of the screen in pixels.
metric_screen_y	`.nul`	integer	Returns the height of the screen in pixels.
metric_windowminimum_x	`.nul`	integer	Returns the minimum width of a window in pixels.
metric_windowminimum_y	`.nul`	integer	Returns the minimum height of a window in pixels.
metric_border_x	`.nul`	integer	Returns the width in pixels of the single border.
metric_border_y	`.nul`	integer	Returns the height in pixels of the single border.
metric_framesize_x	`.nul`	integer	Returns the width in pixels of the window frame for a window with a `sizeable` border.
metric_framesize_y	`.nul`	integer	Returns the height in pixels of the window frame for a window with a `sizeable` border.
metric_edge_x	`.nul`	integer	Returns the width of a 3-D border in pixels.
metric_edge_y	`.nul`	integer	Returns the height of a 3-D border in pixels.
metric_caption_y	`.nul`	integer	Returns the height in pixels of a normal caption area.
metric_menu_y	`.nul`	integer	Returns the height in pixels of a single-line menu bar.
metric_hscroll_arrow_x	`.nul`	integer	Returns the width in pixels of the arrow bitmap on a horizontal scrollbar.
metric_hscroll_arrow_y	`.nul`	integer	Returns the height in pixels of the arrow bitmap on a horizontal scrollbar.
metric_hscroll_y	`.nul`	integer	Returns the height in pixels of the horizontal scrollbar.
metric_hthumb_x	`.nul`	integer	Returns the width in pixels of the horizontal scrollbar thumb.
metric_vscroll_arrow_x	`.nul`	integer	Returns the width in pixels of the arrow bitmap on a vertical scrollbar.
metric_vscroll_arrow_y	`.nul`	integer	Returns the height in pixels of the arrow bitmap on a vertical scrollbar.
metric_vscroll_x	`.nul`	integer	Returns the width in pixels of the vertical scrollbar.
metric_vthumb_y	`.nul`	integer	Returns the height in pixels of the vertical scrollbar thumb.
metric_cursor_x	`.nul`	integer	Returns the width in pixels of the cursor.
metric_cursor_y	`.nul`	integer	Returns the height in pixels of the cursor.
metric_icon_x	`.nul`	integer	Returns the default width in pixels of an icon.
metric_icon_y	`.nul`	integer	Returns the default height in pixels of an icon.
metric_iconspacing_x	`.nul`	integer	Returns the default width of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged.
metric_iconspacing_y	`.nul`	integer	Returns the default height of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged.
metric_smallicon_x	`.nul`	integer	Returns the recommended width in pixels of a small icon (in window captions, and small icon view).
metric_smallicon_y	`.nul`	integer	Returns the recommended height in pixels of a small icon (in window captions, and small icon view).
error	`.nul`	integer	Specifies an object which is used to output any error code generated during the execution of the function. If `error` is not specified or is `.nul` then any error which occurs during function execution will halt the program. If an error object is specified and an error occurs during function execution then the error code is output into that object and the methods returns `.nul`.


wxsystemfont()		Chapter 12. The Shared Library (SLIB) Component