Harbour Reference Guide

wvw__MakeDlgTemplate()  |  | Improve this doc

Syntax
wvw__MakeDlgTemplate( <aDlg>, <aItens1>, <aItens2>, <aItens3>, <aItens4>, <aItens5>,
<aItens6>, <aItens7>, <aItens8>, <aItens9>, <aItens10> )
Arguments
aDlg aItens1 aItens2 aItens3 aItens4 aItens5 aItens6 aItens7 aItens8 aItens9 aItens10
Returns
String with new template dialog.
Description
Creates a window dialog template.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_AddRows()Source code  |  | Improve this doc

Syntax
wvw_AddRows( <nWinNum>, <nRows> )
Arguments
nWinNum Window number. Default is current window. nRows Number of lines to add or reduce (if nRows < 0).
Returns
.T. if successful, .F. otherwise.
Description
Adds or reduces lines from window. The new lines will be colored from column zero color, from prior line. There's no checking to determine if the window is bigger than desktop area (except if in MainCoord mode, because we need these boundaries to MaxRow() function).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_AppendMenu()Source code  |  | Improve this doc

Syntax
wvw_AppendMenu( <hMenu>, <nFlags>, <nMenuItemId>, <cCaption> )
Arguments
hMenu Identifies the menu to be changed. nFlags Specifies flags to control the appearance and behavior of the new menu item. This parameter can be a combination of values (all flags can be viewed in winuser.ch file). nMenuItemId Specifies either the identifier of the new menu item or, if the uFlags parameter is set to MF_POPUP, the handle to the drop-down menu or submenu. cCaption Specifies the string content of the new menu item or full path to a bitmap to the new menu item.
Returns
If successful, a value greater than zero. Otherwise zero.
Description
Adds a new menu item. Through this function we can specifies the content, appearance and behavior of each menu item.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbAddString()Source code  |  | Improve this doc

Syntax
wvw_cbAddString( <nHandleDialog>, <nIDComboBox>, <cItem> )
Arguments
nHandleDialog Dialog handle of window. nIdComboBox ID of Combobox. cItem Item to be included in Combobox.
Returns
None.
Description
Adds an item into Combobox.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbCreate()Source code  |  | Improve this doc

Syntax
wvw_cbCreate( <nWinNum>, <nTop>, <nLeft>, <nWidth>, <aText>, <bBlock>,
<nListLines>, <nReserved>, <nKbdType>, <aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, nLeft Coordinates of combobox. nWidth Width of combobox. aText Array with all combobox elements. Default is empty. bBlock Code block, executed for the following events: CBN_SELCHANGE: CBN_SETFOCUS: CBN_KILLFOCUS: User change selection (not executed when made by program itself) When focus go to combobox When focus lost from combobox
This code block will be evaluated with the following arguments: nWinNum nCBId nType nIndex Actual windows number Combobox ID Event type (only the three types above are supported) Index on selected item (start from 0)
nListLines Number of lines to list items (default is 3). will be automatically truncated if this parameter is greater than Len(aText). nReserved Reserved for future use. nKbdType Specifies the behavior of combobox. Can be one of the following values: 0: 1: Similar to standard windows convention (i.e., ENTER/ESC will kill focus from combobox) Similar to CA-Cl*pper (i.e., ENTER shows all combobox's items, UP/DOWN/TAB/SHIFT+TAB/ESC will kill focus from combobox)
Default is 0.
aOffset Array with four elements containing offsets to corner pixels { x1, y1, x2, y2 }, to adjust dimension of combobox. Default is { -2, -2, +2, +2 }. The third element (y2) is actually ignored. Height of combobox is always 1 char height.
Returns
Handle of combobox, if successful. Zero if failed.
Description
Create a combobox in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbDestroy()Source code  |  | Improve this doc

Syntax
wvw_cbDestroy( <nWinNum>, <nCBId> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of Combobox.
Returns
None.
Description
Delete a combobox in the current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbEnable()Source code  |  | Improve this doc

Syntax
wvw_cbEnable( <nWinNum>, <nCBId>, <lEnable> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of Combobox. lEnable Enable (.T.) or disable (.F.) combobox button in current window. Default is .T.
Returns
Return old configuration of combobox (.T. enable, .F. disable). If failed, return .F..
Description
Enable/Disable access of combobox in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbFindString()Source code  |  | Improve this doc

Syntax
wvw_cbFindString( <nWinNum>, <nCBId>, <cString> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of combobox. cString String to find.
Returns
Index of string, or -1 if failed (or can't find).
Description
Find index of string in combobox in current window. This function is case insensitive.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbGetCurText()Source code  |  | Improve this doc

Syntax
wvw_cbGetCurText( <nWinNum>, <nCBId> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of combobox.
Returns
String, if successful, or "" if failed.
Description
Get current selected string in combobox in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbGetIndex()Source code  |  | Improve this doc

Syntax
wvw_cbGetIndex( <nWinNum>, <nCBId> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of combobox.
Returns
Current position in combobox or -1 if failed.
Description
Get current selection in combobox (start from zero).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbIsDropped()Source code  |  | Improve this doc

Syntax
wvw_cbIsDropped( <nWinNum>, <nCBId> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of combobox.
Returns
Return .T. if listbox is being shown, otherwise .F.. Also return .F. if combobox ID is not valid.
Description
Get current dropped state of combobox in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbIsFocused()Source code  |  | Improve this doc

Syntax
wvw_cbIsFocused( <nWinNum>, <nCBId> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of combobox.
Returns
.T. if is focused, .F. otherwise.
Description
Get information if focus is on combobox in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbSetCodeblock()Source code  |  | Improve this doc

Syntax
wvw_cbSetCodeblock( <nWinNum>, <nCBId>, <bBlock> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of combobox. bBlock New code block to assign to combobox.
Returns
.T. if successful, .F. otherwise.
Description
Assign a new code block to combobox on current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbSetCurSel()Source code  |  | Improve this doc

Syntax
wvw_cbSetCurSel( <nHandleDialog>, <nIDCombobox>, <nIndex> )
Arguments
nHandleDialog Handle of window dialog. nIDCombobox ID of combobox. nIndex Index of item (start from zero). If 1, remove current selection and clean edit control of combobox.
Returns
None.
Description
Select an item of combobox list.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbSetFont()Source code  |  | Improve this doc

Syntax
wvw_cbSetFont( <nWinNum>, <cFontFace>, <nHeight>, <nWidth>, <nWeight>,
<nQuality>, <lItalic>, <lUnderline>, <lStrikeout> )
Arguments
nWinNum Window number. Default is current window. cFontName Name of the font. nHeight Height of the font's character. nWidth Specifies average width of character in the font. nWeight Specifies the weight of the font in the range 0 through 1000 (see About Fonts section). nQuality Specifies the output quality. lItalic Specifies an italic font if set to TRUE. lUnderline Specifies an underlined font if set to TRUE. lStrikeout Specifies a strikeout font if set to TRUE.
Returns
.T. if successful, .F. otherwise.
Description
This will initialize font for all comboboxes on current window (including ones created later on).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cbSetIndex()Source code  |  | Improve this doc

Syntax
wvw_cbSetIndex( <nWinNum>, <nCBId>, <nIndex> )
Arguments
nWinNum Window number. Default is current window. nCBId ID of combobox. nIndex Item index on combobox (start from 0).
Returns
.T. if successful, .F. otherwise.
Description
Set current selection on combobox.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cxCreate()Source code  |  | Improve this doc

Syntax
wvw_cxCreate( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <cText>,
<cImage>/<nImage>, <bBlock>, <aOffset>, <nStretchBitmap>, <lMap3DColors> )
Arguments
nWinNum Window number. Default is current window. nTop, nLeft Row/column of top/left corner. nBottom, nRight Row/column of bottom/right corner. cText Text of checkbox. Default is empty. cImage/nImage If numeric, represent an resource ID from a .RC file. If string, represent a bitmap file name (must be supplied with a full path). bBlock Code block to execute on every BN_CLICK event. This code block will be evaluated with these parameters: current window and checkbox id. If this parameter is omitted, the checkbox will not be created. aOffSet Array of four elements {x1,y1,x2,y2} with offsets to corner pixels to adjust dimension of checkbox. Default is {-2,-2,+2,+2}. nStretchBitmap A number between 0 and 1 (inclusive) as a factor to stretch the bitmap. Example: 1.0 0.5 0 Bitmap covers the whole button Bitmap covers 50% of button Bitmap is not stretch
Default is 1. lMap3Dcolors If image will have transparent effect (.T.) or not (.F.). This will work on 256 colored bitmaps only.
Returns
Returns checkbox handle, if successful. If failed, return zero.
Description
Creates a checkbox.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cxDestroy()Source code  |  | Improve this doc

Syntax
wvw_cxDestroy( <nWinNum>, <nCXId> )
Arguments
nWinNum Window number. Default is current window. nCXId ID of checkbox.
Returns
None.
Description
Delete a checkbox on current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cxEnable()Source code  |  | Improve this doc

Syntax
wvw_cxEnable( <nWinNum>, <nCXId>, <lToggle> )
Arguments
nWinNum Window number. Default is current window. nCXId ID of checkbox. lToggle If .T., Enable, otherwise disable. Default is .T.
Returns
Return previous state of the checkbox, if lToggle informed. Otherwise, returns current state of the checkbox (.T. = enable, .F. = disable).
Description
Enable/disable a checkbox on current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cxGetCheck()Source code  |  | Improve this doc

Syntax
wvw_cxGetCheck( <nWinNum>, <nCXId> )
Arguments
nWinNum Window number. Default is current window. nCXId ID of checkbox.
Returns
Returns one of the following values: 0 1 2 Not selected Selected Indeterminate
Description
Return current state of checkbox.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cxSetCheck()Source code  |  | Improve this doc

Syntax
wvw_cxSetCheck( <nWinNum>, <nCXId>, <nCheckState> )
Arguments
nWinNum Window number. Default is current window. nCXId ID of checkbox. nCheckState 0 1 2 Not selected Selected Indeterminate
Returns
Always .T.
Description
Assign check-state of checkbox.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cxSetCodeblock()Source code  |  | Improve this doc

Syntax
wvw_cxSetCodeblock( <nWinNum>, <nCXId>, <bBlock> )
Arguments
nWinNum Window number. Default is current window. nCXId ID of checkbox. bBlock Code block
Returns
.T. if successful, .F. if failed.
Description
Assign a new code block to checkbox on current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_cxSetFocus()Source code  |  | Improve this doc

Syntax
wvw_cxSetFocus( <nWinNum>, <nCXId> )
Arguments
nWinNum Window number. Default is current window. nCXId ID of checkbox.
Returns
.T. if successful, .F. if failed.
Description
Set the focus to checkbox.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_CenterWindow()Source code  |  | Improve this doc

Syntax
wvw_CenterWindow( <nWinNum>, <lCenter>, <lPaint> )

See function wvw_SetWindowCentre().
Platforms
Available on all platforms
Tags
API, GTWVW

wvw_ChooseColor()Source code  |  | Improve this doc

Syntax
wvw_ChooseColor( <nRGBInit>, <aRGB16>, <nFlags> )
Arguments
nRGBInit Initial color. aRGB16 Array of 16 elements, with color index. Default is an array with color set of button. nFlags A set of bit flags that you can use to initialize the color common dialog box. When the dialog box returns, it sets these flags to indicate the user's input. Default is a combination of CC_ANYCOLOR | CC_RGBINIT | CC_FULLOPEN.
Returns
Contains the RGB color value of the color selected by the user, if the user clicks OK button of the dialog box.
Description
Open a color selection dialog.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_ChooseFont()Source code  |  | Improve this doc

Syntax
wvw_ChooseFont( <cFontName>, <nHeight>, <nWidth>, <nWeight>, <nQuality>, <lItalic>, <lUnderline>, <lStrikeout> )
Arguments
cFontName Name of the font. nHeight Height of the font's character. nWidth Specifies average width of character in the font. nWeight Specifies the weight of the font in the range 0 through 1000 (see About Fonts section) nQuality Specifies the output quality. lItalic Specifies an italic font if set to TRUE. lUnderline Specifies an underlined font if set to TRUE. lStrikeout Specifies a strikeout font if set to TRUE.
Returns
None.
Description
Creates a common font dialog box that enables the user to choose attributes for a logical font.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_ClientToScreen()Source code  |  | Improve this doc

Syntax
wvw_ClientToScreen( <nWinNum>, <nRow>, <nCol> )
Arguments
nWinNum Window number. Default is current window. nRow, nCol Row/Column in current windows to be converted.
Returns
Array with two positions with coordinates x,y.
Description
Converts row/column in current screen to coordinates x,y relative to screen.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_CreateDialogDynamic()Source code  |  | Improve this doc

Syntax
wvw_CreateDialogDynamic( <cDlgTemplate>|<nResource>, <lHandle>,
<cDlgProc>|<bDlgProc>|<nDlgProc>, <nFlag> )
Arguments
cDlgTemplate|nResource lHandle cDlgProc|<bDlgProc|nDlgProc> nFlag
Returns
Handle of dialog window or zero.
Description
Creates a dialog window dynamically.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_CreateDialogModal()Source code  |  | Improve this doc

Syntax
wvw_CreateDialogModal( <cDialog>|<nResource>|<cDlgTemplate>, NIL,
<bDlgProc>|<cDlgProc>, <nFlag>, <nHandle> )
Arguments
cDialog|<nResource|cDlgTemplate> bDlgProc|cDlgProc nFlag nHandle
Returns
Handle of dialog window or zero.
Description
Creates a modal dialog window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_CreateFont()Source code  |  | Improve this doc

Syntax
wvw_CreateFont( <cFontFace>, <nHeight>, <nWidth>, <nWeight>, <lItalic>,
<lUnderline>, <lStrikeout>, <nCharset>, <nQuality>, <nEscapement> )
Arguments
cFontFace Name of the font. nHeight Height of the font's character. nWidth Specifies average width of character in the font. nWeight Specifies the weight of the font in the range 0 through 1000 (see About Fonts section) lItalic Specifies an italic font if set to TRUE. lUnderline Specifies an underlined font if set to TRUE. lStrikeOut Specifies a strikeout font if set to TRUE. nCharSet Identify the character set. nQuality Specifies the output quality nEscapement Specifies the angle, in tenths of degrees, between the escapement vector and the x-axis of the device.
Returns
If successful, the return value is a handle to a logical font. If failed, return zero.
Description
creates a logical font that has the characteristics specified in the parameters. The font can subsequently be selected as the current font for any device context.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_CreateMenu()  |  | Improve this doc

Syntax
wvw_CreateMenu()
Arguments
None.
Returns
Handle of new created menu. If failed, returns NULL.
Description
Creates a menu. Initially, the menu is empty, but can be filled with items through function wvw_AppendMenu().
Platforms
Available on Windows
Tags
API, GTWVW

wvw_CreatePopupMenu()  |  | Improve this doc

Syntax
wvw_CreatePopupMenu()
Arguments
None.
Returns
Handle of new popup menu. If failed, return NULL.
Description
Creates a drop-down menu, submenu or shortcut menu. The menu is initially empty, but you can insert or append menu items by using the wvw_AppendMenu() function.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DeleteMenu()  |  | Improve this doc

Syntax
wvw_DeleteMenu( <hMenu>, <nPosition>, <nFlag> )
Arguments
hMenu Identifies the menu to be changed. nPosition Specifies a menu item to be changed. nFlag Specifies how nPosition will be interpreted. This parameter can be one of two values: MF_BYCOMMAND MF_BYPOSITION Indicates that nPosition gives the identifier of the menu item. The MF_BYCOMMAND flag is the default flag if neither the MF_BYCOMMAND nor MF_BYPOSITION flag is specified. Indicates that nPosition gives the zero-based relative position of the menu item.
Returns
If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.
Description
This function deletes an item from the specified menu. If the menu item opens a menu or submenu, this function destroys the handle to the menu or submenu and frees the memory used by the menu or submenu.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DestroyMenu()  |  | Improve this doc

Syntax
wvw_DestroyMenu( <hMenu> )
Arguments
hMenu Identifies the menu to be destroyed.
Returns
If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.
Description
This function deletes an item from the specified menu. If the menu item opens a menu or submenu, this function destroys the handle to the menu or submenu and frees the memory used by the menu or submenu.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DlgSetIcon()Source code  |  | Improve this doc

Syntax
wvw_DlgSetIcon( <nHandleDialog>, ncIcon )
Arguments
nHandleDialog Handle of dialog window. ncIcon If numeric, identifies a RESOURCE in a RC file. If string, identifies an icon file name.
Returns
If successful, icon handle. Otherwise, NIL.
Description
Defines an icon on a dialog window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawBoxGet()Source code  |  | Improve this doc

Syntax
wvw_DrawBoxGet( <nWinNum>, <nRow>, <nCol>, <nWidth>, <aOffset> )
Returns
Always .T.
Description
Draws a box to an input get. Unlike GTWVT, GTWVW draw white lines on outer right and outer bottom. Besides, scope is the same as DRAWBOXRECESSED, i.e., two pixel out of char boundary.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawBoxGroup()Source code  |  | Improve this doc

Syntax
wvw_DrawBoxGroup( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a box. aOffset Array of four elements with top/left and bottom/right corner coordinates to align the box with row/column.
Returns
Always .T.
Description
Draws a box.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawBoxRaised()Source code  |  | Improve this doc

Syntax
wvw_DrawBoxRaised( <nNumWin>, <nTop>, <nLeft>, <nBottom>, <nRight>, <lTight>/<aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a box. lTight/aOffset If lTight, box is draw inside the character region and top and left lines are lower two pixel down to make room for above/left object. If aOffset, an array of four elements is defined with coordinates top, left, bottom right to align box with row/column.
Returns
Always .T.
Description
Draws a raised box.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawBoxRecessed()Source code  |  | Improve this doc

Syntax
wvw_DrawBoxRecessed( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <lTight>/<aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a box. lTight/aOffset If lTight, box is drawn inside the character region and top and left lines are lower two pixel down to make room for above/left object. If aOffset, an array of four elements is defined with coordinates top, left, bottom right to align box with row/column.
Returns
Always .T.
Description
Draws a recessed box.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawButton()Source code  |  | Improve this doc

Syntax
wvw_DrawButton( <nWinNum>, <nTop>, <nLEft>, <nBottom>, <nRight>, <cText>,
<cImage>/<nImage>, <nFormat>, <nTextColor>, <nBkClor>, <nImageAt> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nButtom, nRight> Coordinates to draws a button. cText Text of button. cImage/nImage If string, specifies a bitmap filename (full path is required). If numeric, specifies the position of image in application image cache. nFormat Specifies shape of button: 0 1 2 Raised (default) Recessed Outline
nTextColor Index to button's color. nBkColor Index of button's background color. nImageAt Ignored.
Returns
Always .T.
Description
Draws a button.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawColorRect()Source code  |  | Improve this doc

Syntax
wvw_DrawColorRect( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffPixels>,
<nRGBColor> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a rectangle. aOffPixels Array of four elements with top/left and bottom/right coordinates to align the rectangle with row/column. nRGBColor Color to fill the rectangle.
Returns
None.
Description
Draws a color rectangle. wvw_FillRectangle(). This function is for compatibility with GTWVT, similar to
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawEllipse()Source code  |  | Improve this doc

Syntax
wvw_DrawEllipse( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw an ellipse. aOffset Array of four elements with top/left and bottom/right coordinates to align the ellipse with row/column.
Returns
Returns a nonzero value, if successful, otherwise zero.
Description
Draws an ellipse.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawFocusRect()Source code  |  | Improve this doc

Syntax
wvw_DrawFocusRect( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffSet> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a rectangle. aOffset Array of four elements with top/left and bottom/right coordinates to align the rectangle with row/column.
Returns
Returns a nonzero value, if successful, otherwise zero.
Description
Draws a rectangle in a style to represent focus.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawGridHorz()Source code  |  | Improve this doc

Syntax
wvw_DrawGridHorz( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <nRows> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw horizontal grid. nRows Number of lines to horizontal grid.
Returns
Always .T.
Description
Draws a horizontal grid.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawGridVert()Source code  |  | Improve this doc

Syntax
wvw_DrawGridVert( <nWinNum>, <nTop>, <nBottom>, <aCols>, <nCols>, <aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, nBottom Initial/final line to draw vertical grid. aCols Array with sizes of columns to be draw. nCols Number of columns to be draw. aOffset Array of four row/column. elements with top/left, bottom/right offset to align vertical grid to
Returns
Always .T.
Description
Draws a vertical grid.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawImage()Source code  |  | Improve this doc

Syntax
wvw_DrawImage( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>,
<cImage>/<nPictureSlot>, <lTight>/<aOffset>, <lTransparent> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw an image. If nBottom is NIL, so image's height will be proportional to image's width. If nRight is NIL, so image's width will be proportional to image's height. If both nBottom and nRight are NIL, so original size of image will be used. cImage/nPictureSlot If string, an image will be read from cImage (full path). If numeric, will an index in an image list (previously loaded by application). WARNING: this function will always cache the image. Do not use it to draw large number of images, because image handle is never closed. lTight/aOffset Specifies how image will be adjusted (in pixels) to row/column coordinates. lTransparent If .T., specifies a transparent image, otherwise .F. If .T., transparency color will be the top left corner pixel.
Returns
.T. if successful (draws an image), .F. otherwise.
Description
Draws an image.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawLabel()Source code  |  | Improve this doc

Syntax
wvw_DrawLabel( <nWinNum>, <nRow>, <nCol>, <cLabel>, <nAlign>, <nEscapement>,
<nTextColor>, <nBkColor>, <cFontFace>, <nHeight>, <nWidth>, <nWeight>,
<nQuality>, <nCharSet>, <lItalic>, <lUnderline>, <lStrikeOut> )
Arguments
nWinNum Window number. Default is current window. nRow, nCol Row/column to draw a label. cLabel String to be draw. nAlign String alignment. Default is TA_LEFT (another definitions: see file wingdi.ch). nEscapement Specifies angle. nTextColor Color index of label. nBkColor Color index of background of label. cFontFace Name of the font. nHeight Height of the font's character. nWidth Specifies average width of character in the font. nWeight Specifies the weight of the font in the range 0 through 1000 (see About Fonts section). nQuality Specifies the output quality.
nCharSet Specifies set of characters to be used. lItalic Specifies an italic font if set to TRUE. lUnderline Specifies an underline font if set to TRUE. lStrikeOut Specifies a strikeout font if set to TRUE.
Returns
.T. if successful, .F. otherwise.
Description
Draws a label.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawLabelEx()Source code  |  | Improve this doc

Syntax
wvw_DrawLabelEx( <nWinNum>, <nRow>, <nCol>, <cLabel>, <nAlign>, <cTextColor>, <nBkColor>,
<nSlotFont> )
Arguments
nWinNum Window number. Default is current window. nRow, nCol Row/column to draw a label. cLabel String to be draw. nAlign Text alignment. Default is TA_LEFT (see wingdi.ch to another definitions). cTextColor Index color of the font. nBkColor Index color of label background. nSlotFont Index of application cache fonts. If image cache is empty (or index does not exist), function will be not executed.
Returns
.T. if successful (draws a label), .F. otherwise (returns .F. if nSlotFont invalid).
Description
Draws a label.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawLabelObj()Source code  |  | Improve this doc

Syntax
wvw_DrawLabelObj( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <cLabel>,
<nAlignHorz>, <nAlignVert>, <nTextColor>, <nBkColor>, <hFont>, <aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a label. cLabel String to be draw. nAlignHorz Horizontal align of the label. Default is zero. nAlignVert Vertical align. Default is zero. nTextColor Index color of the label. nBkColor Index background color of the label. hFont Specifies which font will be used to draw a label. aOffSet String of four elements to align label with coordinates nTop, <nLeft, nBottom, nRight>.
Returns
Always .T.
Description
Draws a label.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawLine()Source code  |  | Improve this doc

Syntax
wvw_DrawLine( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <nOrient>,
<nFormat>, <nAlign>, <nStyle>, <nThick>, <nColor>, <aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a line. nOrient Line orientation: 0 1 Horizontal Vertical
nFormat Line format: 0 1 2 Raised Recessed Plain
nAlign Line alignment: 0 1 2 3 4 Center Top Bottom Left Right
nStyle Specifies pen style. See wingdi.ch (PS_SOLID, PS_DOT, etc.). nThick Specifies the width of the pen, in logical units. If zero, the pen is a single pixel wide, regardless of the current transformation. Default is zero (width of one pixel). nColor Specifies a color reference for the pen color ( a 32-bit value from RGB color). aOffset Array of four row/column. elements with top/left, bottom/right of coordinates to align line with
Returns
Always .T.
Description
Draws a line.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawLineEx()Source code  |  | Improve this doc

Syntax
wvw_DrawLineEx( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <nOrient>, <nFormat>,
<nAlign>, <nSlotPen> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a line. nOrient Line orientation: 0 1 Horizontal Vertical
nFormat Line format: 0 1 2 Raised Recessed Plain
nAlign Line alignment: 0 1 2 3 4 Center Top Bottom Left Right
nSlotPen Index on pen's cache.
Returns
Always .T.
Description
Draws a line (using an index of pen's cache).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawMenuBar()Source code  |  | Improve this doc

Syntax
wvw_DrawMenuBar()
Arguments
None.
Returns
None.
Description
This function repaint the menu bar of the current window. If the menu bar changes after Windows has created the window, this function must be called to repaint the changed menu bar.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawOutline()Source code  |  | Improve this doc

Syntax
wvw_DrawOutline( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <nThick>, <nShape>,
<nRGBColor> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a box. nThick Style of pen. See wingdi.ch file for definitions (PS_SOLID, PS_DOT, etc.). nShape Ignored. nRGBColor Specifies color reference for pen (a 32-bit RGB color value).
Returns
Always .T.
Description
Draws a outline arguments. box in nTop, <nLeft, nBottom, nRight> coordinates, with style and color
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawOutlineEx()Source code  |  | Improve this doc

Syntax
wvw_DrawOutlineEx( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <nSlotPen> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a box. nSlotPen Index on pen's cache.
Returns
None.
Description
Draws an outlined box (using an index of pen's cache).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawPicture()Source code  |  | Improve this doc

Syntax
wvw_DrawPicture( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <nSlot>, <lTight>/<aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw an image. nSlot index on image's cache. lTight/aOffset Array with four row/column. elements with top/left, bottom/right coordinates to align image with
Returns
None.
Description
Draws an image, saving in a cache if images.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawProgressBar()Source code  |  | Improve this doc

Syntax
wvw_DrawProgressBar( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>,
<aOffPixels>, <nPercent>, <nBackColor>, <nBarColor>, <cImage>, <lVertical>,
<nDirection> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a progress bar. aOffPixels Array with four elements with top/left, bottom/right coordinates to align progress bar with row/column. nPercent Maximum range value. nBackColor Background color. nBarColor Progress bar color. cImage An image to show when progress bar is running. lVertical Specifies if progress bar is vertical (.T.) or horizontal (.F.). nDirection 0 Specifies a left to right progress bar (default) 1 Specifies a right to left progress bar
Returns
None.
Description
Draws a progress bar.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawRectangle()Source code  |  | Improve this doc

Syntax
wvw_DrawRectangle( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffset> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a rectangle. aOffset Array with four elements with top/left, bottom/right coordinates to align rectangle with row/column.
Returns
If successful returns a non-zero value, otherwise zero.
Description
Draws a rectangle.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawRoundRect()Source code  |  | Improve this doc

Syntax
wvw_DrawRoundRect( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffset>,
<nRoundHeight>, <nRoundWidth> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a rectangle. aOffset Array with four elements with top/left, bottom/right coordinates to align rectangle with row/column. nRoundHeight Width of ellipse to round rectangle's corner. nRoundWidth Height of ellipse to round rectangle's corner.
Returns
If successful returns a non-zero value, otherwise zero.
Description
Draws a rectangle with rounded corners.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawScrollButton()Source code  |  | Improve this doc

Syntax
wvw_DrawScrollButton( <nWinNum>, <nTop>, <nLeft>, <nBotton>, <nRight>, <aOffPixels>,
<nTLBR>, <lDepressed> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a scrollbutton. aOffPixels Array with four elements with top/left, bottom/right coordinates to align scrollbutton with row/column. nTLBR Specifies scrollbutton direction: 1 2 3 4 Up arrow button Left arrow button Bottom arrow button Right arrow button
lDepressed If .F., specifies raised button, .T. recessed button.
Returns
None.
Description
Draws a scrollbutton. With functions wvw_xb*(), this function becomes obsolete.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawScrollThumbHorz()Source code  |  | Improve this doc

Syntax
wvw_DrawScrollThumbHorz( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffPixels>,
<nThumbPos> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw scrollbar movement button. aOffPixels Array of four elements with top/left, bottom/right coordinates to align scrollbar movement button with row/column. nThumbPos Initial column position.
Returns
None.
Description
Draws a horizontal obsolete. scrollbar button. With functions wvw_xb*(), this function becomes
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawScrollThumbVert()Source code  |  | Improve this doc

Syntax
wvw_DrawScrollThumbVert( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffPixels>,
<nThumbPos> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw scrollbar movement button. aOffPixels Array of four elements with top/left, bottom/right coordinates to align scrollbar movement button with row/column. nThumbPos Initial line position.
Returns
None.
Description
Draws a vertical obsolete. scrollbar button. With functions wvw_xb*(), this function becomes
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawShadedRect()Source code  |  | Improve this doc

Syntax
wvw_DrawShadedRect( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffPixels>, <nHorVert>, <aRGBb>, <aRGBe> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw a rectangle. aOffPixels Array of four elements with top/left, bottom/right coordinates to align rectangle with row/column. nHorVert Specifies draws method and how to interpret rectangle fill array ( aRGBb and aRGBe). Default is GRADIENT_FILL_RECT_H (see wingdi.ch file for all definitions). aRGBb Array of four color position (Red, Green, Blue, Alpha), with initial rectangle position. aRGBe Array of four color position (Red, Green, Blue, Alpha), with final rectangle position.
Returns
.T. if successful, otherwise .F.
Description
Draws a rectangle in specified coordinates, with gradient filling colors, varying from aRGBb to aRGBe.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawStatusBar()Source code  |  | Improve this doc

Syntax
wvw_DrawStatusBar( <nWinNum>, <nPanels>, <aPos> )
Arguments
nWinNum Window number. Default is current window. nPanels Number of parts in a status bar. aPos Array with row/column positions to divide status bar.
Returns
None.
Description
Draws a status bar. Only for compatibility with GTWVT. wvw_sb*() functions are recommended instead.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawTextBox()Source code  |  | Improve this doc

Syntax
wvw_DrawTextBox( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffPixels>,
<cText>, <nAlignHorz>, <nAlignVert>, <nTextColor>, <nBackColor>, <nBackMode>,
<hFont> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw text. aOffPixels Array of four row/column. cText Text to be draw. nAlignHorz Specifies text alignment inside coordinates: 0 1 2 Left (default) Right Centralized elements with top/left, bottom/right coordinates to align text with
nAlignVert Ignored. nTextColor Color of text. nBackColor Background color. nBackMode Background mode how color is used. Default is OPAQUE (see wingdi.ch for all definitions). hFont Font of the text.
Returns
None.
Description
Draws a text in a rectangle.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_DrawToolButtonState()Source code  |  | Improve this doc

Syntax
wvw_DrawToolButtonState( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffPixels>,
<nState> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw toolbutton. aOffPixels Array of four elements with top/left, bottom/right coordinates to align toolbutton with row/column. nState Button state: 0 1 2 Flat Raised Recessed
Returns
Always .T.
Description
Draws a toolbutton.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_EnableMaximize()Source code  |  | Improve this doc

Syntax
wvw_EnableMaximize( <nWinNum>, <lEnable> )
Arguments
nWinNum Window number. Default is current window. lEnable If .T., enable maximize button, .F. disable.
Returns
Old maximize box state, before applying the new style.
Description
Read/Set maximize button. In order to enable MAXIMIZE button, app should have WVW_SIZE() callback function.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_EnableMenuItem()  |  | Improve this doc

Syntax
wvw_EnableMenuItem( <hMenu>, <nPosition>, <nFlag> )
Arguments
hMenu ID of menu. nPosition Specifies position of item to be enabled/disabled (see nFlag argument). nFlag For Harbour, in practice, we should define only two values: MF_DISABLE MF_ENABLE Specifies item to be disabled. Specifies item to be enabled.
Returns
Returns old configuration of menu item. If menu item is invalid, returns zero.
Description
Enable/Disable menu item.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_EnableShortcuts()Source code  |  | Improve this doc

Syntax
wvw_EnableShortcuts( <nWinNum>, <lEnable> )
Arguments
nWinNum Window number. Default is current window. lEnable If .T., enable shortcut keys. .F. disable shortcut keys.
Returns
Returns old configuration.
Description
Specifies if shortcut keys are enabled/disabled to access menu item or system menu.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_FillRectangle()Source code  |  | Improve this doc

Syntax
wvw_FillRectangle( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>,
<nRGBColor>/<hBrush>, <lTight>, <lUseBrush> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to fill a rectangle. nRGBColor/hBrush Rectangle filling color (a 32-bit value with RGB color). lTight Filling pattern will be adjusted in all coordinates area. lUseBrush If .T., nRGBColor/hBrush argument is interpreted as a handle to a pen model. Otherwise, is used as a RGB color.
Returns
Always .T.
Description
Fills a rectangle using a color or a pen model.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetClipboard()Source code  |  | Improve this doc

Syntax
wvw_GetClipboard()
Arguments
None.
Returns
Data from the clipboard.
Description
Retrieves data from the clipboard.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetCursorPos()Source code  |  | Improve this doc

Syntax
wvw_GetCursorPos()
Arguments
None.
Returns
Array of two elements, respectively, X coordinate and Y coordinate.
Description
Retrieves mouse coordinates.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetFontInfo()Source code  |  | Improve this doc

Syntax
wvw_GetFontInfo()
Arguments
None.
Returns
Array of seven elements: 1 2 3 4 5 6 7 cFontFace cFontHeight nFontWidth nFontWeight cFontQuality PTEXTSIZE->x PTEXESIZE->y Name Height Width Weight Quality Font's width in pixels Font's size in pixels
Description
Retrieves current font data.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetLastMenuEvent()Source code  |  | Improve this doc

Syntax
wvw_GetLastMenuEvent()
Arguments
None.
Returns
Last selected item or zero, if no item is selected previously.
Description
Reads the last item selected (always on current window).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetMenu()Source code  |  | Improve this doc

Syntax
wvw_GetMenu()
Arguments
None.
Returns
Menu handle.
Description
Gets the handle of current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetPaintRect()Source code  |  | Improve this doc

Syntax
wvw_GetPaintRect( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
Returns array of paint pending rect { top, left, bottom, right }. Warning: unlike WVT, top maybe > bottom or left maybe > right. in these cases, no paint request is pending (in WVT these is reflected in { 0, 0, 0, 0 }).
Description
Gets coordinates of screen with pending paint.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetPalette()Source code  |  | Improve this doc

Syntax
wvw_GetPalette()
Arguments
None.
Returns
Array of 16 elements, each element represent a color.
Description
Get color palette.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetRGBColor()Source code  |  | Improve this doc

Syntax
wvw_GetRGBColor( <nColor> )
Arguments
nColor Color index (as defined in CA-Cl*pper).
Returns
Returns a RGB color value.
Description
Reads an index RGB color value for nColor argument.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetRowColFromXY()Source code  |  | Improve this doc

Syntax
wvw_GetRowColFromXY( <nWinNum>, nX, nY )
Arguments
nWinNum Window number. Default is current window. nX X coordinate in pixels. nY Y coordinate in pixels.
Returns
Array of two elements: row and column.
Description
Convert X,Y coordinates (in pixels) to row and column.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetScreenHeight()Source code  |  | Improve this doc

Syntax
wvw_GetScreenHeight()
Arguments
None.
Returns
Screen height, in pixels.
Description
Reads screen height, in pixels.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetScreenWidth()Source code  |  | Improve this doc

Syntax
wvw_GetScreenWidth()
Arguments
None.
Returns
Screen width, in pixels.
Description
Reads screen width, in pixels.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetTitle()Source code  |  | Improve this doc

Syntax
wvw_GetTitle()
Arguments
None.
Returns
Window current title.
Description
Reads current window title.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetToolTipBkColor()Source code  |  | Improve this doc

Syntax
wvw_GetToolTipBkColor()
Arguments
None.
Returns
Index RGB background color of tooltip.
Description
Gets background color of tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetToolTipTextColor()Source code  |  | Improve this doc

Syntax
wvw_GetToolTipTextColor()
Arguments
None.
Returns
Index RGB text color of tooltip.
Description
Gets text color of tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetToolTipWidth()Source code  |  | Improve this doc

Syntax
wvw_GetToolTipWidth()
Arguments
None.
Returns
Tooltip width.
Description
Gets width of tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetWindowHandle()Source code  |  | Improve this doc

Syntax
wvw_GetWindowHandle()
Arguments
None.
Returns
Window handle.
Description
Gets handle of current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_GetXYFromRowCol()Source code  |  | Improve this doc

Syntax
wvw_GetXYFromRowCol( <nWinNum>, <nRow>, <nCol> )
Arguments
nWinNum Window number. Default is current window. nRow Line number. nCol Column number.
Returns
Array of two elements: X coordinate and Y coordinate.
Description
Convert row and column to X,Y coordinates (in pixels).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_InvalidateRect()Source code  |  | Improve this doc

Syntax
wvw_InvalidateRect()
Arguments
None.
Returns
None.
Description
Invalidate current window, forcing a new painting.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_IsLButtonPressed()Source code  |  | Improve this doc

Syntax
wvw_IsLButtonPressed()
Arguments
None.
Returns
.T. button pressed. .F. button released.
Description
Verify if left mouse button is pressed.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_KillTimer()Source code  |  | Improve this doc

Syntax
wvw_KillTimer( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
.T. if successful, .F. otherwise.
Description
Cancels timer event on current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_lbAddString()Source code  |  | Improve this doc

Syntax
wvw_lbAddString( <nHandleDialog>, <nIDListBox>, <cItem> )
Arguments
nHandleDialog Handle of dialog window. nIDListBox ID of listbox. cItem Item to add in listbox.
Returns
None.
Description
Adds an item in listbox.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_lbSetCurSel()Source code  |  | Improve this doc

Syntax
wvw_lbSetCurSel( <nHandleDialog>, <nIDListBox>, <nItem> )
Arguments
nHandleDialog Handle of dialog window. nIDListBox ID of listbox. nItem Item index (start from zero).
Returns
None.
Description
Selects an item in listbox.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_lCloseWindow()Source code  |  | Improve this doc

Syntax
wvw_lCloseWindow()
Arguments
None.
Returns
.T. if successful.
Description
Closes the last/topmost window
Platforms
Available on Windows
Tags
API, GTWVW

wvw_LoadFont()Source code  |  | Improve this doc

Syntax
wvw_LoadFont( <nSlotFont>, <cFontName>, <nHeight>, <nWidth>, <nWeight>,
<lItalic>, <lUnderline>, <lStrikeout>, <nCharSet>, <nQuality>, <nEscapement> )
Arguments
nSlotFont Index of font cache. cFontName Name of the font. nHeight Height of the font's character. nWidth Specifies average width of character in the font. nWeight Specifies the weight of the font in the range 0 through 1000 (see About Fonts section). lItalic Specifies an italic font if set to TRUE. lUnderline Specifies an underlined font if set to TRUE. lStrikeout Specifies a strikeout font if set to TRUE. nCharSet Identify the character set. For example, ANSI_CHARSET, DEFAULT_CHARSET, OEM_CHARSET, etc. (all models can be viewed in file wingdi.ch). nQuality Specifies the output quality. nEscapement Angle of escapement of the font.
Returns
None.
Description
Load all information about the specified font, writing it in font cache.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_LoadPen()Source code  |  | Improve this doc

Syntax
wvw_LoadPen( <nSlot>, <nStyle>, <nWidth>, <nRGBColor> )
Arguments
nSlot Index of cache of pen, defined by the user. nStyle Style of the pen. nWidth Specifies the width of the pen, in logical units. If nWidth is zero, the pen is a single pixel wide, regardless of the current transformation. nRGBColor Specifies a color reference for the pen color.
Returns
Returns .T. if read and write of definition is OK, .F. otherwise.
Description
Load definition of the pen (style, width and color) to a cache of pen.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_LoadPicture()Source code  |  | Improve this doc

Syntax
wvw_LoadPicture( <nSlot>, <cFilePicture> )
Arguments
nSlot Position of the cache where the image will be loaded. If there is any image in this position, will be replaced. cFilePicture Image to be loaded in the cache.
Returns
.T. if successful, .F. otherwise.
Description
Load an image in cache of images. Please, read an observation about cache of images, in the introduction.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_Maximize()Source code  |  | Improve this doc

Syntax
wvw_Maximize( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
None.
Description
Maximize current window (argument nWinNum is ignored). If application define a callback function WVW_SIZE() the window will be maximized, otherwise, only restores window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_MaxMaxCol()Source code  |  | Improve this doc

Syntax
wvw_MaxMaxCol( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
Maximum number of columns.
Description
Returns maximum nWinNum. possible MaxCol() in current screen setting for font used by window
Platforms
Available on Windows
Tags
API, GTWVW

wvw_MaxMaxRow()Source code  |  | Improve this doc

Syntax
wvw_MaxMaxRow( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
Maximum number of rows.
Description
Returns maximum nWinNum. possible MaxRow() in current screen setting for font used by window
Platforms
Available on Windows
Tags
API, GTWVW

wvw_MessageBox()Source code  |  | Improve this doc

Syntax
wvw_MessageBox( <nWinNum>, <cMessage>, <cTitle>, <nOption> )
Arguments
nWinNum Window number. Default is current window. cMessage Message to be displayed. cTitle Dialog box title. nOption Specifies a set of buttons that determine the contents and behavior of the dialog box. Default is MB_OK ( OK button, without icons). You can see all definitions in file winuser.ch.
Returns
Number of selected option (IDOK to OK button, IDCANCEL to Cancel button, etc.) You can see all definitions in file winuser.ch
Description
Creates, displays, and operates a message box. The message box contains an application defined message and title, plus any combination of predefined icons and push buttons.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_Minimize()Source code  |  | Improve this doc

Syntax
wvw_Minimize()
Arguments
None.
Returns
None.
Description
Minimizes current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_nColOfs()Source code  |  | Improve this doc

Syntax
wvw_nColOfs( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
Number of offset columns.
Description
Returns column offset of window nWinNum (0 == MAIN), relative to Main Window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_nNumWindows()Source code  |  | Improve this doc

Syntax
wvw_nNumWindows()
Arguments
None.
Returns
Number of opened windows.
Description
Returns number of windows opened (including main window).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_nOpenWindow()Source code  |  | Improve this doc

Syntax
wvw_nOpenWindow( <cWinName>, row1, col1, row2, col2, <nStyle>, <nParentWin>,
<nExStyle> )
Arguments
cWinName Title of window. If omitted, the name of executable will be used. row1, col1, row2, col2 Specifies initial row/column and final row/column of the window coordinates are relative to main window, not to current window. This coordinates are used to: 1) Put window in initial position. 2) Determine size of the window (new MaxRow() and MaxCol()). 3) Save in RowOfs and ColOfs to MainCoord mode. nStyle Style of the window. All definitions are in file winuser.ch. Default is WS_CAPTION|WS_SYSMENU|WS_CLIPCHILDREN. If you will use controls such as PUSHBUTTON, you MUST include WS_CLIPCHILDREN. nParentWin Is the mother of the new window. Default is current window (in Standard mode) and the last window (in MainCoord mode). If you want the new window to not have parent, pass -1 as argument. nExStyle Extended style to window (for example: WS_EX_TOOLTIPWINDOW). Default is NIL. Note: this parameter does not exist in original GTWVW to be opened. This
Returns
Number of window, if successful, zero if failed.
Description
Opens a window in specified coordinates. Depending of parameter in function wvw_NoStartupSubWindow() the window will be displayed or remains invisible ( until we call function wvw_ShowWindow()).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_nRowOfs()Source code  |  | Improve this doc

Syntax
wvw_nRowOfs( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
Number of offset rows.
Description
Returns row offset of window nWinNum (0==MAIN), relative to Main Window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_nSetCurWindow()Source code  |  | Improve this doc

Syntax
wvw_nSetCurWindow( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
Returns old current window.
Description
Assigns nWinNum as the new current window. Makes sense only if in StandardMode.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_NoClose()Source code  |  | Improve this doc

Syntax
wvw_NoClose( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
None.
Description
Disable close button in windows nWinNum.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_NoStartupSubWindow()Source code  |  | Improve this doc

Syntax
wvw_NoStartupSubWindow( <lOn> )
Arguments
lOn .T. when open window, will be displayed (default). .F. when open window, remains invisible.
Returns
Returns new configuration (if argument lOn is passed) or actual configuration.
Description
Informs to the system that the window, when created, will be displayed or remains invisible until we call function wvw_ShowWindow().
Platforms
Available on Windows
Tags
API, GTWVW

wvw_NumBMCache()Source code  |  | Improve this doc

Syntax
wvw_NumBMCache()
Arguments
None.
Returns
Returns current number of user-bitmap cache.
Description
Reads number of user-bitmap cache.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pbCreate()Source code  |  | Improve this doc

Syntax
wvw_pbCreate( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <cText>,
<cImage>/<nImage>, <bBlock>, <aOffset>, <nStretchBitmap>, <lMap3DColors> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to create the button. cText Text of the button. Default is "". cImage/nImage If specified as numeric, identify ID from Resource in a .RC file. If specified as string, must have a full path to an image file. bBlock Code block to be executed whenever a BN_CLICK event occurred (press and release the button). Always pass as a parameter: nWinNum and ID of button. aOffset Array of four row/column. elements with top/left, bottom/right coordinates to align button with
nStretchBitmap Number between 0 and 1 (inclusive) as a stretch factor: 1.0 0.5 0 The bitmap will cover all button. The bitmap will cover only 50% of the button. The bitmap will not be stretched.
Default is 1. lMap3DColors Specified if an image will be transparent (.T.) or not (.F.). This will work on 256 colored bitmaps only.
Returns
Returns the handle of the new pushbutton, if successful (or zero if failed).
Description
Creates a pushbutton in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pbDestroy()Source code  |  | Improve this doc

Syntax
wvw_pbDestroy( <nWinNum>, <nPBId> )
Arguments
nWinNum Window number. Default is current window. nPBId ID of the pushbutton.
Returns
None.
Description
Deletes a pushbutton of current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pbEnable()Source code  |  | Improve this doc

Syntax
wvw_pbEnable( <nWinNum>, <nPBId>, <lToggle> )
Arguments
nWinNum Window number. Default is current window. nPBId ID of the pushbutton. lToggle .T. Enable pushbutton (default). .F. Disable pushbutton.
Returns
Returns prior status of pushbutton, if lToggle is passed. Otherwise, returns actual status of pushbutton (.T. is enabled, .F. disabled).
Description
Enable/disable the pushbutton in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pbSetCodeblock()Source code  |  | Improve this doc

Syntax
wvw_pbSetCodeblock( <nWinNum>, <nPBId>, <bBlock> )
Arguments
nWinNum Window number. Default is current window. nPBId ID of the pushbutton. bBlock Code block.
Returns
.T. if successful, .F. otherwise.
Description
Assign a new code block to a pushbutton in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pbSetFocus()Source code  |  | Improve this doc

Syntax
wvw_pbSetFocus( <nWinNum>, <nPBId> )
Arguments
nWinNum Window number. Default is current window. nPBId ID of the pushbutton.
Returns
.T. if successful, .F. if failed.
Description
Set focus to pushbutton to current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pbSetFont()Source code  |  | Improve this doc

Syntax
wvw_pbSetFont( <nWinNum>, <cFontFace>, <nHeight>, <nWidth>, <nWeight>,
<nQuality>, <lItalic>, <lUnderline>, <lStrikeout> )
Arguments
nWinNum Window number. Default is current window. cFontName Name of the font. nHeight Height of the font's character. nWidth Specifies average width of character in the font. nWeight Specifies the weight of the font in the range 0 through 1000 (see About Fonts section). nQuality Specifies the output quality. lItalic Specifies an italic font if set to TRUE. lUnderline Specifies an underlined font if set to TRUE. lStrikeout Specifies a strikeout font if set to TRUE.
Returns
.T. if successful, .F. if failed.
Description
This function will initialize font for ALL pushbuttons in window nWinNum, including ones created later on.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pbSetStyle()Source code  |  | Improve this doc

Syntax
wvw_pbSetStyle( <nWinNum>, <nPBId>, <nStyle> )
Arguments
nWinNum Window number. Default is current window. nPBId ID of pushbutton. nStyle Define style of pushbutton. You can see all possibilities BS_PUSHBUTTON, BS_DEFPUSHBUTTON, etc.). Typical usage: BS_DEFPUSHBUTTON BS_PUSHBUTTON in file winuser.ch (
1: Turn the button into default button (thick border) 0: Turn the button into regular pushbutton
Returns
Always .T.
Description
Assign new style to button in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pgCreate()Source code  |  | Improve this doc

Syntax
wvw_pgCreate( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aOffset>,
<nBackColor>, <nBarColor>, <lSmooth>, <lVertical> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to create a progress bar. aOffset Array of four elements with top/left, bottom/right coordinates to align progress bar with row/column. nBackColor Background color. nBarColor Progress bar color. lSmooth .T. draw progress bar as a continuum bar .F. draw progress bar with tiny distinct rectangles (default) lVertical .T. draw as vertical progress bar .F. draw as horizontal progress bar (default)
Returns
Progress bar handle, if successful. Zero if failed.
Description
Create progress bar for current window. Progress bar range is initially set as 0 to 100, start from 0.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pgDestroy()Source code  |  | Improve this doc

Syntax
wvw_pgDestroy( <nWinNum>, <nPGId> )
Arguments
nWinNum Window number. Default is current window. nPGId ID of progress bar.
Returns
None.
Description
Delete a progress bar for current window
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pgGetPos()Source code  |  | Improve this doc

Syntax
wvw_pgGetPos( <nWinNum>, <nPGId> )
Arguments
nWinNum Window number. Default is current window. nPGId ID of progress bar.
Returns
Returns 0 if operation failed, otherwise return progress bar position.
Description
Get progress bar current position.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_pgSetPos()Source code  |  | Improve this doc

Syntax
wvw_pgSetPos( <nWinNum>, <nPGId>, <nPos> )
Arguments
nWinNum Window number. Default is current window. nPGId ID of progress bar. nPos A number in range of current range.
Returns
Returns .T. if operation considered successful, otherwise .F.
Description
Update progress bar position within current range.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_PasteFromClipboard()Source code  |  | Improve this doc

Syntax
wvw_PasteFromClipboard()
Arguments
None.
Returns
None.
Description
Paste text from Clipboard.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_ProcessMessages()Source code  |  | Improve this doc

Syntax
wvw_ProcessMessages( <nWinNum> )
Arguments
nWinNum Window number. Default is current window. NOTE: Despite the parameter, the following will actually process messages for all windows
Returns
None (actually, returns number 1, with no use).
Description
Process messages for all windows.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_Restore()Source code  |  | Improve this doc

Syntax
wvw_Restore( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
None.
Description
Restores the window (nWinNum is ignored). Restoring window from its maximized state might need handling in callback function WVW_SIZE(), because this function assumes no change in MaxRow()/MaxCol().
Platforms
Available on Windows
Tags
API, GTWVW

wvw_RestScreen()Source code  |  | Improve this doc

Syntax
wvw_RestScreen( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <aScr>, <lDoNotDestroyBMP> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Screen coordinates to display data saved by function wvw_SaveScreen(). aScr Array with three elements (height, width and handle of bitmap). lDoNotDestroyBMP If .T., after restore screen, delete the bitmap used to save screen. If .F., the bitmap will not be erased. (default)
Returns
.T. if successful, .F. otherwise.
Description
Restores screen, saved by function wvw_SaveScreen().
Platforms
Available on Windows
Tags
API, GTWVW

wvw_sbAddPart()Source code  |  | Improve this doc

Syntax
wvw_sbAddPart( <nWinNum>, <cMaxText>, <nWidth>, <nStyle>, <lResetParts>, <cIcon>, <cTooltip> )
Arguments
nWinNum Window number. Default is current window. cMaxText If present, the width of status bar will be the width of this text. nWidth Width of status bar part. Ignored, if cMaxText is passed. nStyle Style of status bar: 0 0x100 0x200 Recessed (default) No borders Raised
lResetParts If .T., remove all previously created parts. If .F., a new status bar part will be created and added to previous parts. cIcon/cTooltip Ignored.
Returns
Returns number of parts, if successful. Zero if failed.
Description
Adds a new division in a status cMaxText/nWidth and nStyle. bar, with width and style specified in arguments
Platforms
Available on Windows
Tags
API, GTWVW

wvw_sbCreate()Source code  |  | Improve this doc

Syntax
wvw_sbCreate( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
Handle to status bar of current window. Zero if failed, e.g. if there is already a status bar for this window.
Description
Create status bar for current window, with one part.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_sbDestroy()Source code  |  | Improve this doc

Syntax
wvw_sbDestroy( <nWinNum> )
Arguments
nWinNum Window number. Default is current window.
Returns
None.
Description
Destroy status bar, forcing the window to be draw again.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_sbGetParts()Source code  |  | Improve this doc

Syntax
wvw_sbGetParts()
Arguments
None.
Returns
Number of parts in status bar.
Description
Get number of parts in status bar of current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_sbGetText()Source code  |  | Improve this doc

Syntax
wvw_sbGetText( <nWinNum>, <nPart> )
Arguments
nWinNum Window number. Default is current window. nPart Number of part in status bar.
Returns
Text from nPart in status bar.
Description
Get text of status bar's part nPart.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_sbRefresh()Source code  |  | Improve this doc

Syntax
wvw_sbRefresh()
Arguments
None.
Returns
Number of parts in status bar, if successful. Zero, otherwise.
Description
Reinitialize statusbar's parts, e.g. after window resize.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_sbSetText()Source code  |  | Improve this doc

Syntax
wvw_sbSetText( <nWinNum>, <nPart>, <cText> )
Arguments
nWinNum Window number. Default is current window. nPart Number of part in status bar. cText Text to be configured.
Returns
None.
Description
Set text of status bar's part nPart .
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SaveScreen()Source code  |  | Improve this doc

Syntax
wvw_SaveScreen( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Screen coordinates to save screen (always from current window, because argument nWinNum is ignored).
Returns
Array of three elements, with height, width and handle of the bitmap.
Description
Save a region of screen, writing in a bitmap file.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetAltF4Close()Source code  |  | Improve this doc

Syntax
wvw_SetAltF4Close( <lOn> )
Arguments
lOn .T. if application can be finished using Alt F4 key. .F. if application cannot be finished using Alt F4 key.
Returns
Old configuration.
Description
Identify if the application can be finished using Alt F4 key.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetAsNormal()Source code  |  | Improve this doc

Syntax
wvw_SetAsNormal()
Arguments
None.
Returns
.T. if successful, .F. otherwise.
Description
Returns window into normal state (opposing to function wvw_SetOnTop()).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetBrush()Source code  |  | Improve this doc

Syntax
wvw_SetBrush( <nStyle>, <nColor>, <nHatch> )
Arguments
nStyle Identify pen style. All definitions can be viewed in file wingdi.ch ( BS_SOLID, BS_NULL, etc.). nColor Index color to pen draw. nHatch Define the filling pattern of pen. All definitions can be viewed in file wingdi.ch ( HS_VERTICAL, HS_HORIZONTAL, etc.).
Returns
.T. if successful, .F. otherwise.
Description
Define style, color and pattern of pen filling.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetClipboard()Source code  |  | Improve this doc

Syntax
wvw_SetClipboard( <cText> )
Arguments
cText Text to be inserted in the clipboard.
Returns
.T. if successful, .F. otherwise.
Description
Sets text to the clipboard.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetCodepage()Source code  |  | Improve this doc

Syntax
wvw_SetCodepage( <nWinNum>, <nCodePage> )
Arguments
nWinNum Window number. Default is current window. nCodePage Sets the code page.
Returns
.T. if successful, .F. otherwise.
Description
Define code page for current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetDefCentreWindow()Source code  |  | Improve this doc

Syntax
wvw_SetDefCentreWindow( <lCentre> )
Arguments
lCentre If .T., config all newly opened windows, to be centralized horizontally and vertically.
Returns
If lCentre is configuration. passed, returns old configuration value, otherwise returns actual
Description
Read or set the parameter for centralization of windows.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetDefHCentreWindow()Source code  |  | Improve this doc

Syntax
wvw_SetDefHCentreWindow( <lCentre> )
Arguments
lCentre If .T., config all newly opened windows, to be centralized horizontally.
Returns
If lCentre is configuration. passed, returns old configuration value, otherwise returns actual
Description
Read or set the parameter for centralization of windows.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetDefLineSpacing()Source code  |  | Improve this doc

Syntax
wvw_SetDefLineSpacing( <nLineSpacing> )
Arguments
nLineSpacing Number of line spacing. Must be even, positive number <= 40, otherwise it will be ignored.
Returns
Old configuration.
Description
Sets line spacing for all windows.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetDefLSpaceColor()Source code  |  | Improve this doc

Syntax
wvw_SetDefLSpaceColor( <nColorIndex> )
Arguments
nColorIndex Index color to line spacing. Must be between 0 and 15, or ­1 meaning line spacing has no color.
Returns
Prior configuration, if nColorIndex is passed, otherwise actual configuration.
Description
Change color to line spacing.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetDefVCentreWindow()Source code  |  | Improve this doc

Syntax
wvw_SetDefVCentreWindow( <lCentre> )
Arguments
lCentre If .T., config all newly opened windows, to be centralized vertically.
Returns
If lCentre is configuration. passed, returns old configuration value, otherwise returns actual
Description
Read or set the parameter for centralization of windows.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetFont()Source code  |  | Improve this doc

Syntax
wvw_SetFont( <cFontFace>, <nFontHeight>, <nFontWidth>, <nFontWeight>, <nFontQuality> )
Arguments
cFontName Name of the font. (e.g., MS Sans Serif). nFontHeight Height of the font's character. nFontWidth Specifies average width of character in the font. nFontWeight Specifies the weight of the font in the range 0 through 1000 (see About Fonts section). nFontQuality Specifies the output quality. All arguments are optional. This function uses the values assigned in windows creation.
Returns
.T. if successful, .F. otherwise.
Description
Modify the font or the arguments related to the font (height, width, quality, etc.).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetIcon()Source code  |  | Improve this doc

Syntax
wvw_SetIcon( <nWinNum>, <nIcon>, <cIcon> )
Arguments
nWinNum Window number. Default is current window. nIcon Identify an icon in a resource file. cIcon Icon's file name.
Returns
.T. if successful, .F. otherwise.
Description
Set the icon for current window (argument nWinNum is ignored).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetLastMenuEvent()Source code  |  | Improve this doc

Syntax
wvw_SetLastMenuEvent( <nWinNum>, <nMenuEvent> )
Arguments
nWinNum Window number. Default is current window. nMenuEvent Menu's item.
Returns
Last valid configuration.
Description
Set the last selected item of the menu (returned from wvw_GetLastMenuEvent())
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetLineSpacing()Source code  |  | Improve this doc

Syntax
wvw_SetLineSpacing( <nWinNum>, <nLineSpacing> )
Arguments
nWinNum Window number. Default is current window. nLineSpacing If passed, change line spacing in current window, otherwise read actual configuration.
Returns
Returns old configuration, if nLineSpacing is passed, or actual configuration.
Description
Read/set line spacing for current window. If window size will become too high, line spacing is restored. To change default line spacing for next window open, use wvw_SetDefLineSpacing().
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetLSpaceColor()Source code  |  | Improve this doc

Syntax
wvw_SetLSpaceColor( <nWinNum>, <nColorIndex> )
Arguments
nWinNum Window number. Default is current window. nColorIndex Color index to line spacing. Must be between 0 and 15, or ­1, meaning has no color.
Returns
Returns old configuration, if nColorIndex is passed, otherwise actual configuration.
Description
Change color to line spacing for current window. To change default line space color for next window open, use wvw_SetDefLineSpacing().
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetMainCoord()Source code  |  | Improve this doc

Syntax
wvw_SetMainCoord( <lMainCoord> )
Arguments
lMainCoord If passed, change the display mode of windows. Otherwise, read actual configuration.
Returns
Actual configuration mode or old configuration, if lMainCoord is passed.
Description
Change the MainCoord). way of windows are displayed or read actual configuration (Standard or
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetMaxBMCache()Source code  |  | Improve this doc

Syntax
wvw_SetMaxBMCache( <nMaxCache> )
Arguments
nMaxCache Limit of cache bitmaps. Default is 20, minimum is 1.
Returns
Returns old setting of maximum user-bitmap cache.
Description
To minimize bitmap loading operation, wvw_DrawImage() caches bitmap once it reads from disk. I.e., subsequent wvw_drawimage will use the bitmap from the memory. When the maximum number of cache is used, the least recently opened bitmap will be discarded from the cache. There is no way to discard a specific bitmap from the cache. If you want to control bitmap caching manually, use wvw_LoadPicture() instead.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetMenu()Source code  |  | Improve this doc

Syntax
wvw_SetMenu( <nWinWin>, <hMenu> )
Arguments
nWinNum Window number. Default is current window. hMenu Contains menu information.
Returns
None.
Description
Adds a menu, pointed by hMenu, in current window. (argument nWinNum is ignored).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetMenuKeyEvent()Source code  |  | Improve this doc

Syntax
wvw_SetMenuKeyEvent( <nWinNum>, <nKeyEvent> )
Arguments
nWinNum Window number. Default is current window. nKeyEvent Number of event defined by the user to command menu of the window.
Returns
Last valid configuration.
Description
Defines a numeric event from menu, in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetMouseMove()Source code  |  | Improve this doc

Syntax
wvw_SetMouseMove( <nWinNum>, <lMouseMove> )
Arguments
nWinNum Window number. Default is current window. lMouseMove .T. recognize mouse in application .F. do not recognize mouse in application If not passed, returns actual configuration.
Returns
If passed lMouseMove, returns .T. to successful operation or .F. otherwise. If omitted, returns last valid configuration.
Description
Enable/disable mouse recognition by the application.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetMousePos()Source code  |  | Improve this doc

Syntax
wvw_SetMousePos( <nWinNum>, <nRow>, <nCol> )
Arguments
nWinNum Window number. Default is current window. nRow, nCol Row/Column to position mouse cursor.
Returns
.T. if successful, .F. otherwise.
Description
Position mouse cursor.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetOnTop()Source code  |  | Improve this doc

Syntax
wvw_SetOnTop()
Arguments
None.
Returns
.T. if successful, .F. otherwise.
Description
The window will be always visible, even if the focus is in another window. This function change properties of the window, thus it will be on top of any other opened window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetPaintRefresh()Source code  |  | Improve this doc

Syntax
wvw_SetPaintRefresh( <nPaintRefresh> )
Arguments
nPaintRefresh Interval in milliseconds to call WVW_PAINT(). Must be >= 50, or == 0, causing repaint to execute immediately.
Returns
Old setting value.
Description
Determine interval to calling WVW_PAINT() function, responsible to repaint screen.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetPalette()Source code  |  | Improve this doc

Syntax
wvw_SetPalette( <aRGBValues> )
Arguments
aRGBValues Array of 16 elements with RGB values.
Returns
None.
Description
Config color palette.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetPen()Source code  |  | Improve this doc

Syntax
wvw_SetPen( <nPenStyle>, <nWidth>, <nColor> )
Arguments
nPenStyle Defines pen style. All definition are in file wingdi.ch ( PS_SOLID, PS_DOT, etc.). nWidth Specifies width of the pen. nColor Index color of pen.
Returns
.T. if successful, .F. otherwise.
Description
Define style, width and color of pen.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetPointer()Source code  |  | Improve this doc

Syntax
wvw_SetPointer( <nWinNum>, <nIcon> )
Arguments
nWinNum Window number. Default is current window. nIcon Model of icon to be read. May be a string which identify a resource in a RC file or may be a predefined window model (default is IDC_ARROW). All definition are in winuser.ch file.
Returns
None.
Description
Change mouse cursor.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetPopupMenu()Source code  |  | Improve this doc

Syntax
wvw_SetPopupMenu( <nWinNum>, <hPopUp> )
Arguments
nWinNum Window number. Default is current window. hPopUp Include all information of a popup menu.
Returns
None.
Description
Config the popup menu for current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetTimer()Source code  |  | Improve this doc

Syntax
wvw_SetTimer( <nWinNum>, <nInterval> )
Arguments
nWinNum Window number. Default is current window. nInterval Interval, in milliseconds.
Returns
.T. if successful, .F. otherwise.
Description
Set timer event for every nInterval milliseconds (it can be useful to update clock on status bar). Effective only if WVW_TIMER() function exists
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetTitle()Source code  |  | Improve this doc

Syntax
wvw_SetTitle( <nWinNum>, <cTitle> )
Arguments
nWinNum Window number. Default is current window. cTitle Title of window.
Returns
None.
Description
Define title of current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetToolTip()Source code  |  | Improve this doc

Syntax
wvw_SetToolTip( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight>, <cToolText> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to show tooltip. cToolText Tooltip text.
Returns
None.
Description
Defines a tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetToolTipActive()Source code  |  | Improve this doc

Syntax
wvw_SetToolTipActive( <nWinNum>, <lToggle> )
Arguments
nWinNum Window number. Default is current window. lToggle .T. enable tooltip. .F. disable tooltip. If not passed, returns actual configuration.
Returns
Old configuration (if passed lToggle) or actual configuration.
Description
Enable/disable tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetToolTipBkColor()Source code  |  | Improve this doc

Syntax
wvw_SetToolTipBkColor( <nWinNum>, <nColor> )
Arguments
nWinNum Window number. Default is current window. nColor Color index of tooltip.
Returns
If not passed nColor, returns actual background color of tooltip, otherwise, sets the new color.
Description
Get/set a background color of tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetToolTipMargin()Source code  |  | Improve this doc

Syntax
wvw_SetToolTipMargin( <nWinNum>, <nTop>, <nLeft>, <nBottom>, <nRight> )
Arguments
nWinNum Window number. Default is current window. nTop, <nLeft, nBottom, nRight> Coordinates to draw tooltip.
Returns
None.
Description
Define the borders of tooltip. The border is the distance (in pixels) between window's border and text inside tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetToolTipText()Source code  |  | Improve this doc

Syntax
wvw_SetToolTipText( <nWinNum>, <cText> )
Arguments
nWinNum Window number. Default is current window. cText Text of tooltip.
Returns
None.
Description
Define text to tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetToolTipTextColor()Source code  |  | Improve this doc

Syntax
wvw_SetToolTipTextColor( <nWinNum>, <nColor> )
Arguments
nWinNum Window number. Default is current window. nColor Color index to text in tooltip.
Returns
If not passed nColor, returns actual color of text, otherwise, sets the new color.
Description
Define or get the color of text in tooltip.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetToolTipTitle()Source code  |  | Improve this doc

Syntax
wvw_SetToolTipTitle( <nWinNum>, <nIcon>, <cTitle> )
Arguments
nWinNum Window number. Default is current window. nIcon Identify if it will be displayed an icon with text in tooltip. Is allowed one of the following values: 0 1 2 3 no icon (default) information warning Error
any other value greater than 3, the GTWVW convert to 0.
Description
None.
Platforms
Available on all platforms
Tags
API, GTWVW

wvw_SetToolTipWidth()Source code  |  | Improve this doc

Syntax
wvw_SetToolTipWidth( <nWinNum>, <nWidth> )
Arguments
nWinNum Window number. Default is current window. nWidth Width of tooltip area.
Returns
If not passed nWidth, returns actual width of tooltip area, otherwise, sets the new width of tooltip area.
Description
Change or get the width of tooltip area.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetVertCaret()Source code  |  | Improve this doc

Syntax
wvw_SetVertCaret( <lOn> )
Arguments
lOn .T. turn caret into vertical caret .F. turn caret into horizontal caret
Returns
If passed lOn, returns old configuration. If not passed, returns actual configuration.
Description
Change caret of text.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetWindowCentre()Source code  |  | Improve this doc

Syntax
wvw_SetWindowCentre( <nWinNum>, <lCentre>, <lPaintIt> )
Arguments
nWinNum Window number. Default is current window. lCentre .T. centralize window .F. not centralize window lPaintIt .T. Repaint all windows immediate. .F. Just update configuration.
Returns
None.
Description
Update parameter to centralization of all opened windows (and newly opened). If passed lPaintIt and lCentre, all windows are repainted and centralized.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetWindowPos()Source code  |  | Improve this doc

Syntax
wvw_SetWindowPos( <nWinNum>, <nXPosition>, <nYPosition> )
Arguments
nWinNum Window number. Default is current window. nXPosition Horizontal position in pixels. nYPosition Vertical position in pixels.
Returns
None.
Description
Change position of current window, based in nXPosition and nYPosition coordinates.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_SetWinStyle()Source code  |  | Improve this doc

Syntax
wvw_SetWinStyle( <nWinNum>, <nStyle> )
Arguments
nWinNum Window number. Default is current window. nStyle New windows style. If the windows has any control (PUSHBUTTON, SCROLLBAR, etc.), must be added WS_CLIPCHILDREN style.
Returns
Returns old style of the window.
Description
Read or set style for window nWinNum. If windows is minimized or hidden, and if passed nStyle, the window will be showed.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_ShowWindow()Source code  |  | Improve this doc

Syntax
wvw_ShowWindow( <nWinNum>, <nMode> )
Arguments
nWinNum Window number. Default is current window. nMode Points out how window will be showed. Default is SW_SHOWNORMAL (another definitions in file winuser.ch).
Returns
None.
Description
Set the mode of showing window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_tbAddButton()Source code  |  | Improve this doc

Syntax
wvw_tbAddButton( <nWinNum>, <nCommand>, <xBitmap>, <cLabel>, <nBitmapType>, <lMap3DColors> )
Arguments
nWinNum Window number. Default is current window. nCommand ID of action to be executed when user press button. xBitmap ID of bitmap resource in .RC file (in this case, the image cannot have more than 256 colors) or full path to a file name. cLabel Text of button. If passed lDisplayText (in function wvw_tbCreate()) to .T., the text will be showed below image, otherwise will be used as a tooltip. nBitmapType Bitmap type. Can be: 0 1 2 3 Custom Standard windows bitmaps (COPY, PAST, FIND, OPEN, etc.) System view bitmaps System history bitmaps
lMap3DColors If the image will be transparent (meaningful for custom bitmap only).
Returns
Always .T.
Description
Adds one button on the right of existing buttons, in a toolbar.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_tbButtonCount()Source code  |  | Improve this doc

Syntax
wvw_tbButtonCount()
Arguments
None.
Returns
Number of buttons.
Description
Count the number of buttons in a toolbar.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_tbCmd2Index()Source code  |  | Improve this doc

Syntax
wvw_tbCmd2Index( <nWinNum>, <nCmd> )
Arguments
nWinNum Window number. Default is current window. nCmd ID of command to search (zero based).
Returns
Number of button or ­1, if failed.
Description
Read the number of button whose command ID is nCmd.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_tbCreate()Source code  |  | Improve this doc

Syntax
wvw_tbCreate( <nWinNum>, <lDisplayText>, <nStyle>, <nSystemBitmap>, <nImageWidth>,
<nImageHeight> )
Arguments
nWinNum Window number. Default is current window. lDIsplayText .T. Text of button will be showed with the image .F. Text will be showed as a tooltip ( default) nStyle Style of toolbar. Default is TBSTYLE_FLAT | TBSTYLE_TOOLTIPS (another definitions are in file commctrl.h). nSystemBitmap Points out if will be used Windows system bitmaps. Can be: 0 1 2 Do not use Windows system bitmaps Use Windows system bitmaps (small) Use Windows system bitmaps (large)
nImageWidth, nImageHeight Length and width of image (meaningful only if nSystemBitmap is zero).
Returns
Handle of toolbar, if successful. Zero if failed.
Description
Creates a toolbar on top of current window (with no button).
Platforms
Available on Windows
Tags
API, GTWVW

wvw_tbDelButton()Source code  |  | Improve this doc

Syntax
wvw_tbDelButton( <nWinNum>, <nButton> )
Arguments
nWinNum Window number. Default is current window. nButton Number of button do delete. The separator button count as a button, and can be deleted. This list is zero based.
Returns
.T. if successful, .F. otherwise.
Description
Delete a button in a toolbar.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_tbDestroy()Source code  |  | Improve this doc

Syntax
wvw_tbDestroy()
Arguments
None.
Returns
None.
Description
Delete a toolbar from current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_tbEnableButton()Source code  |  | Improve this doc

Syntax
wvw_tbEnableButton( <nWinNum>. <nButton>, <lToggle> )
Arguments
nWinNum Window number. Default is current window. nButton Number of button in a toolbar (zero based list). lToggle .T. Enable the button .F. Disable the button
Returns
.T. if successful, .F. otherwise.
Description
Enable/disable a button in a toolbar.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_tbIndex2Cmd()Source code  |  | Improve this doc

Syntax
wvw_tbIndex2Cmd( <nWinNum>, <nButton> )
Arguments
nWinNum Window number. Default is current window. nButton Number of button in a toolbar (zero based list).
Returns
Number of command ID, if successful, -1 if failed.
Description
Returns the ID assigned to the button.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_TrackPopupMenu()Source code  |  | Improve this doc

Syntax
wvw_TrackPopupMenu( <nWinNum>, <nHandle> )
Arguments
nWinNum Window number. Default is current window. nHandle Popup menu handle.
Returns
ID of selected option or zero if user cancels or an error occurs.
Description
Shows a menu in the cursor position.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_UnreachedBr()Source code  |  | Improve this doc

Syntax
wvw_UnreachedBr( <nWinNum>, <nBottomPixels>, <nRightPixels> )
Arguments
nWinNum Window number. Default is current window. nBottomPixels Passed by reference, to keep the number of lines (in pixels). nRightPixels Passed by reference, to keep the number of columns (in pixels).
Returns
Number of rows/columns in pixels.
Description
Read the number of pixels out of reach to lines and columns when window nWinNum is maximized.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_UpdateWindow()Source code  |  | Improve this doc

Syntax
wvw_UpdateWindow()
Arguments
None.
Returns
None.
Description
Update the window, repaint it.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_xbCreate()Source code  |  | Improve this doc

Syntax
wvw_xbCreate( <nWinNum>, <nStyle>, <nTop>, <nLeft>, <nLength>, <bBlock>, <aOffset> )
Arguments
nWinNum Window number. Default is current window. nStyle 0 Horizontal 1 Vertical nTop, nLeft Initial row/column of scrollbar (in characters). nLength Length of scrollbar (in characters). bBlock Code block to execute on every VM_VSCROLL/VM_HSCROLL. This code block will be evaluated with these parameters: nWinNum nXBid nXBmsg window number scrollbar ID scrollbar message. Can be divided in two categories:
The "must be handled" messages: SB_LINEUP/SB_LINELEFT SB_LINEDOWN/SB_LINERIGHT SB_PAGEUP/SB_PAGELEFT SB_PAGEDOWN/SB_PAGERIGHT 0: 1: 2: 3: up/left button clicked down/right button clicked upper/left shaft clicked lower/right shaft clicked
The "may not be handled" messages: SB_TUMBPOSITION SB_THUMBTRACK SB_ENDSCROLL nXBPos 4: scroll thumb is released at position nXBpos 5: scroll thumb is being dragged at position nXBpos 8: end of scroll
scrollthumb position (only if message = SB_THUMBPOSITION or SB_THUMBTRACK)
aOffset Array with four elements with top/left, bottom/right coordinates, in pixels, to adjust the dimensions of scrollbar.
Returns
Scrollbar handle, if successful. Zero if failed.
Description
Creates a scrollbar in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_xbDestroy()Source code  |  | Improve this doc

Syntax
wvw_xbDestroy( <nWinNum>, <nXBid> )
Arguments
nWinNum Window number. Default is current window. nXBId ID of scrollbar.
Returns
None.
Description
Delete the scrollbar in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_xbEnable()Source code  |  | Improve this doc

Syntax
wvw_xbEnable( <nWinNum>, <nXBid>, <nFlags> )
Arguments
nWinNum Window number. Default is current window. nXBId ID of scrollbar. nFlags The following values are allowed: 0 1 2 3 enable both arrows disable left/up arrow disable right/down arrow disable both arrow
Returns
.T. if successful, .F. otherwise.
Description
Enable/disable scrollbar in current window.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_xbInfo()Source code  |  | Improve this doc

Syntax
wvw_xbInfo( <nWinNum>, <nXBid> )
Arguments
nWinNum Window number. Default is current window. nXBId ID of scrollbar.
Returns
Array with five elements (if successful): nMin nMax nPageSize nPos nTrackPos Minimum positions to scrolling Maximum positions to scrolling Page size Position of scrolling button Exact position of the scrolling button, when the user beginning a drag-and-drop operation.
If failed, returns an empty array.
Description
Get information about scrollbar.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_xbUpdate()Source code  |  | Improve this doc

Syntax
wvw_xbUpdate( <nWinNum>, <nXBid>, <nPos>, <nPageSize>, <nMin>, <nMax> )
Arguments
nWinNum Window number. Default is current window. nXBId ID of scrollbar. nPos Specifies the position of scrolling button. nPageSize Page size. This value is used by scrollbar to determine the proportional size to page jump. nMin Minimum value to scrolling. nMax Maximum value to scrolling.
Returns
Returns current position of scroll thumb, if successful. -1 if failed.
Description
Update and redisplay a scrollbar data. The parameters nPos, nPageSize, nMin and nMax are optional, however, both nMin and nMax must be supplied, or not at all.
Platforms
Available on Windows
Tags
API, GTWVW

wvw_XReposWindow()Source code  |  | Improve this doc

Syntax
wvw_XReposWindow( <lAnchored> )
Arguments
lAnchored If .T., all subwindows are positioned according to their respective coordinate If .F., all subwindows are positioned according to whatever their "CenterWindow" setting
Returns
None.
Description
Reposition all windows to their initial position.
Platforms
Available on Windows
Tags
API, GTWVW

GTWVW |  | Improve this doc

Copyright
Description
Copyright 2008 Manoel N. Angeiras N. (angeiras gmail@com)
Platforms
Available on all platforms
Tag
Copyright