Documentation for Win32lib v0.70.18
Table of Contents

Introduction

see also: General Info
------------------NOTICE-------------------------------*
 Software ID: win32lib
  Copyright:   (c) 2000-2009 David Cuny and friends
              All rights reserved.
 Licence:
 This software is provided 'as-is', without any express or implied warranty.
 In no event will the authors be held liable for any damages arising from
 the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. 2. If you use this software in a product, acknowedgement in the product's documenation and binary are required. 3. Altered source versions, and works substantially derived from the it, must... a) be plainly be marked as such, b) not be misrepresented as the original software, c) include this notice, unaltered. ------------------End of NOTICE------------------------*


Table of Contents

Topic

Description

IndexAlphabetical list of all items.
ApplicationRoutines dealing with the running application process.
AttributesThese are routines that let you inspect and alter attributes of controls.
AuthorsA bit of background on the authors of this library.
Change HistoryThis records, in brief, the major changes done to the source code.
Colors
ConstantsThese are constants that are used in a number of Win32Lib routines.
ControlsControls are the basic elements of Windows programs.
Date and timeThese routines are used to extract and display system date and time information.
DefaultsSetting the default values that Win32lib applications use.
Defining ControlsThis section describes how to create windows and the various elements that can appear in them.
Degraded Routines and ConstantsThese are identifiers that will be removed in future releases.
Edit ControlsThese are routines that let you inspect and alter attributes of the text edit controls
ErrorsThese routines are used to manage warnings and errors occurring as your program runs.
EventsEvents are routines that are triggered in response to actions taken by the user.
File Operations The basic File I/O routines using Windows API routines.
FontsThese routines allow you to work with text.
FormsForms are a combination of a Window and its controls.
Frequently Asked QuestionsQuestions and Answers that are often sought by new comers to Win32lib.
General InfoSome background and historical notes about win32lib.
GraphicsThese are routines that allow you to draw on controls.
Image Lists These routines deal with win32lib's ImageList controls.
List ControlThese are routines that let you inspect and alter attributes of controls with lists
ListView Control These routines deal with the ListView common control.
Low Level RoutinesThese routines give you access to low-level internals.
Memory managementRoutines to allocate, use, and release of Random Access Memory (RAM).
MenusRoutines that deal with menu and menuitem handling.
MiscellaneousRoutines that don't easily fit into other categories.
MonthCalendar Control These routines work with MonthCalendar Controls:
MouseThese are routines that deal with the mouse and mouse pointer.
MouseTraps Defined sub-regions of a window that can generate w32HMouseTrap events.
OLE ActiveXObject Linking and Embedding
Printing These are routines that allow you to interact with the Printer.
ResourcesThis set of routines helps you to manage Windows resources.
RichEdit controls In addition to the specialized RichEdit control routines.
Scroll ControlThese routines let you inspect and alter attributes of the scroll bar controls.
SeriesSome utility routines to manange series of numbers.
Support RoutinesMiscellaneous 'generic' routines used by win32lib
System AttributesThese are routines that let you inspect and alter attributes of various system-wide elements.
TextRoutines that deal with text output.
TreeView Control These routines deal with the TreeView common control.
TypesThese are data types defined by Win32Lib.
Updown ControlThese routines let you manage the attributes of the UpDown control.
UtilitiesThese are useful routines that don't seem to fit in any other category.
ValuesThese are routines that let you inspect and alter the current value of a control.
XPMThese routines deal with a portable graphics file format called XPM

Index

abortDoc [proc] Abandons the print job, flushing anything created so far for it.
abortErr [proc] Display an error message, run any user-defined cleanup routines, and then abort.
addDIB [func] Adds DIB's to win32lib's imagelists
addEuBmp [func] Adds EuBitmaps to win32lib's imagelists
addIcon [func] Adds icons to win32lib's imagelists
addItem [proc] Add text to the end of control's list.
addLVItem [func] Add an item to a ListView
addStyle [proc] Add a style to a control.
addToBand [proc] Add a control id to a RebarBand band
addToCType [proc] Adds characters to one or more sets.
addTVItem [func] Add an item to a TreeView
addXpm [func] Adds xpm's to win32lib's imagelists
adjustBrightness [func] Applies a luminosity factor to a color supplied as a 24-bit integer.
adjustCreateFont [func] changes some of the attributes of the font used for controls when they are created.
advapi32 [const] Windows Library: Advanced API
alignControls [proc] Set the edge position for a set of controls.
ansiLower [func] Converts a 8-bit encoded string to lower case, using the current codepage.
ansiUpper [func] Converts a 8-bit encoded string to upper case, using the current codepage.
AppCallback [proc] An application specific callback routine used by win32lib.
appendText [proc] Adds text to the end of a edit control.
Application
assignFont [func] Gets the device context for id with the current font installed.
attachCleanUp [proc] Establishes a user defined clean up routine which is invoked just prior to win32lib ending or aborting.
attachMenuHandle [func] Changes (or sets) the parent of the control id to newparent, using the index attachment data if it is relevant.
attachPopup [func] Associates one or more menus to a control as popup or context menus.
Attributes
Authors
autoSelect [func] Turns on and off an edit control's auto-selection property.
Beep [proc] Sounds one of the standard beeps.
bitBlt [proc] Copy image (or partial image) from source to destination.
Bitmap [const] Static bitmap control.
buildDefaultOfn [func] Creates a OpenFile structure used by the standard dialog.
CancelButton [const] Command button that reacts to the Escape key.
canFocus [func] Turns on and off a control's CanFocus property.
captureMouse [proc] Send all mouse events to window.
CCexflags [const] Used by function classDefaults() to indicate Extended Style Flags
CCflags [const] Used by function classDefaults() to indicate Style Flags
CCwinstyle [const] Used by function classDefaults() to set the style flags when
centerControl [proc] Centers Id with respect to RefId
Change History
changeMousePointer [proc] Set the pointer the mouse displays when in id, without saving the previous shape.
charToIndex [func] Retrieves the index of a character at a given line and column.
CheckBox [const] CheckBox control.
checkPrinter [proc] Checks if a printer was chosen. Prompts the user if none found, or possibly release it.
classAutoSelect [proc] Turns on and off edit controls' default auto-selection property.
classDefaults [func] Used to change the default values for style and extended style flags.
clear [proc] Clear selected text from object.
clearWindow [proc] Sets id to its background color
ClickPointerLeft [proc] See clickPointerLeft
clickPointerLeft [proc] Simulates the clicking of the left mouse button.
clientToClient [func] Converts a point in id1 to a relative point in id2
ClientToScreen [func] Converts a point in a control to screen-based coordinates.
closeApp [proc] Closes the application down.
closeWindow [proc] Close window.
collapseItem [proc] Hides the children of a single TreeView Item
colorValue [func] Converts the parameter into the equivalent 24-bit color value.
Combo [const] Combo box control.
ComboBoxEx [const] Combobox with images
comctl32 [const] Windows Library: Common Controls
comdlg32 [const] Windows Library: Common Dialogs
Constants
Controls
controlStyle [func]
convPctToPixel [func] Converts relative coordinates to pixel coordinates.
convPointsToLogical [func] Calculates the 'logical' height of a font given its 'points' size.
copy [proc] Copy any selected text from object and place in the clipboard.
copyBlt [proc] Copy full image from source to destination.
copyFile [func] Copies a file.
copyToBitmapFile [func] Copies image from window to file fileName.
copyToTrueColorBitmapFile [func] Copies image from window to file fileName.
create [func] Create an object of type pControl.
createDIB [func] Converts a Euphoria bitmap format into a Win32 bitmap.
createDirectory [func] Creates a new directory
createEx [func] Create an object of type controlType.
createForm [proc] This creates a Window and its controls.
createMousePointer [func] Create a new mouse pointer.
createMouseTrap [func] Defines a mousetrap area
createWindow [proc] Creates or reuses a window class for the supplied control id.
createXpm [func] Creates an XPM file from a Euphoria bitmap.
createXpmFromBmpFile [func] Creates an XPM file from a bitmap file.
CText [const] Center-justified label control.
current_number [func] Returns the current value in the series but does not increment it.
cut [proc] Cut any selected text from object and place in the clipboard.
Date and time
Default [const] Indicates the use of the Windows default position values when creating Controls.
Defaults
defineMenuRadioGroup [proc] Defines a set of menu items that form a radio-group
defineUserProperty [proc] Defines a user defined property for this control id.
define_series [proc] Defines a new series.
Defining Controls
DefPushButton [const] Default command button control.
Degraded Routines and Constants
deleteFile [func] Deletes an operating system file.
deleteItem [func] Delete item from list's list at position .
deleteLine [proc] Removes the line with supplied number.
deleteLVColumn [proc] Removes a column from a listview control.
deleteMouseTrap [proc] This removes the specified mousetrap area from the window.
deleteObject [proc] Deletes a Windows GDI resource.
deleteTVChildren [func] Deletes all children at "position" in the tree view.
deleteUserProperty [proc] Deletes a user defined property for this control id.
destroy [proc] Destroy an object created with the create function.
detachCleanUp [proc] Removes a user defined clean up routine from the list of attached ones.
disableControlSet [proc] Disables all the controls in the identified set(s).
distributeControls [proc] Evenly distributes a set of controls.
doEvents [proc] Gives control back to windows until there are no pending events to process.
DragPointerTo [proc] See dragPointerTo
dragPointerTo [proc] Simulates the draging of the left mouse button to a specified position.
drawArc [proc] Draw an arc.
drawBitmap [proc] Draws DIB (device independant bitmap) in window at { x, y }.
drawChord [proc] Draw a chord.
drawEllipse [proc] Draw an ellipse.
drawLine [proc] Draw a line.
drawLines [proc] Draws zero or more lines.
drawPie [proc] Draw a pie slice.
drawPolygon [proc] Draw a polygon.
drawRectangle [proc] Draw a rectangle.
drawRoundRect [proc] Draw a rounded rectangle.
drawText [func] Places the text text into the rectangle rect, wrapping words if necessary.
DropDownList [const] Drop down list control.
Edit Controls
EditText [const] Text edit control control.
enableControlSet [proc] Enables all the controls in the identified set, and disables the previously enabled set.
enableHandler [func] Retrieves and possibly sets the state of a user written event handler.
enableMouseTrap [proc] This alters the 'enabled' state of the specified mousetrap area in the window.
endDoc [func] Ends the print job.
endPage [func] Ends the printing of the current page.
eraseItems [proc] Remove all items from list.
Errors
Events
expandItem [proc] Show the children of a single TreeView Item
expandTV [func] Expands or Collapses all child tree items.
extractIcon [func] Gets the an icon from the file (DLL, EXE or ICO) specified.
EzCreateFont [func] Creates a Font resource
fetch_CHARFORMAT [func] See w32from_memory()
fetch_SYSTEMTIME [func] See w32from_memory()
File Operations
fillRectangle [func] Fills a rectangle in the window id with an arbitrary brush.
filterMouseTrap [proc] This alters the 'filters' of the specified mousetrap area in the window.
findChildren [func] Used to find all the children controls contained in the specified id.
findItem [func] Locates text in the list, starting from index startpos
findParent [func] Used to find the owning control for the specified id.
findParentWindow [func] Used to get the Window id of the control specified by id
findText [func] Find text in a RichEdit Control.
findTrackedObject [func] Looks amongst the tracked objects for one that matches the criteria.
findWindow [func] Looks to see if the named window exists in the system. Only top level or pop-up windows are inspected.
FlatToolbar [const] Creates a toolbar without a 3D border.
floodFill [func] Performs a 'flood fill' operation.
Fonts
formatDate [func] Format a system date as returned by getSelectedDate, getSelectedDateRange
FormatMsg [func] Fetches the format template associated with pTextCode and applies pData to it.
Forms
ForPaint [const] Indicates that the resource lives until the end of the onPaint operation.
ForProgram [const] Indicates that the resource lives until the end of the program.
Frequently Asked Questions
gdi32 [const] Windows Library: Graphic Device Interface (drawing, text, etc)
General Info
Get the count of items in /i menu [desc]
getActiveWindow [func] Returns the id of the control that the user is working on.
getAppName [func] Gets the application's name.
getAppState [func] Returns the current state of the application.
getCaption [func] This returns any caption text associated with id
getCharacterAt [func] Determines the line and column a screen position maps to.
getCharacterCount [func] Returns the number of characters in the control.
getCharacterPosition [func] Determines the screen position of the designated character relative to the upper left corner of the client area of the control.
getCharExtent [proc] Gets the average character width and height for the Id's current font.
getChildren [func] Used to get all the child controls contained in the specified id.
getClassName [func] Gets the Windows Class name for the control.
getClientPoint [func] Get screen position of point { x, y } in window.
getClientRect [func] Get uncovered portion of the client area.
getClientSize [func] Get the dimensions of id's client area.
getClipboard [func] Retrieves data in the clipboard with this format
getColorDialog [func] "Get Color" Dialog
getColumnHeadings [proc] Gets a list of headings for each column in a list view.
getControlInfo [func] Get various internal information about a control.
getCount [func]
getCount [func] Get the count of items in list ( List or Combo )
getCtlSize [func] Get the width and height of object.
getCurrentDirectory [func] Gets the current directory
getData [func] This returns any data value associated with id
getDC [func] Get the DC (device context) of the control.
getDefaultPrinter [proc] Sets up the last printer used (or default printer) for printing
getDefaultPrinterName [func] Determines the name of the current default printer.
getEdit [func] Get the control id of the ComboId control's edit box.
getExtent [func] See getCtlSize
getFileInfo [func] Retrieves various properties of a file.
getFindText [proc] Opens the "Find" Dialog
getFocus [func] Gets the id of the control that has focus.
getFontDialog [func] "Get Font" Dialog
getFontDialogEx [func] "Get Font" Dialog. flags controls which fonts are selectable, as well as other features of the dialog.
getFontMetric [func] Gets font metric field value for id's current font.
getFontPointSize [func] Returns the logical size, in points, of the font currently used by the target window.
getFontSize [func] Gets font metrics for id's current font.
getFormIds [func] Returns the most recently created form(s)
getFRText [proc] Opens the "Find" Dialog
getFullPathName [func] Returns the path and long file name that File refers to.
getHandle [func] Returns the Windows Handle of the specified control
getHandler [func] Gets the event handler(s) defined for a control.
getHandles [func] Gets all the hWnd handles for every control created in your application.
getHint [func] Find the hint text for a control, or the caption for a flattoolbar button
getHScrollPos [func] Gets the value of a window's horizontal scroll bar.
getHWND [func] Returns the Windows Handle of the specified control
getId [func] Finds the control/window ID given a Window Handle.
getIdFromDC [func] Finds the control Id associated with the supplied Device Context.
getIdName [func] Returns the name of a control, given it's id.
getIndex [func] Get the index of the selected item(s), or cursor position in an edit control.
getItem [func] Return the text of item at index in list.
getKeyState [func] Gets the depressed stats of the key.
getLastMsg [func] Gets information about the Windows message(s) being processed.
getLEDs [func] Returns or'ed flags representing the state of the keyboard LEDs.
getLine [func] Fetches the text of the request line.
getLocalTime [func] Gets the date and time according to your timezone settings.
getLVAllChecked [func] Returns a list of the indexes of those rows that are Checked.
getLVAllText [func] Gets the text associated with every column in a listview row.
getLVChecked [func] Gets whether or not an row has its checkbox ticked.
getLVCount [func] Gets the number of rows in a list view.
getLVItem [func] Gets various attributes of a listview item.
getLVItemlParam [func] Gets the user-defined data for this specific row in the list.
getLVItemText [func] Gets the text associated with a listview item.
getLVSelected [func] get a list of the selected items' indexes
getLVSelectedCount [func] Gets the number of selected items in a list view.
getLVSelectedText [func] Gets the column-1 text for each selected item in the listview.
getMainWindow [func] Gets the id of the main window for this application.
getMenuBar [func]
getMenuPosn [func] Get the zero-based relative position of a menu item.
getMousePos [func] See getPointerPos
getMouseRelPos [func] See getPointerRelPos
getMouseTrap [func] This fetches all the information about the specified mousetrap.
getMultIndices [func] Get indices of multiple selections in a multi-selection list
getMultItems [func] Get text of multiple selections in a multi-selection list
getNameId [func] Returns the id of a control, given it's name.
getNameIdInContext [func] Returns the id of a control, given it's name and parent control.
getNotificationData [func] Returns the user data associated with the notification.
getNumber [func] Get the numeric value of text from object.
getOpenFileName [func] "Open File" dialog.
getOpenFileNameEx [func] "Open File" dialog.
getOpt [func] Retrieves the data associated with pKey in the file pSource under the group pCategory
getPageSetup [func] Page setup dialog
getPageSetupEx [func] Page setup dialog
getParent [func] an alias for findParent
getPathFromIDList [func] Translates values returned from selection folder standard dialog boxes into a folder name.
getPixel [func] Get a pixel value from window's client area.
getPointerPos [func] Find where the mouse pointer is on the screen.
GetPointerPosn [proc] See getPointerPos
getPointerRelPos [func] Retrieves relative position of the mouse.
getPosition [func] Get the location of object.
getPrintChoice [func] Get the choices from a user before printing.
getPrinter [func] Get the Printer.
getPrinterName [func] Gets the current printer name.
getRandInt [func] Gets a random number.
getRecent [func] Gets the most recently defined control of a specifc kind, and returns the requested id.
getRect [func] Get the dimensions of id.
getReplaceText [proc] Opens the "Replace" Dialog
getReturnValue [func] Gets the current value of the value that will be returned to Windows.
getRichText [func] Get text from a RichEdit control
getSaveFileName [func] "Save File" dialog.
getScrollChange [func] Returns the amount that scroll will change.
getScrollPos [func] Gets the value of a scroll control.
getScrollRange [func] Returns id's range of values.
getSelectedDate [func] Get the selected date in a MonthCalendar Control
getSelectedDateRange [func] Get selected range of dates in a MonthCalendar Control
getSelectedText [func] Get the selected text in object.
getSelection [func] Gets the character range of any selected text.
getSelectionFont [func] Returns the address of a LOGFONT structure which describes the font used in the selection.
getSelf [func] Get the id number of the current active control.
getSize [proc] See getRect
getStream [func] Convert the data in a RichEdit control to a sequence.
getStyleFlags [func] Retrieves the standard and extra style flags for a control.
getSysColor [func] Return atom with value of a system color.
getSystemMetrics [func] Allows you to get miscellaneous information about the Windows system your application is running on.
getSystemTime [func] Gets the date and time as UTC (a.k.a. GMT)
getTabItem [func] Used to get the current tabitem selected in a tabcontrol
getTagMouseTrap [func] This fetches the data stored by setTagMouseTrap()
getTempFile [func] Used to create an empty file, intended to temporary use.
getTempPath [func] Used to find out the directory designated for temporary files.
getText [func] Get the text in object.
getTextExtent [func] Gets the metrics of the textset strings, using Id's current font.
getTextHeight [func] Gets the height of the text using the current font for the id
getTextWidth [func] Gets the width of the text using the current font for the id
getThumbPos [func] Gets the position of the scroll thumb while being dragged.
getToday [func] Returns today's date from the MonthCalendar control id
getTrackedObject [func] Gets the data saved against this Resource
getTVChildren [func] Returns all child items for the passed item in the tree view.
getTVIndex [func] Find which is the selected item in a treeview.
getTVParent [func] Get the parent id of a TreeView item.
getTVSelectedText [func] Gets the text associated with the selected item in a TreeView.
getTVText [func] Gets the text associated with a TreeView item with id iItem.
getUserName [func] Fetches the id of the currently logged in user.
getUserProperty [func] Retrieves data from a user defined property for this control id.
getValues [func] Gets the values from one or more specified controls.
getVisibleLines [func] Determines the numbers of first and last lines displayed on screen.
getVScrollPos [func] Gets the value of a window's vertical scroll bar.
getWheelScrollLines [func] Retrieves the number of lines that a mouse wheel movement represents.
getWindowInfo [func] Get various information about a window.
getWindowRect [func] Dimensions of window id.
getWinVersion [func] Gets the version information of the windows platform you are running in.
get_series [func] Fetches an entire definition for a series.
Graphics
Group [const] Group control.
hideControlSet [proc] Hides all the controls in the identified set(s).
hitMouseTrap [func] This returns all mousetraps for the window that are under the pX and pY position.
hitTestLV [func] Check to see if mouse is over a ListView item
hitTestTT [func] Tests to see if the mouse is currently over a control that has a tooltip.
hitTestTV [func] Check to see if mouse is over a TreeView item
HScroll [const] Horizontal scrollbar control.
HTrackBar [const] Horizontal track bar control.
Icon [const] Icon control.
idToIndex [func] Given an item id, returns its index in the parent control.
Image Lists
indexToId [func] Given a parent control id and an index, returns an id for the item with that index.
indexToLine [func] Translates a character index to a {line,column} pair.
inMenuBar [func] Determines whether a menu belongs to a window menu bar.
insertItem [func] Insert text into list at position.
insertListViewColumn [proc] See insertLVColumn
insertLVColumn [proc] Inserts a new column into a listview control.
insertLVItem [func] Low-Level version of addLVItem.
insertText [proc] Inserts text at the current caret (insersion point)
insertTextAt [proc] Inesrts text in the text of at a defined point.
invokeHandler [func] Triggers a Win32Lib event.
isChecked [func] Gets the checked state of id.
isDropped [func] Returns 1 if the control is currently in dropped state, else 0.
isEnabled [func] Returns the enabled state of object.
isFieldOf [func] Determines whether field is a field of the struct_type structure type.
isMaximized [func] Used to see if the window object is maximized (zoomed) or not.
isMinimized [func] Used to see if the window object is minimized (iconic) or not.
isScreenPointIn [func] Return w32True if the screen point { x, y } is within control.
isTopLevelWindow [func] Used to determine if the id is a Window that acts independently of other windows.
isVisible [func] Returns the visibility state of object.
kernel32 [const] Windows Library: Memory and Basic Windows Core
killTimer [proc] Stop a timer.
kLVColTypes [const] Used by setLVAttr
kLVSortRtn [const] Used by setLVAttr
kLVSortSeq [const] Used by setLVAttr
kMainMsg [const] Used by the notify and raw message handlers. See setNotifyHandler
kProcessMsg [const] Used by the notify and raw message handlers. See setNotifyHandler
kReturnNow [const] Used by the notify and raw message handlers. See setNotifyHandler
kSubclassedMsg [const] Used by the notify and raw message handlers. See setNotifyHandler
limitText [proc] Limits the amount of text a user can enter into an Edit control.
List [const] List.
List Control
ListView [const] ListView
ListView Control
loadBitmapFromFile [func] Loads a bitmap file.
loadCursor [func] Loads a cursor from a file.
loadForm [func] Builds a form definition from a text file.
loadIconFromFile [func] Get an icon from a file.
loadLVInfo [proc] Used to bulk load data into a list view control
Low Level Routines
LText [const] Left-justified label control.
main [func] An optional application routine, called within w32start.ew just prior to Windows gaining control.
makeFront [proc] Brings to control to the front
makeStandardName [func] Transforms a string into a standardized format suitable for naming things.
manageToolTip [func] Helps manage the ToolTip controls.
Memory management
Menu [const] Menu bar item control.
MenuItem [const] Dropdown menu item control.
Menus
MenuSpacer [const] Horizontal spacer (line) in menu items.
Miscellaneous
mixColors [func] Computes the weighted average of the supplied colors by calling w32average()
MleText [const] Multi-line edit control.
MonthCalendar [const] MonthCalendar
MonthCalendar Control
Mouse
MouseTraps
moveFile [func] Renames or Moves a file.
moveWindow [proc] See setRect
moveZOrder [proc] Move id to up or down the of Z order of windows.
newColor [func] Attempts to define a new color named name with value value
newEvent [func] Defines a new event, and cause it to be triggered by message, with processing routine with routine_id rid.
newPrinter [proc] Sets up the printer whose friendly name is supplied.
newUIObj [proc] Defines a User Interface Object, a.k.a. a Control
next_number [func] Increments the series and returns the next value in it.
OLE ActiveX
ole32 [const] Windows Library: Graphic Device Interface (drawing, text, etc)
OleInitialize [proc] Initializes the thread's OLE subsystem
OleUninitialize [proc] Resets the thread's OLE subsystem
openDialog [proc] Opens a window, id, as a modal dialog.
openWindow [proc] Opens a window
paste [proc] Paste text from the clipboard to object.
PictureButton [const] Command button with graphic control.
Pixmap [const] Color bitmap.
playSound [func] Play the .WAV file.
Popup [const] Popup menu control.
popup [proc] Display popupMenu at { x, y }.
Printer [const] Handle to the printer.
Printing
printRichText [proc] Prints some or all the contents of a rich edit control.
printRichTextPages [proc] Prints the contents of a RichText control.
ProgressBar [const] Progress Bar
PushButton [const] Command button control.
putStream [proc] Load text into a RichEdit control from a text sequence.
queryDevice [func] Gets device informtion for the screen or a printer.
Radio [const] Radio button control.
ReBar [const] ReBar
refreshWindow [proc] Forces the control(s) to be refreshed.
registerControl [func] Enables you to define new control types.
registerHotKey [proc] Allows you to associate a ALT-key combination to set focus to a control.
registerNotification [proc] Defines, modifies or removes an event forwarding.
registerRoutine [proc] Registers a text string with an associated routine_id.
registerw32Function [func] Associates an internal id number with the function name.
registerw32Library [func] Associates an internal id number with the library name.
registerw32Procedure [func] Associates an internal id number with the procedure name.
releaseDC [proc] Release the device context of the control.
releaseMouse [proc] Return control of the mouse to Windows.
releasePrinter [proc] Release the Printer, freeing it up for others to use.
removeFromCType [proc] Removes characters from one or more sets.
removeHandler [proc] Removes user written event handlers previously set with setHandler()
removeMenu [func] Removes a menu item from a menu.
removeStyle [proc] Remove a style from a control.
repaintFG [proc] Force window to be repainted but without clearing it first.
repaintRect [proc] Force window to be partially repainted.
repaintWindow [proc] Force window to be entirely repainted.
replaceObject [proc] Selects an object into a device context, which automatically tracks that object.
resetReturnValue [proc] Removes any value returned by handler.
resetUserProperty [proc] Initializes a user defined property for this control id.
Resources
restoreMousePointer [proc] Gets back the previous pointer the mouse had before the last setMousePointer call.
returnValue [proc] Override default value returned by handler.
rgb [func] Convert a {red, green, blue} tuple into a 24-bit color value.
riched32 [const] Windows Library: Rich Edit Control
RichEdit [const] RichEdit
RichEdit controls
RText [const] Right-justified label control.
Screen [const] Identifes the screen.
ScreenToClient [func] Converts a point on a screen to control-based coordinates.
Scroll Control
selectDirectory [func] Displays a dialog for selecting directories.
sendMessage [func] Send a Win32 message to the requested control.
SepButton [const] Separator button for use with FlatToolBar Controls
Series
setAcceleration [proc] Set the rate of change for an UpDown control
setAlignment [proc] Align text in a RichEdit Control
setAppName [func] Sets the text used as a class name prefix for new Windows.
setAutoFocusLabels [func] Possibly sets whether or not a '&' in labels set focus to subsequent edit field.
setBackColor [proc] Set the color for used for the pen fill color in id.
setBackground [proc] Sets the background of control id with a color, pattern or bitmap.
setBitmap [proc] Assign an bitmap to Object.
setBuddy [proc] Set the buddy control of an UpDown control id to be buddy. The buddy
setBullet [proc]
setCallback [func] gets and sets the application's generic callback routine id
setCheck [proc] Check or uncheck id.
setClientRect [proc] Sets the size of the client area in a window.
setClipboard [func] Sets the clipboard to data using the other parameters.
setColumn [proc] Changes the column header text, or width, or alignment.
setColumnHeadings [proc] Sets the heading text for the columns in a ListView Control.
setContainer [func] Defines the message file that is used by Usetext
setControlBlocks [proc] Sets the number of new memory areas created for new controls
setControlSet [proc] Create and maintains the entries in a control set.
setCreateFont [func] sets the font used for controls when they are created.
setCtlPosition [proc] Sets the location of the control. x and y can have any format create() supports.
setCtlSize [proc] Resizes control to Width and Height.
setCurrentDirectory [proc] Sets the current directory
setDecimalMark [func] Gets and possibly sets the decimal mark w32TextToNumner() is to recognise.
setDefaultFont [proc] Set the font to default system font.
setDefaultProcessing [func] This establishes a replacement routine to handle the Windows default processing,
setDisableBg [proc] Sets the color to use when disabling the control id.
setDragPointer [proc] Sets the mouse pointer shape to use when dragging.
setEnable [proc] Enable or disable id.
setEndAction [func] Sets the exit code and behaviour at application closure.
setErasePolicy [func] Possibly sets and gets the Background Erasing policy for the control id
setEventLoop [func] This establishes an replacement event loop.
setFileAttr [func] Sets one or more attibutes for the specified file.
setFocus [proc] Set the focus to the specified window or control.
setFont [proc] Set the font for a control or window.
setFontWeight [func] Possibly sets what you mean by 'bold' when using setFont(..., Bold )
setFRData [func] Gets and possibly sets the "find what" and "replace with" strings used in a Find/Replace dialog box, as well as its control flags.
setFRMsgStrings [func] Gets and possibly sets the strings appearing in the default message boxes when &
setHandler [proc] Sets up an user written event handler
setHandlerProtection [func] Possibly sets the protection status for a pair {id,event}.
setHint [proc] Set the tooltip text for a control.
setHintEx [proc] Set the tooltip text for a control.
setHintFont [proc] Set font type and size for the control's hints.
setHintWidth [func] Possibly sets the maximum width, in pixels, of the control's tooltip box.
setHScrollPos [proc] Sets the value of a window's horizontal scroll.
setIcon [proc] Assign an icon to object.
setIdle [func] Possibly sets whether or not the library implements w32HIdle
setIdName [proc] Sets the name of a control, given it's id.
setImageList [proc] Sets the image list for a ListView, TreeView, TabControl or ComboBoxEx control.
setIndent [proc] Change indenting in a RichEdit Control
setIndex [proc] Select characters in the control.

setIndex [proc] Set the selected item on the list to index.
setKbdInput [func] Possibly sets the value to return, or the routine_id to use, when control receives the WM_GETDLGCODE message.
setListHScroll [func] Recalculates the size of a horizontal scroll bar on a listbox.
setLVAttr [func] Set (some) attributes of a ListView control
setLVChecked [proc] Sets the checked state for a ListView Item
setLVImage [func] Possibly sets the new background image of the ListView, and returns previous state.
setLVInsert [func] Possibly sets the default position for ListView inserts.
setLVItem [proc] Enables you to set a number of the properties of a ListView item in one call.
setLVItemEx [proc] Enables you to set a number of the properties of a ListView item in one call,
setLVItemlParam [proc] Sets the user-defined data for this specific row in the list.
setLVItemText [proc] Sets the text of a List View item or subitem.
setLVStyle [proc] Sets the extended style flags on a listview
setMainWindow [func] Used to tell the library which window is the primary one.
setMaxDateRange [proc] Sets the maximum number of days that can be selected.
setMenuItemBitmaps [func] Sets the bitmap on a menu item, or the checked/unchecked marks
setMonthColor [proc] Change color of a MonthCalendar Control
setMouseClick [func] Sets/gets the mouse click detection parameters.
setMousePointer [proc] Set the pointer the mouse displays when in id.
setNotificationState [func] Possibly sets the state for the designated notification, and returns the former value of the state.
setNotifyHandler [func] Sets a handler for WM_NOTIFY type of messages.
setPaintPolicy [func] Possibly sets the paint policy flag.
setParent [func] Changes (or sets) the parent of the control id to newparent, using the index attachment data if it is relevant.
setPenBkColor [proc] Determines the background color for text.
setPenBkMode [proc] Determines if the background color for lines and text.
setPenBrushColor [proc] Determines the solid brush color for filled shapes.
setPenColor [proc] Set the the pen color used in window.
setPenMode [proc] Determines what mode graphics are drawn in.
setPenPos [proc] Position the text pen in window.
setPenPosition [proc] See setPenPos
setPenROP2 [func] See setPenMode
setPenStyle [proc] Set the style that lines are drawn in.
setPenWidth [proc] Set the the pen width used in window.
setPixel [proc] Set a pixel value in window's client area.
setPixmap [proc] Assign a new value to a Pixmap.
setPointerPos [proc] Moves the mouse pointer to a specified spot on the screen.
SetPointerPosn [proc] See setPointerPos
setPosition [proc] See setPenPos
setPreProcessDataIn [proc] Sets up a routine to preprocess data fed to w32to_memory() for a given type of structure.
setPrintJobProperty [func] Gets, and possibly sets, a print job property.
setProtectedHandler [proc] Same as setHandler(), but overrides any protection without changing it.
setReadOnly [proc] Sets the read-only state of an edit control.
setReBarAutoSizing [func] Sets/Gets the automatic resizing facility for ReBar controls.
setREChangeNotification [func] Gets, and possibly sets, the status of change notification for a RichEdit control.
setRect [proc] Move and resize control.
setScrollChange [proc] Adjust the amount that a scroll control will change.
setScrollPos [proc] Sets the value of id.
setScrollRange [proc] Sets the range of values of a control.
setSearchPaths [func] Possibly sets the file system paths to use when searching for files
setSelectedDate [proc] Set the selection in a MonthCalendar Control
setSelectedDateRange [proc] Set the selected range in a MonthCalendar Control.
setSelectedText [proc] Replaces the selected text in object with text.
setSelection [proc] An alias for setIndex
setSelection [proc] An alias for setIndex
setStartupFont [proc] Establishes the default font to use when creating a window or control.
setStartWithSize [proc] Indicates to w32to_memory() that, when filling a structure of this type, its size should be plugged in as the first field.
setSubFields [proc] Defines the sub-fields, or panels, in a status bar.
setTabCodes [func] Sets the list of tabbing keys to newcodes
if it is valid.
setTabEnabled [func] Possibly sets the flag which says whether a (Rich)Edit control uses Ctrl-Tab for tabbing
setTabImage [func] Possibly sets the image associated to a tab item and returns index of previous one.
setTabs [proc] Change tab stops in a RichEdit Control.
setTabs [proc] Set/change tab stops in a List or SortedList Control.
setTabStops [func] This possibly establishes the controls in a containing control that get tabbing focus.
setTagMouseTrap [proc] This alters the 'user data' of the specified mousetrap area in the window.
setText [proc] Set the text in pID control.
setTextAlign [proc] Set the font alignment to use when printing text.
setTextColor [proc] Set the text color to use when drawing text in window.
setTimer [proc] Start a timer ticking in window.
setToday [proc] Set the 'today' date in the MonthCalendar control id
setToolBarSize [proc] Set one or more size properties of a ToolBar or FlatToolBar.
setTooltipTiming [func] Possibly sets the timings for all the tooltips the tooltip conrol id manages.
setTransparentColor [proc] Defines what the transparent color is to be.
setTVImages [proc] Sets the images associated with a TreeView item.
setTVText [proc] Sets the text associated with a TreeView item.
setUserLanguage [func] Defines or returns the language category that is used by UseText
setUserProperty [proc] Stores data into a user defined property for this control id.
setVisible [proc] Make id visible or invisible.
setVScrollPos [proc] Sets the value of a window's vertical scroll.
setWarning [proc] Shows or Hides warning messages from user.
setWindowBackColor [proc] Sets the background of id to color.
setWindowRect [proc] Sets the dimensions of window id.
setWindowScrollRange [proc] Set range of window scrollbar or normal scrollbar .
setWinMsgHandler [proc] Sets a user defined (raw) windows message handler.
shell32 [const] Windows Library: Shell Extensions
shellExecute [proc] Launch a Windows application
shellExecuteEx [func] Launch a Windows application
showChars [proc] Determines if wPrint displays characters or numbers
showControlSet [proc] Makes visible all the controls in the identified set, and hides the previously shown set.
showMessage [proc] Displays Message in a Statusbar
showWindow [proc] Shows a window according to the style
SimpleCombo [const] Simple combo box control.
sizeControls [proc] Set the size for a set of controls.
skipF10 [func] Possibly sets whether or not F10 sets focus on the menubar
SortedCombo [const] Sorted combo box control.
SortedList [const] Sorted list control.
split_rgb [func] Convert a color into a {red, green, blue}.
startApp [proc] Start the application running.
startDoc [func] Starts a new document on Printer.
startPage [func] Prepares the printer to begin a new page.
StatusBar [const] Window status bar control.
stretchBlt [proc] Copy image (or partial image) from source to destination, changing its size as you go.
struct_CHARFORMAT [func] See w32to_memory()
struct_CHARRANGE [func] See w32to_memory()
struct_EDITSTREAM [func] See w32to_memory()
struct_FINDREPLACE [func] See w32to_memory()
struct_FINDTEXTEX [func] See w32to_memory()
struct_GETTEXTEX [func] See w32to_memory()
struct_LVBKIMAGE [func] See w32to_memory()
struct_LVCOLUMN [func] Allocates RAM for a LVCOLUMN structure and initialises it.
struct_LVFINDINFO [func] See w32to_memory()
struct_LVITEM [func] See w32to_memory()
struct_MENUITEMINFO [func] See w32to_memory()
struct_PARAFORMAT [func] See w32to_memory()
struct_REBARBANDINFO [func] See w32to_memory()
struct_SYSTEMTIME [func] See w32to_memory()
struct_TEXTRANGE [func] See w32to_memory()
struct_TOOLINFO [func] See w32to_memory()
struct_TVHITTESTINFO [func] See w32to_memory()
struct_TVINSERTSTRUCT [func] See w32to_memory()
struct_TVITEM [func] See w32to_memory()
subClassControl [func] Used to access Windows created controls as if they were win32lib controls.
Support Routines
System Attributes
TabControl [const] Tab Control.
TabItem [const] Tab on a TabControl.
tab_direction [proc] Moves focus ahead or back to next available focus item
Text
textOut [proc] Writes text to a control.
textRect [func] Calculates the RECT structure need to draw all the text.
textToBitmap [func] Converts a sequence of text into a monochrome bitmap.
ToggleButton [const] Toggle button control.
toggleItem [proc] Shows or Hides the children of a single TreeView Item
TogglePicture [const] Toggle button with graphic control.
ToolBar [const] Window toolbar control.
ToolTip [const] Creates a ToolTip control.
trackObject [proc] Tracks an object as a held resource.
transBlt [proc] Copy full image from source to destination, with transparency.
TreeView [const] TreeView
TreeView Control
TriCheckBox [const] Three state checkbox control.
Types
undo [proc] Undo last edit in object.
updateMouseTrap [proc] This changes the bounding rectangle for a mousetrap.
UpDown [const] UpDown
Updown Control
useLogicalResolution [func] Possibly sets the flag that determines if logical font resolution is used or not.
user32 [const] Windows Library: User Interface
UseText [func] Fetches the text associated with pTextCode
Utilities
validId [func] Tests to see if the specified id is a valid one.
Values
VScroll [const] Vertical scrollbar control.
VTrackBar [const] Vertical track bar control.
w32abs [func] Absolute value.
w32acquire_handle [func] Gets a Windows memory handle to memory of the requested size.
w32acquire_mem [func] Allocate memory for structure, and initialize to zero.
w32address [func] Get address of field in structure.
w32AllItems [const] This signifies that all items are to be deleted.
w32allot [func] Allocate space in structure for a new field.
w32allotted_buffer [func] Returns a modified field so as to w32fetch() the address of the supplied buffer
w32allotted_handle [func] Returns the address of the supplied handle, but with fetch instructions
w32allotted_length [func] Returns a modified field so as to w32fetch() the length of the supplied buffer
w32allotted_size [func] Return allocate size of structure, and reset for new structure.
w32allotted_sofar [func] Return size allotted sofar to the structure
w32AltEdge [const] Specifies the alternate edge required when creating or moving a control.
w32average [func] Computes the weighted average of data using the weight(s) weight.
w32bounds [func] Returns index(es) or value(s) of the minimal/maximal element in a sequence
w32buffer_address [func] Returns the address of the buffer, while w32fetch would return the string stored there.
w32buffer_length [func] Returns the stored length of the buffer.
w32ColorNames [const] List of all recognised color names.
w32ColorValues [const] List of all known color values, in the same order as w32ColorNames.
w32ControlNames [const] Holds the names of recognised controls.
w32ControlTypes [const] Holds the values of recognised controls, in the same order as w32ControlNames.
w32copy_field [proc] Copies contents of the field of the structure at origin described by s to struct.
w32copy_struct [proc] Copies the structure whose base address is origin to struct, its type being id.
w32CType [func] Tests a character to see if it 'belongs' to a specified CharType set.
w32define_this_struct [func] Returns an identifier for the currently defined structure at the current point.
w32define_union [func] Defines a union structure: the structure is any of the ones given in fields.
w32Edge [const] Specifies the extreme edge required when creating or moving a control.
w32ElemAddr [proc] See w32address()
w32Encode [func] This routine transforms a string into an encoded form
w32EventCodes [const] List of all recognised event codes, in the same order as w32EventNames.
w32EventNames [const] List of all recognised event names, without the "w32H" prefix.
w32extract_formats [func] Determines all substrings of i s which are format specifiers
w32False [const] The value for a boolean FALSE.
w32fetch [func] Fetch field from structure.
w32FileOpen [func] Search the set 'searchpaths' for the file then opens it.
w32FindFile [func] Search the set 'searchpaths' for the file and returns its path specification.
w32findKey [func] Find the element in list that has key as its first element.
w32findKeyEx [func] Find key in list using the depth indicated in element.
w32from_memory [func] Returns the fields of a structure.
w32from_memoryEx [func] Returns the fields of a structure.
w32Func [func] Invoke a Windows function.
w32GetCType [func] Gets the CharType for the specified character(s)
w32get_bits [func] Does the reverse of w32or_all() in that it gets all the bit values from an atom.
w32HActivate [const] Occurs for Windows only and after the window is opened.
w32HAfterEvent [const] Occurs after normal Windows processing of an event (any type).
w32handle_to_memory [func] Gives current task exclusive access to the referenced memory block.
w32HBreak [const] Invoked whenever the Ctrl-Break key is pressed.
w32HChange [const] Selection or Value in a control is changed.
w32HClick [const] Invoked when the left mouse button is 'clicked' or a Button control is used.
w32HClose [const] A Window is closed.
w32HCloseUp [const] The dropdown portion of a combobox has just been closed, or the menu was just closed.
w32HDataChange [const] Value in a List or a Combo's list has changed.
w32HDestroy [const] The control is about to be destroyed.
w32HDragAndDrop [const] Something has been dragged onto the control or window.
w32HDropDown [const] The dropdown portion of a combobox is about to be displayed, or the menu is about to be displayed..
w32HEvent [const] An event (any type) has occured.
w32HGotFocus [const] A control (or Window) receives focus.
w32HIdle [const] Invoked whenever the application is not processing Windows messages.
w32hi_word [func] returns the high 16 bits of pData
w32HKeyboard [const] Occurs when keys are held down and about to be released.
w32HKeyDown [const] Key is pressed.
w32HKeyPress [const] "Printable" key is pressed.
w32HKeyUp [const] Key is released.
w32HLostFocus [const] A Window or control loses focus.
w32HMouse [const] Event triggered when a mouse action takes place.
w32HMouseTrap [const] Event triggered when a mouse action takes place inside a defined MouseTrap for a control.
w32HNotify [const] A control is forwarding a notification event.
w32HOpen [const] A Window is opened.
w32HPaint [const] A portion or all of a Window needs to be redrawn.
w32HPause [const] Invoked whenever the Pause key is pressed.
w32HResize [const] A Window has been resized.
w32HScroll [const] Triggered when scrollbar value has changed, and when user has stopped scrolling.
w32HTimer [const] A timer is triggered.
w32iff [func] Used to embed an 'if' test inside an expression.
w32index [func] Returns the list of positions of items in s.
w32index_by [func] Indexes s using the field number field.
w32insertElement [func] Inserts the object into the list at position pos
w32join [func] Builds a string by concatenating itmes in substrings, separated by delimiters.
w32KH_SetFocus [const] Used as a return value by w32HKeyDown handlers to indicate that the focus needs to be changed.
w32llSetAbort [func] Possibly sets the routine id of an Abort routine.
w32lookup [func] Returns the corresponding element.
w32lo_word [func] returns the low-16 bits of pData
w32LV_EndSorting [const] Used by ListView controls that have a custom sorting routine.
w32LV_StartSorting [const] Used by ListView controls that have a custom sorting routine.
w32manage_mem [func] Records an acquired memory for garbage collection.
w32MaxWidth [func] Computes the maximum width of elements of pData.
w32MinSequenceSize [func] Pads pList to the right until its length reaches pMinSize using pNewData as filler.
w32MsgNum [const] This is the recommended starting point for user defined error codes.
w32new_memset [func] Allocates a unique id for a memory set.
w32ordered_find [func] Uses a binary tree search to find x in s, possibly
w32or_all [func] Calculates a binary OR against each element in pData
w32pack_word [func] Packs values into word.
w32PB_BITMAP [const] Used when creating a PictureButton and ToggleButton.
w32PB_ICON [const] Used when creating a PictureButton and ToggleButton.
w32peek2 [func] Retrieves a sequence of double byte encoded characters as a regular sequence
w32peek_string [func] Get sequence from address holding C-style string.
w32peek_string16 [func] Returns a 0000 terminated DBCS encoded string starting at addr.
w32poke_words [proc] Poke one or more words at at.
w32Proc [proc] Invoke a Windows procedure.
w32rand32 [func]
w32realise [func] Rebuilds a contiguous memory structure, possibly discarding virtual info
w32rectangle_delta [func] Determines the difference and intersection between two rectangles
w32release_handle [proc] Releases the referenced memory block, and optionally frees it.
w32release_mem [proc] Returns the memory allocated by w32acquire_mem() back to the system.
w32remainder [func] Ensures that the result has the sign of b, contrary to remainder().
w32removeIndex [func] Remove the element at position index from the sequence list
w32removeItem [func] Removes item from the list, if it is in the list.
w32replaceItem [func] Replaces all occurances of pOld with pNew
w32round [func] Rounds a, or all the atoms in the sequence a, to some multiple of b.
w32routine_id [func] Returns the routine id for the registered routine pRoutineName
w32SetCType [proc] Sets one or more character types used by w32CType and w32GetCType
w32set_memory [proc] Performs the same function as w32to_memory(), but stores data at address struct.
w32shortInt [func] Converts a number into a 16-bit signed integer
w32signed_word [func] Converts a into a signed 16-bit integer.
w32Sleep [proc] Puts current thread to sleep for milliseconds milliseconds, if another OS thread is ready to run.
w32specialise [func] Returns a structure field descriptor that can be translated into an actual variant of a union.
w32split [func] Returns the undelimited substrings
w32Start [incl] This is an optional include file. It defines a default application callback routine
w32store [proc] Store a value into a structure.
w32string [type] Implements an ASCII string.
w32TextToNumber [func] This converts the text into a number.
w32ToString [func] Assembles a sequence from the substrings in pData, separated by commas.
w32to_memory [func] Initialises memory structiure of given type with supplied data.
w32to_memoryEx [func] Initialises memory structiure of given type with supplied data.
w32to_string [func] Converts the parameter to a string repesentation of its value.
w32trim [func] Removes any whitespace chars from both ends of pSource
w32trim_left [func] Removes any whitespace chars from the beginning of pSource
w32trim_right [func] Removes any whitespace chars from the end of pSource
w32True [const] Pass this value as a parameter to obtain its current value without setting it.
w32True [const] The value for a boolean True
w32unpack_dword [func] Converts a number into two 16-bit integers
w32UsingSafeCode [Var] Determines whether or not the 'safe' versions of peek and poke are used.
w32VOID [const] This junkyard is provided so as to receive return values you don't need.
warnErr [proc] Display an error message, with option to abort.
Win32LibVersion [const] Contains the current version of win32lib library.
Window [const] A Window is a normal Win32 window.
WinMain [proc] Run event loop.
winmm32 [const] Windows Library: Multi-Media
wPrint [proc] Equivalent to Euphoria's print() routine.
wPrintf [proc] Equivalent to Euphoria's printf() routine.
wPuts [proc] Equivalent to Euphoria's puts() function.
XPM
xpmToEuBmp [func] Convert XPM data into a standard Euphoria bitmap.
xpmToPixmap [func] Create a Pixmap from XPM data.
zorderMouseTrap [proc] This alters the 'depth' of the specified mousetrap area in the window.