Miscellaneous Routines

• proc cleanup()   
• proc delete_instance( object obj )   
• func find_window( integer id, atom parent )   
• func from_utf8( sequence utf8 )   
• func get_display_size()   
• func get_key_state( integer keycode )   
• func get_sys_color( atom color )   
• func get_sys_metric( integer metric )   
• proc launch_default_browser( sequence url )   
• func message_box( sequence text, sequence title, atom ok )   
• func mkdir( sequence directory, object perm, integer flags )   
• proc request_user_attention( atom frame, atom flags )   
• func to_utf8( sequence string )   
• proc wxMain( atom topWindow )   
• proc wx_execute( sequence command, integer flag )   
• func wx_or_all( sequence a )   
• proc wx_shell( sequence command )   
• func w_sprintf( sequence format, object values )   

Miscellaneous Routines

[proc]
cleanup ()

This cleans up internal wxWidgets memory. wxMain() automatically calls this before it exits. If you do not use wxMain(), then you should manually call cleanup() before your app exits.

Miscellaneous Routines

[proc]
delete_instance ( object obj )

Deletes an object from memory.

Miscellaneous Routines

[func]
find_window ( integer id, atom parent )

Returns: Window pointer

Returns the window identified by its id and parent.

Miscellaneous Routines

[func]
from_utf8 ( sequence utf8 )

Converts a sequence with UTF8 encoded text into a unicode string that can be used like a normal string.

See also to_utf8()

Miscellaneous Routines

[func]
get_display_size ()

Returns the display size in pixels.

Miscellaneous Routines

[func]
get_key_state ( integer keycode )

Returns: True or false

Returns 1 if specified key (see Key Codes for a list of codes to use) is currently pressed down.

Miscellaneous Routines

[func]
get_sys_color ( atom color )

Returns: pointer to wxColour Available system colors are:

• wxSYS_COLOUR_SCROLLBAR
• wxSYS_COLOUR_BACKGROUND
• wxSYS_COLOUR_ACTIVECAPTION
• wxSYS_COLOUR_INACTIVECAPTION
• wxSYS_COLOUR_MENU
• wxSYS_COLOUR_WINDOW
• wxSYS_COLOUR_WINDOWFRAME
• wxSYS_COLOUR_MENUTEXT
• wxSYS_COLOUR_WINDOWTEXT
• wxSYS_COLOUR_CAPTIONTEXT
• wxSYS_COLOUR_ACTIVEBORDER
• wxSYS_COLOUR_INACTIVEBORDER
• wxSYS_COLOUR_APPWORKSPACE
• wxSYS_COLOUR_HIGHLIGHT
• wxSYS_COLOUR_HIGHLIGHTTEXT
• wxSYS_COLOUR_BTNFACE
• wxSYS_COLOUR_BTNSHADOW
• wxSYS_COLOUR_GRAYTEXT
• wxSYS_COLOUR_BTNTEXT
• wxSYS_COLOUR_INACTIVECAPTIONTEXT
• wxSYS_COLOUR_BTNHIGHLIGHT
• wxSYS_COLOUR_3DDKSHADOW
• wxSYS_COLOUR_3DLIGHT
• wxSYS_COLOUR_INFOTEXT
• wxSYS_COLOUR_INFOBK
• wxSYS_COLOUR_LISTBOX
• wxSYS_COLOUR_DESKTOP
• wxSYS_COLOUR_3DFACE
• wxSYS_COLOUR_3DSHADOW
• wxSYS_COLOUR_3DHIGHLIGHT
• wxSYS_COLOUR_3DHILIGHT
• wxSYS_COLOUR_BTNHILIGHT

Miscellaneous Routines

[func]
get_sys_metric ( integer metric )

Returns: atom

Available metrics are:

• wxSYS_MOUSE_BUTTONS
• wxSYS_BORDER_X
• wxSYS_BORDER_Y
• wxSYS_CURSOR_X
• wxSYS_CURSOR_Y
• wxSYS_DCLICK_X
• wxSYS_DCLICK_Y
• wxSYS_DRAG_X
• wxSYS_DRAG_Y
• wxSYS_EDGE_X
• wxSYS_EDGE_Y
• wxSYS_HSCROLL_ARROW_X
• wxSYS_HSCROLL_ARROW_Y
• wxSYS_HTHUMB_X
• wxSYS_ICON_X
• wxSYS_ICON_Y
• wxSYS_ICONSPACING_X
• wxSYS_ICONSPACING_Y
• wxSYS_WINDOWMIN_X
• wxSYS_WINDOWMIN_Y
• wxSYS_SCREEN_X
• wxSYS_SCREEN_Y
• wxSYS_FRAMESIZE_X
• wxSYS_FRAMESIZE_Y
• wxSYS_SMALLICON_X
• wxSYS_SMALLICON_Y
• wxSYS_HSCROLL_Y
• wxSYS_VSCROLL_X
• wxSYS_VSCROLL_ARROW_X
• wxSYS_VSCROLL_ARROW_Y
• wxSYS_VTHUMB_Y
• wxSYS_CAPTION_Y
• wxSYS_MENU_Y
• wxSYS_NETWORK_PRESENT
• wxSYS_PENWINDOWS_PRESENT
• wxSYS_SHOW_SOUNDS
• wxSYS_SWAP_BUTTONS

Miscellaneous Routines

[proc]
launch_default_browser ( sequence url )

Launches the user's default browser to open the specified url.

Miscellaneous Routines

[func]
message_box ( sequence text, sequence title, atom ok )

Returns: Selected button ID

Creates a message box dialog, with style ok.

Allowable styles are:

• wxOK
• wxYES_NO
• wxCANCEL
• wxYES
• wxNO
• wxNO_DEFAULT
• wxYES_DEFAULT
• wxICON_EXCLAMATION
• wxICON_HAND
• wxICON_WARNING
• wxICON_ERROR
• wxICON_QUESTION
• wxICON_INFORMATION
• wxICON_STOP
• wxICON_ASTERISK

Possible return values are:

• wxOK
• wxCANCEL
• wxYES
• wxNO

Miscellaneous Routines

[func]
mkdir ( sequence directory, object perm, integer flags )

Creates a directory with the (optional) given permissions.

If the flags contain wxPATH_MKDIR_FULL flag, try to create each directory in the path and also don't return an error if the target directory already exists.

Miscellaneous Routines

[proc]
request_user_attention ( atom frame, atom flags )

Use a system-dependent way to attract users attention to the window when it is in background.

flags may have the value of either wxUSER_ATTENTION_INFO (default) or wxUSER_ATTENTION_ERROR which results in a more drastic action. When in doubt, use the default value.

Note that this function should normally be only used when the application is not already in foreground.

This function is currently implemented for Win32 where it flashes the window icon in the taskbar, and for wxGTK with task bars supporting it.

Miscellaneous Routines

[func]
to_utf8 ( sequence string )

Returns a sequence with the specified string in UTF8 encoding.

See also from_utf8()

Miscellaneous Routines

[proc]
wxMain ( atom topWindow )

This starts the event loop and your main application.

Miscellaneous Routines

[proc]
wx_execute ( sequence command, integer flag )

flag can be a combination of:

• wxEXEC_ASYNC: execute the process asynchronously
• wxEXEC_SYNC: execute it synchronously, i.e. wait until it finishes
• wxEXEC_NOHIDE: under Windows, don't hide the child even if it's IO is redirected (this is done by default)
• wxEXEC_MAKE_GROUP_LEADER: under Unix, if the process is the group leader then killing -pid kills all children as well as pid

Miscellaneous Routines

[func]
wx_or_all ( sequence a )

Executes a bitwise or operation on a sequence of atoms. Use this to convert from a C/C++ style.

Example:

    THING1|THING2|THING3

    wx_or_all( THING1 & THING2 & THING3 )

Miscellaneous Routines

[proc]
wx_shell ( sequence command )

Executes a command in the default shell

Miscellaneous Routines

[func]
w_sprintf ( sequence format, object values )

A unicode replacement for the builtin sprintf().