Introduction

wxFlexGridSizer

include file: wxSizer.e

Creation parameters:

rows
cols
vgap [=0]
hgap [=0]

A flex grid sizer is a sizer which lays out its children in a two-dimensional table with all table fields in one row having the same height and all fields in one column having the same width, but all rows or all columns are not necessarily the same height or width as in the wxGridSizer.

Supertopics:

wxFont

include file: wxGraphics.e

Creation parameters:

pointSize
family
style
weight
underline [=0]
faceName [=""]
encoding [=wxFONTENCODING_DEFAULT]
- wxFONTENCODING_SYSTEM = -1, / system default
- wxFONTENCODING_DEFAULT, / current default encoding
- wxFONTENCODING_ISO8859_1, / West European (Latin1)
- wxFONTENCODING_ISO8859_2, / Central and East European (Latin2)
- wxFONTENCODING_ISO8859_3, / Esperanto (Latin3)
- wxFONTENCODING_ISO8859_4, / Baltic (old) (Latin4)
- wxFONTENCODING_ISO8859_5, / Cyrillic
- wxFONTENCODING_ISO8859_6, / Arabic
- wxFONTENCODING_ISO8859_7, / Greek
- wxFONTENCODING_ISO8859_8, / Hebrew
- wxFONTENCODING_ISO8859_9, / Turkish (Latin5)
- wxFONTENCODING_ISO8859_10, / Variation of Latin4 (Latin6)
- wxFONTENCODING_ISO8859_11, / Thai
- wxFONTENCODING_ISO8859_12, / doesn't exist currently, but put it
- wxFONTENCODING_ISO8859_13, / Baltic (Latin7)
- wxFONTENCODING_ISO8859_14, / Latin8
- wxFONTENCODING_ISO8859_15, / Latin9 (a.k.a. Latin0, includes euro)
- wxFONTENCODING_ISO8859_MAX,
- wxFONTENCODING_KOI8, / we don't support any of KOI8 variants
- wxFONTENCODING_ALTERNATIVE, / same as MS-DOS CP866
- wxFONTENCODING_BULGARIAN, / used under Linux in Bulgaria
- wxFONTENCODING_CP437, / original MS-DOS codepage
- wxFONTENCODING_CP850, / CP437 merged with Latin1
- wxFONTENCODING_CP852, / CP437 merged with Latin2
- wxFONTENCODING_CP855, / another cyrillic encoding
- wxFONTENCODING_CP866, / and another one
- wxFONTENCODING_CP874, / WinThai
- wxFONTENCODING_CP932, / Japanese (shift-JIS)
- wxFONTENCODING_CP936, / Chinese simplified (GB)
- wxFONTENCODING_CP949, / Korean (Hangul charset)
- wxFONTENCODING_CP950, / Chinese (traditional - Big5)
- wxFONTENCODING_CP1250, / WinLatin2
- wxFONTENCODING_CP1251, / WinCyrillic
- wxFONTENCODING_CP1252, / WinLatin1
- wxFONTENCODING_CP1253, / WinGreek (8859-7)
- wxFONTENCODING_CP1254, / WinTurkish
- wxFONTENCODING_CP1255, / WinHebrew
- wxFONTENCODING_CP1256, / WinArabic
- wxFONTENCODING_CP1257, / WinBaltic (same as Latin 7)
- wxFONTENCODING_CP12_MAX,
- wxFONTENCODING_UTF7, / UTF-7 Unicode encoding
- wxFONTENCODING_UTF8, / UTF-8 Unicode encoding
- wxFONTENCODING_GB2312 = wxFONTENCODING_CP936, / Simplified Chinese
- wxFONTENCODING_BIG5 = wxFONTENCODING_CP950, / Traditional Chinese
- wxFONTENCODING_SHIFT_JIS = wxFONTENCODING_CP932, / Shift JIS
- wxFONTENCODING_EUC_JP = wxFONTENCODING_UTF8 + 1, / Extended Unix Codepage for Japanese
- wxFONTENCODING_UNICODE, / Unicode - currently used only by

func get_font_encoding( atom font )

func get_font_family( atom font )

func get_font_members( atom font )

func get_font_name( atom font )

func get_font_pointsize( atom font )

func get_font_style( atom font )

func get_font_underlined( atom font )

func get_font_weight( atom font )

proc set_point_size( atom font, integer points )

Supertopics:

Graphics

Subtopics:

wxFontEnumerator

wxFontData

include file: wxDialog.e

Creation parameters:

font This parameter is optional. If a font is passed, set_initial_font() is called for you automatically. If not, you need to call it manually.

func get_chosen_font( atom fdata )

proc set_initial_font( atom fdata, atom font )

Supertopics:

Fonts

wxFontDialog

include file: wxDialog.e

Creation parameters:

parent
initialFontData (a wxFontData object)

func get_font_data( atom dialog )

Supertopics:

Fonts

Subtopics:

wxFontData

wxFontEnumerator

include file: wxGraphics.e

Creation parameters: NONE

wxFontEnumerator enumerates either all available fonts on the system or only the ones with given attributes - either only fixed-width (suited for use in programs such as terminal emulators and the like) or the fonts available in the given encoding.

The routines for wxFontEnumerator create and destroy an enumeration object automatically, so there is no need to create your own.

func get_encodings( sequence fontname )

func get_facenames( sequence params )

Supertopics:

wxFont

wxFrame

include file: wxEuphoria

wxFrame is a class derived from wxWindow. You must use a wxFrame as your top level window. The parameters for creating a wxFrame are:

atom parent
atom id
sequence title
integer x [ = -1]
integer y [ = -1]
integer cx [ = -1]
integer cy [ = -1]
atom style [ = wxDEFAULT_FRAME_STYLE]
- wxSTAY_ON_TOP
- wxICONIZE
- wxMINIMIZE
- wxMAXIMIZE
- wxSYSTEM_MENU
- wxMINIMIZE_BOX
- wxMAXIMIZE_BOX
- wxTINY_CAPTION_HORIZ
- wxTINY_CAPTION_VERT
- wxRESIZE_BORDER
- wxDIALOG_NO_PARENT Don't make owned by apps top window
- wxFRAME_NO_TASKBAR No taskbar button (MSW only)
- wxFRAME_TOOL_WINDOW No taskbar button, no system menu
- wxFRAME_FLOAT_ON_PARENT Always above its parent
- wxFRAME_SHAPED Create a window that is able to be shaped

All items with a default value are optional, although you must supply both x and y, or both cx and cy if you supply either one.

ex:
  constant myFrame = create( wxFrame, {0,         -- has no parent
                                      -1,         -- wxWidgets will create an id
                                      "myFrame",  -- will be dispayed as the caption
                                      -1,         -- start at default x position
                                      -1,         -- start at default y position
                                      300,        -- 300 wide
                                      200})       -- 200 tall
                                                  -- no style supplied means will be default style

If there is only one child of a frame, that child will be automatically resized (by wxWidgets) to the client rect of the frame.

proc raise_window( atom window )

proc set_icon( atom frame, atom icon )

proc show_fullscreen( atom frame, integer show, integer flags )

proc show_window( atom window, integer show )

Supertopics:

wxWindow

Subtopics:

wxCursor

wxMDIParentFrame

wxStatusBar

wxFTP

include file: wxNet.e

Creation parameters: None

func ftp_chdir( atom ftp, sequence path )

proc ftp_close( atom ftp )

func ftp_input_stream( atom ftp, sequence path )

func ftp_mkdir( atom ftp, sequence path )

proc ftp_mode( atom ftp, integer mode )

func ftp_output_stream( atom ftp, sequence path )

proc ftp_pwd( atom ftp, sequence pwd )

proc ftp_pwd( atom ftp )

func ftp_rename( atom ftp, sequence source, sequence dest )

func ftp_rm( atom ftp, sequence path )

func ftp_rmdir( atom ftp, sequence path )

proc ftp_user( atom ftp, sequence user )

Supertopics:

wxGrid

include file: wxGrid

This is a grid control that can be used to display tabular data. It also allows editing in place by users, similar to a spreadsheet.

Creation parameters:

atom parent
atom id [=-1]
integer x [=-1]
integer y [=-1]
integer cx [=-1]
integer cy [=-1]
integer style [=0]
integer rows [=WXGRID_DEFAULT_NUMBER_ROWS]
integer COLS [=WXGRID_DEFAULT_NUMBER_colS]

It is important to remember that all wxGrid functions and procedures use zero-based references to all cells (0, 1, 2,...)

proc append_cols( atom grid, integer cols )

proc append_rows( atom grid, integer rows )

proc autosize_columns( atom grid )

func batch_count( atom grid )

proc begin_batch( atom grid )

proc clear_grid( atom grid )

proc delete_cols( atom grid, integer pos, integer n, integer relabel )

proc delete_rows( atom grid, integer pos, integer n, integer relabel )

proc end_batch( atom grid )

proc force_refresh_grid( atom grid )

func get_cell_editor( atom grid, sequence cell )

func get_cell_editor_control( atom grid, object editor )

func get_cell_value( atom grid, integer row, integer col )

func get_col_label( atom grid, integer col )

func get_col_label_size( atom grid )

func get_row_label_size( atom grid )

func grid_event_cell( atom event )

func grid_pos( atom grid )

func grid_size( atom grid )

proc make_cell_visible( atom grid, atom row, atom col )

proc select_grid_cell( atom grid, atom row, atom col )

proc set_cell( atom grid, atom row, atom col )

proc set_cell_alignment( atom grid, atom row, atom col, atom horz, atom vert )

proc set_cell_editor( atom grid, atom row, atom col, integer ed_type, object data )

proc set_cell_readonly( atom grid, atom row, atom col, integer readonly )

proc set_cell_value( atom grid, object val, integer row, integer col )

proc set_col_alignment( atom grid, atom col, atom horz, atom vert )

proc set_col_editor( atom grid, atom col, integer ed_type, object data )

proc set_col_label( atom grid, integer col, sequence text )

proc set_col_label_align( atom grid, atom horiz, atom vert )

proc set_col_label_size( atom grid, integer height )

proc set_col_readonly( atom grid, atom col, integer readonly )

func set_col_size( atom grid, atom col, atom size )

proc set_default_grid_editor( atom grid, atom editor )

proc set_editor_choices( atom grid, object cell, sequence choices )

proc set_grid_editable( atom grid, integer editable )

proc set_grid_line_color( atom grid, atom colour )

proc set_grid_size( atom grid, atom rows, atom cols )

proc set_row_label( atom grid, integer row, sequence text )

proc set_row_label_align( atom grid, atom horiz, atom vert )

proc set_row_label_size( atom grid, integer height )

Supertopics:

Controls

Subtopics:

wxGridCellAttr

wxGridCellEditor

wxGridCellAttr

include file: wxGrid.e

Creation parameters (two options):

None: create a new wxGridCellAttr
Sequence: get or create a wxGridCellAttr for a specific cell
- grid
- row
- column

Supertopics:

wxClasses

wxGrid

Subtopics:

wxGridCellEditor

include file: wxGrid.e

You shouldn't create an object of this class directly. Instead, use the set_col_editor or set_cell_editor procedures.

Supertopics:

wxGrid

wxGridCellAttr

wxGridSizer

include file: wxSizer

Creation parameters:

integer columns
integer rows
integer vgap
integer hgap

rows and columns determine the number of columns and rows in the sizer - if either of the parameters is zero, it will be calculated to form the total number of children in the sizer, thus making the sizer grow dynamically. vgap and hgap define extra space between all children.

Supertopics:

wxHtmlWindow

include file: wxHtml.e

Note that this file also includes wxFile.e and wxGraphics.e.

Creation parameters:

parent
id [=-1]
x [=-1]
y [=-1]
cx [=-1]
cy [=-1]
style [=wxHW_SCROLLBAR_AUTO]
- wxHW_SCROLLBAR_NEVER
- wxHW_SCROLLBAR_AUTO

This class can be used to display HTML documents. It does not always handle badly formed html very well. Make sure that any lists are surrounded by <ul> </ul> or <ol> </ol> tags.

func get_html_anchor( atom html_win )

func get_html_page( atom html_win )

proc get_html_page_title( atom html_win )

proc html_append( atom htmlwin, sequence source)

proc html_back( atom htmlwin )

proc html_forward( atom htmlwin )

proc load_html_file( atom htmlwin, sequence file)

proc load_html_page( atom htmlwin, sequence page )

proc set_html_page( atom htmlwin, sequence source )

proc set_link_event( atom html_win, integer rid )

proc set_open_url_event( atom html_win, integer rid )

proc set_related_frame( atom html_win, atom frame, sequence format )

Supertopics:

wxHTTP

include file: wxNet.e

Creation parameters:

URL [=""]

I haven't figured out how to make this class work yet. Use wxURL instead.

func get_http_input( atom http )

Supertopics:

wxIcon

include file: wxGraphics.e

Creation parameters:

sequence file_name
atom type (see wxBitmap)
atom desired_height [=-1]
atom desired_width [=-1]

This is a true Icon under Windows, but is really just a wxBitmap under Linux.

Supertopics:

wxImageList

include file: wxGraphics.e

Creation Parameters:

width Width of the images in the list
height Height of the images in the list
mask [=1] TRUE if masks should be created for all images
initial_count [=1] The initial size of the list

func add_image( atom ilist, atom image, object mask )

Supertopics:

wxIPV4address

include file: wxNet.e

Creation parameters: none

proc any_address( atom addr )

func set_ip_host( atom ip, sequence name )

func set_ip_service( atom ip, object service )

Supertopics:

wxListBox

include file: wxList

Creation parameters:

atom parent
integer id [=-1]
integer x [=-1]
integer y [=-1]
integer cx [=-1]
integer cy [=-1]
sequence choices [={}]
atom style [=0]

proc clear_list( atom list )

proc delete_list_item( atom list, object item )

func find_list_string( atom list, sequence string )

func list_count( atom list )

proc list_ensure_visible( atom list, integer item )

proc set_first_list_item( atom list, object item )

proc set_list_selection( atom list, object select )

Supertopics:

wxControlWithItems

wxListCtrl

include file: wxList.e

Creation parameters:

parent
id [=-1]
x [=-1]
y [=-1]
cx [=-1]
cy [=-1]
style [= wxLC_REPORT]
- wxLC_VRULES = #0001
- wxLC_HRULES = #0002
- wxLC_ICON = #0004
- wxLC_SMALL_ICON = #0008
- wxLC_LIST = #0010
- wxLC_REPORT = #0020
- wxLC_ALIGN_TOP = #0040
- wxLC_ALIGN_LEFT = #0080
- wxLC_AUTOARRANGE = #0100
- wxLC_VIRTUAL = #0200
- wxLC_EDIT_LABELS = #0400
- wxLC_NO_HEADER = #0800
- wxLC_NO_SORT_HEADER = #1000
- wxLC_SINGLE_SEL = #2000
- wxLC_SORT_ASCENDING = #4000
- wxLC_SORT_DESCENDING = #8000
- wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
- wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
- wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)

func insert_listctrl_item( atom list, atom index, sequence text, integer image )

func insert_list_column( atom list, atom col, sequence text, integer format, integer width )

proc list_imagelist( atom list, atom il, integer which )

proc set_column_label( atom list, integer column, sequence text )

proc set_list_item_back_color( atom list, atom item, atom color )

proc set_list_item_image( atom list, integer item, integer image )

Supertopics:

wxControlWithItems

wxMask

include file wxGraphics.e

Creation parameters:

wxBitmap mask: a single color image that specifies the mask
wxColour color: the color that specified the transparent areas of the mask

Supertopics:

wxBitmap

wxClasses

wxGraphics

wxMDIChildFrame

include file: wxMDI.e

Creation parameters:

atom parent
atom id
sequence title
integer x [ = -1]
integer y [ = -1]
integer cx [ = -1]
integer cy [ = -1]
atom style [ = wxDEFAULT_FRAME_STYLE]
- wxSTAY_ON_TOP
- wxICONIZE
- wxMINIMIZE
- wxMAXIMIZE
- wxSYSTEM_MENU
- wxMINIMIZE_BOX
- wxMAXIMIZE_BOX
- wxTINY_CAPTION_HORIZ
- wxTINY_CAPTION_VERT
- wxRESIZE_BORDER
- wxDIALOG_NO_PARENT Don't make owned by apps top window
- wxFRAME_NO_TASKBAR No taskbar button (MSW only)
- wxFRAME_TOOL_WINDOW No taskbar button, no system menu
- wxFRAME_FLOAT_ON_PARENT Always above its parent
- wxFRAME_SHAPED Create a window that is able to be shaped

You should create a wxMenuBar for the frame in order for everything to work properly. When the wxMenuBar is created, a Window menu will be created automatically.

proc activate_child( atom child )

proc maximize_child( atom child, integer bool )

proc restore_child( atom child )

Supertopics:

wxMDIParentFrame

wxMDIClientWindow

include file: wxMDI.e

Creation parameters:

parent
style [=0]

Supertopics:

wxMDIParentFrame

include file: wxMDI.e

An MDI (Multiple Document Interface) parent frame is a window which can contain MDI child frames in its own 'desktop'. It is a convenient way to avoid window clutter, and is used in many popular Windows applications, such as Microsoft Word(TM).

There may be multiple MDI parent frames in a single application, but this probably only makes sense within programming development environments.

Child frames may be of class wxMDIChildFrame (contained within the parent frame) or wxFrame (shown as a top-level frame).

An MDI parent frame always has a wxMDIClientWindow associated with it, which is the parent for MDI client frames. This client window may be resized to accommodate non-MDI windows, as seen in Microsoft Visual C++ (TM) and Microsoft Publisher (TM), where a documentation window is placed to one side of the workspace.

MDI remains popular despite dire warnings from Microsoft itself that MDI is an obsolete user interface style.

The implementation is native in Windows, and simulated under Motif. Under Motif, the child window frames will often have a different appearance from other frames because the window decorations are simulated.

Creation parameters:

atom parent
atom id
sequence title
integer x [ = -1]
integer y [ = -1]
integer cx [ = -1]
integer cy [ = -1]
atom style [ = wxDEFAULT_FRAME_STYLE]
- wxSTAY_ON_TOP
- wxICONIZE
- wxMINIMIZE
- wxMAXIMIZE
- wxSYSTEM_MENU
- wxMINIMIZE_BOX
- wxMAXIMIZE_BOX
- wxTINY_CAPTION_HORIZ
- wxTINY_CAPTION_VERT
- wxRESIZE_BORDER
- wxDIALOG_NO_PARENT Don't make owned by apps top window
- wxFRAME_NO_TASKBAR No taskbar button (MSW only)
- wxFRAME_TOOL_WINDOW No taskbar button, no system menu
- wxFRAME_FLOAT_ON_PARENT Always above its parent
- wxFRAME_SHAPED Create a window that is able to be shaped

proc arrange_mdi_icons( atom parent )

proc cascade_mdi( atom parent )

proc tile_mdi( atom parent ) Simplistic Routines to manage memory

Supertopics:

wxFrame

Subtopics:

wxMDIChildFrame

wxMDIClientWindow

wxMemoryDC

include file: wxGraphics.e

wxMemoryDCs are used to draw to wxBitmap 's in memory. When creating, you may specify zero or one parameters. The parameter must be a pointer to a wxBitmap. After creation, the specified bitmap will be selected into the wxMemoryDC.

You must either delete the wxMemoryDC or call select_object( wxNullBitmap ) before selecting the bitmap into another wxMemoryDC.

proc select_object( atom dc, atom obj )

Supertopics:

wxMenu

include file: wxMenu

A menu is the top level menu item, such as "File".

Creation parameters:

To add a menu to a wxMenuBar
- parent: wxMenus must have a wxMenuBar parent
- text: text of the menu
- style [= 0]
- index: If omitted, the menu is appended to the existing menus, or a zero-based index where the menu should be inserted
To create a popup- or sub-menu
- parent: must be 0

To create a submenu, first create a wxMenu object with no parent, then create a new wxMenuItem with the menu as the subMenu parameter.

Supertopics:

Menus

wxMenuBar

include file: wxMenu

wxMenuBars must have a wxFrame parent. The only parameter to create a wxMenuBar is the pointer to a wxFrame.

Supertopics:

Menus

wxMenuItem

include file: wxMenu

wxMenuItems must have a wxMenu parent.

Parameters for creating a new menuitem:

atom parentMenu
integer id
text
helpString [ = ""]
integer checkable [ = 0]
atom subMenu [ = 0]

To create a submenu, you first need to create a wxMenu with no parent, and pass the result in the subMenu parameter.

To set up event handlers for menus, use the wxEVT_COMMAND_MENU_SELECTED event type. Also, you should use the main frame, or some other control that is derived from wxWindow or wxEvtHandler, since the menu classes do not have their own event handlers. Under Linux, it is also required that you pass both the object which will act as the wxEvtHandler, and the parent menu of the wxMenuItem (Windows will work without this, but it's recommended that you always pass both the wxEvtHandler and the wxMenu for cross platform compatibility).

ex:

procedure on_open_menu( atom this, atom event ) -- do stuff end procedure

-- if you used a specific wxID_ constant when you created the wxMenuItem, you could -- use that instead of get_menuitem_id: wxID_OPEN, wxID_NEW, etc

set_event_handler( {main, the_open_menu_parent}, get_menuitem_id( the_open_menu ), wxEVT_COMMAND_MENU_SELECTED, routine_id("on_open_menu"))

Supertopics:

Menus

wxNotebook

include file: wxNotebook

This class represents a notebook control, which manages multiple windows with associated tabs.

To use the class, create a wxNotebook object and call add_page, passing a window to be used as the page.

Creation parameters:

parent
id
x [=-1]
y [=-1]
cx [=-1]
cy [=-1]
style [=0]
- wxNB_FIXEDWIDTH (Windows only)All tabs will have same width.
- wxNB_LEFT Place tabs on the left side.
- wxNB_RIGHT Place tabs on the right side.
- wxNB_BOTTOM Place tabs under instead of above the notebook pages.

Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN window style.

proc add_page( atom book, atom page, sequence text, integer select, atom image )

proc notebook_imagelist( atom book, atom ilist )

proc set_page_text( atom book, integer page, sequence text )

proc show_page( atom book, integer page )

Supertopics:

Controls

Subtopics:

wxNotebookSizer

include file: wxSizer

Creation parameters:

notebook: Associated notebook.

wxNotebookSizer is a specialized sizer to make sizers work in connection with using notebooks. This sizer is different from any other sizer as you must not add any children to it - instead, it queries the notebook class itself. The only thing this sizer does is to determine the size of the biggest page of the notebook and report an adjusted minimal size to a more toplevel sizer.

In order to query the size of notebook page, this page needs to have its own sizer, otherwise the wxNotebookSizer will ignore it.

Supertopics:

wxNotebook

wxPageSetupDialog

include file: wxDialog.e

Creation parameters:

parent [= 0]
wxPageSetupDialogData [= 0]

func get_pagesetup_data( atom ps )

Supertopics:

Printing

Subtopics:

wxPageSetupDialogData

Supertopics:

wxPageSetupDialog

wxPaintDC

include file: wxGraphics.e

Creation parameters:

window the window that is being painted

Device context that is used to draw to a window during a paint event. It should be destroyed before you exit the paint handler.

Supertopics:

wxPanel

include file: wxEuphoria

If you create a wxFrame, you should create a wxPanel to be the child of the main frame, and place all controls into the panel (except for menus and wxStatusBar 's). The only creation parameter required is a parent. The panel will automatically grow or shrink whenever its parent does, and automatically handles tabbing between controls.

proc set_default_item( atom panel, atom button )

Supertopics:

wxWindow

wxPen

include file: wxGraphics.e

Creation parameters:

color
width
style
- wxSOLID
- wxDOT
- wxLONG_DASH
- wxSHORT_DASH
- wxDOT_DASH
- wxUSER_DASH
- wxTRANSPARENT

Supertopics:

wxPoint

include file: wxEuphoria

A wxPoint is actually just an 8-byte location in memory with two 4-byte integers stored there, corresponding to the x,y coordinates of the point. It is possible to specify the place in memory where you want to have the point created. A call to create() will simply poke the values for you, so it may be easier to do this yourself. To specify the place in memory, the pointer should be the third parameter passed.

ex:
  atom point1, point_array, void

  --creates a point with x=3, y=4
  point = create( wxPoint, {3,4})

  -- allocates space for an array of 2 wxPoints
  point_array = allocate(8 * 2)

  -- create the points in place
  void = create( wxPoint, {3,4,point_array})
  void = create( wxPoint, {5,6,point_array + sizeof_wxPoint})

Supertopics:

wxPrintDialog

include file: wxDialog.e

Creation parameters:

parent [= 0]
/wxPageSetupData [= 0]

func get_print_data( atom prdlg )

Supertopics:

wxPrinter

include file: wxPrint.e

Creation parameters:

data a wxPrintDialogData object

func start_print( atom printer, atom parent atom printout, atom prompt )

Supertopics:

wxPrintout

include file: wxPrint.e

Creation parameters:

title
printpage_rid This parameter is the routine_id for a function that will be called when a page needs to be printed. The function should take three arguments: this, page_num and dc. You should draw the page into the supplied dc. If you want to cancel the job return a value of zero. Otherwise, you should return a value of 1.
print_prepare_rid This parameter is the routine_id for a procedure that will be called when a page needs to be printed. It should take two arguments, a wxPrintout object and a DC. You can use this routine to determine the number of pages required, if you need the DC in order to do so. You should then call set_page_info() so that the correct number of pages will be used. If you don't need this, you can set this parameter to -1, which is the default value.
page_range [= {1,1}]

func get_page_mm( atom printout )

func get_page_pixels( atom printout )

func get_ppi_printer( atom printout )

func get_ppi_screen( atom printout )

func get_printout_dc( atom printout )

func is_preview( atom printout )

proc set_page_info( atom printout, atom min, atom max )

Supertopics:

wxPrintPreview

include file: wxPrint.e

Creation parameters:

wxPrintout
wxPrintout If this is non-null, then a Print... button will be placed on the preview frame so that the user can print directly from the preview interface
wxPreviewFrame [if not supplied, one will be created, which can be accessed through get_preview_frame]

Previewing is started by showing the preview frame.

Properly scaling the print preview is fairly simple. There are three pieces of data that are required:

get_dc_size()
get_page_pixels()
get_ppi_printer()

You can get the scaling factor required by dividing the results of get_dc_size() by get_page_pixels(). Pass the result to set_user_scale(). Now, you can use coordinates in inches multiplied by the printer ppi (relative to the margins):

    procedure onPrintPage( atom this, atom page, atom dc )
        sequence ppi, factor

        ppi = get_ppi_printer( this )
        if is_preview( this ) then
            factor = get_dc_size( dc ) / get_page_pixels( this )
            set_user_scale( dc, factor[1], factor[2] )
        else
            set_user_scale( dc, 1, 1)
        end if

        -- print "Hello World" at 1", 1"
        wx_puts( 0 & ppi * {1,1} & dc, "Hello World" )
    end procedure

func get_preview_frame( atom preview )

func get_zoom( atom preview )

proc set_preview_frame( atom preview, atom frame )

Supertopics:

wxProgressDialog

include file: wxDialog.e

Creation parameters:

title
message
maximum [= 100]
parent [= NULL]
style [= wxPD_AUTO_HIDE | wxPD_APP_MODAL]

proc progress_resume( atom dialog )

func progress_update( atom dialog, integer val, sequence message )

Supertopics:

wxRadioBox

include file: wxCheckBox

A radio box item is used to select one of number of mutually exclusive choices. It is displayed as a vertical column or horizontal row of labelled buttons.

Creation parameters:

atom parent
integer id
sequence label
integer x [=-1]
integer y [=-1]
integer cx [=-1]
integer cy [=-1]
sequence choices [={}]
integer majorDimension [=0] Specifies the maximum number of rows (if style contains wxRA_SPECIFY_ROWS) or columns (if style contains wxRA_SPECIFY_COLS) for a two-dimensional radiobox.
atom style wxRA_SPECIFY_COLS
- wxRA_SPECIFY_ROWS The major dimension parameter refers to the maximum number of rows.
- wxRA_SPECIFY_COLS The major dimension parameter refers to the maximum number of columns.

func get_radio_selection( atom this )

proc set_radiobox_selection( atom box, integer selection ) A list of controls available in wxWidgets

Supertopics:

wxRadioButton

include file: wxCheckBox.ew

Creation parameters:

parent
id
label
x [=-1]
y [=-1]
cx [=-1]
cy [=-1]
style [=0]

Supertopics:

Controls

Subtopics:

wxRadioBox

wxScrollBar

include file: wxScrollBar

Creation parameters:

atom parent
integer id
integer x [=-1]
integer y [=-1]
integer cx [=-1]
integer cy [=-1]
atom style [=0]
- wxSB_HORIZONTAL
- wxSB_VERTICAL

func get_scroll_position( atom scroll )

proc set_scrollbar( atom scroll, atom position, atom thumbSize, atom range, atom pageSize, atom refresh )

proc set_scroll_position( atom scroll, atom pos )

Supertopics:

Classes

Subtopics:

wxSlider

wxSize

include file: wxEuphoria

Supertopics:

wxSlider

include file: wxScrollBar.e

Creation parameters

parent
id
initial_value
minValue
maxValue
x [= -1]
y [= -1]
cx [= -1]
cy [= -1]
style [= wxSL_HORIZONTAL]
- wxSL_HORIZONTAL = wxHORIZONTAL, -- 4
- wxSL_VERTICAL = wxVERTICAL, -- 8
- wxSL_TICKS = #0010,
- wxSL_AUTOTICKS = wxSL_TICKS,
- wxSL_LABELS = #0020,
- wxSL_LEFT = #0040,
- wxSL_TOP = #0080,
- wxSL_RIGHT = #0100,
- wxSL_BOTTOM = #0200,
- wxSL_BOTH = #0400,
- wxSL_SELRANGE = #0800

func get_slide_value( atom slider )

proc set_slide_value( atom slider, atom val )

Supertopics:

wxScrollBar

wxSocketClient

include file wxSocket.e

Creation parameters:

flags
- wxSOCKET_NONE Normal functionality.
- wxSOCKET_NOWAIT Read/write as much data as possible and return immediately.
- wxSOCKET_WAITALL Wait for all required data to be read/written unless an error occurs.
- wxSOCKET_BLOCK Block the GUI (do not yield) while reading/writing data.

func socket_connect( atom client, atom address, integer wait )

Supertopics:

wxSocketServer

include file wxSocket.e

Creation parameters:

wxIPV4address
flags [=wxSOCKET_NONE]
- wxSOCKET_NONE Normal functionality.
- wxSOCKET_NOWAIT Read/write as much data as possible and return immediately.
- wxSOCKET_WAITALL Wait for all required data to be read/written unless an error occurs.
- wxSOCKET_BLOCK Block the GUI (do not yield) while reading/writing data.

In order to receive data through sockets, you first need to create a wxSocketServer object to wait for new connections. Then, in an event handler, you need to create a new wxSocketServer object that will handle the connection, and set up an event handler for that socket, as well. Alternatively, you could call socket_accept() with wait = 1, although this will not return until a connection has been made.

 ex:
     server = create( wxSocketServer, address )
     server_id = get_id( server )
     set_socket_notify( server, {wxSOCKET_CONNECTION_FLAG, wxSOCKET_LOST_FLAG})
     socket_event_handler( server, main_form, server_id )

     procedure main_socket_event( atom this, atom event_type, atom id, atom event )
         sequence bytes
         atom socket

         event_type = get_socket_event( event )

         if id = server_id and event_type = wxSOCKET_CONNECTION then
             connection = socket_accept( server, 0 )
             connection_id = get_id( connection )
             set_socket_notify( connection, {wxSOCKET_INPUT_FLAG, wxSOCKET_LOST_FLAG})
             socket_event_handler( connection_id, main_form, connection_id )
             set_event_handler( main_form, connection_id, wxEVT_SOCKET, routine_id("main_socket_event"))

         elsif event_type = wxSOCKET_LOST then
             delete_instance( socket_from_event( event ) )

         elsif event_type = wxSOCKE_INPUT then
             bytes = socket_read( socket_from_event( event ) )

         end if
     end procedure
     set_event_handler( main_form, server_id, wxEVT_SOCKET, routine_id("main_socket_event")

func socket_accept( atom socket, integer wait )

Supertopics:

wxSpinCtrl

include file: wxText.e

Creation parameters:

parent,
id
text
x [= -1]
y [= -1]
cx [= -1]
cy [= -1]
style [= wxSP_ARROW_KEYS]
- wxSP_HORIZONTAL = wxHORIZONTAL, -- 4
- wxSP_VERTICAL = wxVERTICAL, -- 8
- wxSP_ARROW_KEYS = #1000,
- wxSP_WRAP = #2000
min [= 0]
max [= 100]
initial [= 0]

func get_spin_value( atom spin )

proc set_spin_value( atom spin, atom val )

Supertopics:

wxSplashScreen

include file: wxSplashScreen.e

Creation parameters:

bitmap
splashStyle
- wxSPLASH_CENTRE_ON_PARENT
- wxSPLASH_CENTRE_ON_SCREEN
- wxSPLASH_NO_CENTRE
- wxSPLASH_TIMEOUT
- wxSPLASH_NO_TIMEOUT
milliseconds
parent
id [= -1]
x [= -1]
y [= -1]
cx [= -1]
cy [= -1]
style [= wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP]'

Supertopics:

wxSplitterWindow

include file: wxSizer.e

Creation parameters:

atom parent
atom id [ = -1]
integer x [ = -1]
integer y [ = -1]
integer cx [ = -1]
integer cy [ = -1]
atom style [ = wxSP_BORDER + wxSP_FULLSASH ]

func get_splitter_sash_position( atom split )

proc set_min_pane_size( atom split, integer size )

proc set_splitter_sash_position( atom split, integer pos, integer redraw )

proc split_window( atom split, atom win1, atom win2, integer orient, integer pos )

Supertopics:

wxStaticBoxSizer

include file: wxSizer.e

Creation parameters:

wxStaticBox
orientation (wxVERTICAL, wxHORIZONTAL)

wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static box around the sizer. Note that this static box has to be created separately.

Supertopics:

wxStaticText

include file: wxText

This control is used for creating a static label. The text in the label will be automatically refreshed (as opposed to using wx_puts).

Creation parameters:

atom parent
integer id
sequence text
integer x [= -1]
integer y [= -1]
integer cx [= -1]
integer cy [= -1]
atom style [=wxST_NO_AUTORESIZE]
- wxALIGN_LEFT
- wxALIGN_RIGHT
- wxALIGN_CENTRE
- wxST_NO_AUTORESIZE: By default, the control will adjust its size to exactly fit to the size of the text when SetLabel is called. If this style flag is given, the control will not change its size (this style is especially useful with controls which also have wxALIGN_RIGHT or CENTER style because otherwise they won't make sense any longer after a call to SetLabel)

proc set_label( atom label, sequence text )

Supertopics:

wxStatusBar

include file: wxStatusBar

The status bar should be a child of a wxFrame. Creation parameters:

atom parent
atom fields
atom style [= 0]

proc set_status_fields( atom bar, sequence widths )

proc set_status_text( atom bar, sequence text, integer field )

Supertopics:

wxFrame

wxString

include file: wxEuphoria

The format for strings that wxWidgets uses. The parameter to create should be a string.

ex:
  atom myString
  myString = create( wxString, {"Hello World"})

I wrote my own destructor for wxString objects, which you may call directly to save some time: delete_string().

proc delete_string( atom string )

proc deref_string( atom string )

Supertopics:

wxTextAttr

func get_text_attr_back_color( atom attr )

func get_text_attr_color( atom attr )

func get_text_attr_font( atom attr )

proc set_text_attr_back_color( atom attr, atom color )

proc set_text_attr_color( atom attr, atom color )

proc set_text_attr_font( atom attr, atom font )

Supertopics:

wxTextCtrl

include file: wxText.e

Creation parameters:

atom parent
integer id
sequence text
integer x
integer y
integer cx
integer cy
atom style
- wxTE_PROCESS_ENTER The control will generate the message wxEVENT_TYPE_TEXT_ENTER_COMMAND (otherwise pressing is either processed internally by the control or used for navigation between dialog controls).
- wxTE_PROCESS_TAB The control will receive EVT_CHAR messages for TAB pressed - normally, TAB is used for passing to the next control in a dialog instead. For the control created with this style, you can still use Ctrl-Enter to pass to the next control from the keyboard.
- wxTE_MULTILINE The text control allows multiple lines.
- wxTE_PASSWORD The text will be echoed as asterisks.
- wxTE_READONLY The text will not be user-editable.
- wxTE_RICH Use rich text control under Win32, this allows to have more than 64Kb of text in the control even under Win9x. This style is ignored under other platforms.
- wxTE_RICH2 Use rich text control version 2.0 or 3.0 under Win32, this style is ignored under other platforms. You must use this style if you want to set the background color (see wxTextAttr).
- wxTE_AUTO_URL Highlight the URLs and generate the wxTextUrlEvents when mouse events occur over them. This style is supported under Win32 only and requires wxTE_RICH.
- wxTE_NOHIDESEL By default, the Windows text control doesn't show the selection when it doesn't have focus - use this style to force it to always show it. It doesn't do anything under other platforms.
- wxHSCROLL A horizontal scrollbar will be created. No effect under GTK+.
- wxTE_LEFT The text control will be left-justified (default).
- wxTE_CENTRE The text control will be centre-justified.
- wxTE_RIGHT The text control will be right-justified.
- wxTE_DONTWRAP Same as wxHSCROLL style.

Events associated with wxTextCtrl:

wxEVT_COMMAND_TEXT_UPDATED Generated when the text changes. Notice that this event will always be sent when the text controls contents changes - whether this is due to user input or comes from the program itself (for example, if set_text_value() is called)
wxEVT_COMMAND_TEXT_ENTER Generated when enter is pressed in a single-line text control.
wxEVT_TEXT_URL A mouse event occured over an URL in the text control (Win32 only)
wxEVT_TEXT_MAXLEN User tried to enter more text into the control than the limit set by SetMaxLength.

proc append_text( atom text, sequence val )

proc copy_text( atom text )

proc cut_text( atom text )

func get_text_length( atom text )

func get_text_number( atom textctrl )

func get_text_value( atom text )

proc paste_text( atom text )

proc select_all_text( atom text )

proc set_default_text_style( atom text, atom attr )

proc set_text( atom text, sequence val )

proc set_text_selection( atom text, atom first, atom last )

proc set_text_style( atom text, atom first, atom last, atom attr )

proc write_text( atom ctrl, sequence text )

Supertopics:

Controls

Subtopics:

wxTextAttr

wxTextDataObject

include file: wxData.e

The only creation parameter is a string. This is optional:

  ex:
    myTextDataObject = create( wxTextDataObject, {"some text"})

    myTextDataObject = create( wxTextDataObject, {})

Supertopics:

Clipboard

wxTimer

include file: wxTimer

Creation parameters:

parent
id [=-1]

The parent is important, as this is the only way to receive wxTimer events. To set a timer event handler, use wxEVT_TIMER:

ex:

constant
main = create( wxFrame, {0,-1,"Timer"}),
timer = create( wxTimer, {main})

procedure on_timer( atom this, atom event )
    puts(1,"Timer\n")
end procedure

-- NOTE: using the parent to identify the timer.
set_event_handler( main, -1, wxEVT_TIMER, routine_id("on_timer"))

-- set the timer to fire every 1 second, repeatedly
start_timer( timer, 1000, 0 )

wxMain( main )

proc start_timer( atom timer, atom msec, integer oneshot )

proc stop_timer( atom timer )

Supertopics:

Events

Timers

wxToggleButton

include file: wxCheckBox.e

Creation parameters:

parent
id
label
x [=-1]
y [=-1]
cx [=-1]
cy [=-1]
style [= 0]

Supertopics:

wxToolBar

include file: wxToolBar

Creation parameters:

parent
id
x [=-1]
y [=-1]
cx [=-1]
cx [=-1]
style [ = wxTB_HORIZONTAL | wxNO_BORDER ]

proc add_separator( atom bar )

func add_tool( atom bar, integer id, atom b1, atom b2, sequence label, sequence s1, sequence s2, integer kind )

proc set_tool_bitmap_size( atom bar, integer x, integer y )

proc set_tool_margins( atom toolbar, integer x, integer y )

proc show_toolbar( atom bar )

proc toggle_tool( atom bar, atom id, integer toggle )

Supertopics:

wxTreeCtrl

Creation parameters:

parent
id (optional) [= -1]
x (optional) [= -1]
y (optional) [= -1]
cx (optional) [= -1]
cy (optional) [= -1]
style (optional) [= wxTR_HAS_BUTTONS + wxTR_LINES_AT_ROOT ]
- wxTR_NO_BUTTONS = #0000, -- for convenience
- wxTR_HAS_BUTTONS = #0001, -- generates a +/- button
- wxTR_TWIST_BUTTONS = #0002, -- generates a twister button
- wxTR_NO_LINES = #0004, -- don't generate level connectors
- wxTR_LINES_AT_ROOT = #0008, -- connect top-level nodes
- wxTR_MAC_BUTTONS = wxTR_TWIST_BUTTONS, -- backward compatibility
- wxTR_AQUA_BUTTONS = #0010, -- used internally
- wxTR_SINGLE = #0000, -- for convenience
- wxTR_MULTIPLE = #0020, -- can select multiple items
- wxTR_EXTENDED = #0040, -- TODO: allow extended selection
- wxTR_FULL_ROW_HIGHLIGHT = #2000, -- highlight full horizontal space
- wxTR_EDIT_LABELS = #0200, -- can edit item labels
- wxTR_ROW_LINES = #0400, -- put border around items
- wxTR_HIDE_ROOT = #0800, -- don't display root node
- wxTR_HAS_VARIABLE_ROW_HEIGHT= #0080 -- what it says

When working with tree items, the id values returned are actually pointers to wxTreeItem pointers. They are not unique ids. The value returned is a new wxTreeItemId, which is a simple wxWidgets object. It is just a pointer to either a windows handle or a custom data pointer. It is the duty of the application to free the wxTreeItemId.

func add_tree_item( atom tree, atom parent, sequence text, atom image, atom selimage )

func add_tree_root( atom tree, sequence text, atom image, atom selimage )

proc delete_tree_children( atom tree, atom treeitem )

proc delete_tree_item( atom tree, object item )

proc expand_tree_item( atom tree, atom item )

func get_tree_parent( atom tree, atom item )

func get_tree_root( atom tree )

func get_tree_selected_text( atom tree )

func get_tree_selection( atom tree )

func get_tree_text( atom tree, atom id )

proc select_tree_item( atom tree, atom treeitem )

proc set_tree_item_text( atom tree, atom item, sequence text )

proc tree_imagelist( atom tree, atom il )

func valid_tree_item( atom item )

Supertopics:

Controls

Subtopics:

wxTreeEvent

include file: wxTree.e

This is the class of the event that is passed to an event handler for a wxTree type event.

func get_tree_event_item( atom event )

Supertopics:

Events

wxTreeCtrl

wxURL

include file: wxNet.e

Creation parameters:

func get_url_input( atom url )

Supertopics:

wxWindow

include file: wxEuphoria

wxWindow is a very well used class. Most controls are derived from wxWindow, so you should remember that anything that can be done to a window can be done to an object derived from wxWindow. The parameters for creating a wxWindow are:

atom parent
atom id
integer x [ = -1]
integer y [ = -1]
integer cx [ = -1]
integer cy [ = -1]
atom style [ = 0]

An object of class wxWindow must have a parent. Therefore, you cannot create an object of class wxWindow to be your top level window. Your top level window should be either of type wxFrame or wxDialog. In fact, you should probably rarely create an object using wxWindow. See wxPanel.

proc capture_mouse( atom window )

func get_client_size( atom this )

func get_id( atom this )

proc refresh_window( object params )

proc release_mouse( atom window )

proc set_back_color( atom window, atom color )

proc set_title( atom window, sequence title )

Supertopics:

Controls

Subtopics:

wxWizard

Creation parameters:

parent
id [=-1]
title [=""]
bitmap [=wxNullBitmap]
x [=-1]
y [=-1]

func wizard_event_direction( atom event )

func wizard_event_page( atom event )

Supertopics:

Controls

Subtopics:

wxWizardPage

Creation parameters:

parent
bitmap [=wxNullBitmap]
resource [=NULL]

A wxWizardPage is actually a panel that will be displayed in the wxWizard. You must call set_next_wizard_page() and set_prev_wizard_page() for each page to set the next and previous pages. The first and last pages will have previous and next pages of 0, respectively.

proc set_next_wizard_page( atom page, atom next )

proc set_prev_wizard_page( atom page, atom prev )

Supertopics: