[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
For quick reference, this section lists the Clip-4-Win functions
by category. You should turn to the Function Reference section
for the details of any particular function.
accelerator functions
LoadAccelerators() load an accelerator table resource
SetAccelerator() use an accelerator table
TranslateAccelerator() translate a keystroke as an accelerator
TranslMDISysAccel() translate a keystroke as an MDI accelerator
bitmap functions
AppendMenu() add another menu item
BitBlt() copy a bitmap from a device context to another
CreateHatchBrush() hatched pattern brush
CreatePatternBrush() create a pattern brush from a bitmap
CreateSolidBrush() a solid colour brush
DeleteObject() free up an object
GetClipbData() get data from clipboard
GetDIBRect() return the co-ordinates of a device-independent
bitmap
GetObject() info. about an object
GetStockObject() get a predefined object
LoadBitmap() load a standard bitmap or a bitmap resource
PatBlt() create/copy a bitmap pattern
ReadDIB() read a device-independent bitmap from a file
SelectObject() use an object
SetClipbData() put data into the clipboard
SetMenuItemBitmaps() set bitmaps for checked/unchecked menu items
ShowDIB() output a device-independent bitmap
StretchDIBits() stretch/shrink a device-independent bitmap
brush functions
CreateHatchBrush() hatched pattern brush
CreatePatternBrush() create a pattern brush from a bitmap
CreateSolidBrush() a solid colour brush
DeleteObject() free up an object
GetObject() info. about an object
GetStockObject() get a predefined object
SelectObject() use an object
SetBrushOrg() set the origin that will be used for a brush
in a device context
UnrealizeObject() reset the origin of a brush or reset a logical
palette
button functions
CheckDlgButton() add/remove a check mark for a dialog button or
a check box
CheckRadioButton() add a check mark to a radio button in a group
and clear the others
CreateWindow() create a new window
DestroyWindow() destroy a window
EnableWindow() enable/disable keyboard and mouse input for a
window
IsChild() check relationship
IsDlgButtonChecked() the status of a dialog button or check box
IsWindow() if a valid window
IsWindowEnabled() whether input allowed
MoveWindow() re-position a window
SendMessage() send a message to a window
SetFocus() set the window with the input focus
caret functions
GetCaretBlinkTime() the blink rate of the caret
GetCaretX() get the x-position of the caret
GetCaretY() get the y-position of the caret
HideCaret() make sure the caret is not displayed
SetCaret() set/get the shape of the caret
SetCaretBlinkTime() sets the blink rate of the caret
SetCaretPos() set the x-y position of the caret
ShowCaret() show the caret on the screen
clipboard functions
CloseClipboard() release the clipboard
CountClipbFormats() # of data formats
EmptyClipboard() empty the clipboard
EnumClipbFormats() get clipboard formats
GetClipbData() get data from clipboard
GetClipbFormatName() name of a clipboard format
GetClipbOwner() get window that owns the clipboard
GetClipbViewer() first window in clipbd-viewer chain
IsClipbFormatAvailable() if data exists in a clipboard format
OpenClipboard() open the clipboard
RegClipbFormat() register a new clipboard format
SetClipbData() put data into the clipboard
colour functions
C4W_Colors() the RGB values for the Clipper colour setting
ChooseColor() let the user select a colour
GetBkColor() background colour
GetBValue() blue part of a colour
GetGValue() green part of a colour
GetNearestColor() adapt to a device
GetRValue() red part of a colour
GetSysColor() system element colours
GetTextColor() colour used for text
RGB() mix a colour
SetBkColor() change background
SetTextColor() set colour for text
combobox controls
CreateWindow() create a new window
DestroyWindow() destroy a window
EnableWindow() enable/disable keyboard and mouse input for a
window
IsChild() check relationship
IsWindow() if a valid window
IsWindowEnabled() whether input allowed
MoveWindow() re-position a window
SendMessage() send a message to a window
SetFocus() set the window with the input focus
In COMBOBOX.PRG (and CLIP4WIN.LIB):
CBAddString() add a new string to the list box part
CBCopy() copy the edit control part to the clipboard
CBCut() cut the contents of the edit control part of a
combo box to the Windows clipboard
CBDeleteString() deletes a string from the list box part
CBDir() add a list of filenames to the list box part
CBFindString() find a string in the list box part
CBFindStrExact() find a string in the list box part
CBGetCount() returns the number of items in the list box part
CBGetCurSel() the position of the currently selected item in
the list box part of a combo box
CBGetDropRect() returns the screen co-ordinates of the drop-down
rectangle for the list box part of a combo box
CBGetDropState() .t. if the list box part is dropped down
CBGetEditSel() returns the start and end of the selected part
of the edit control part of a combo box
CBGetLBText() returns a line from within the list box part
CBGetLBTLen() returns the length of a line in the list box
CBGetText() get all the text in the edit control part
CBInsertString() insert a new string in the list box part
CBLimitText() sets the maximum number of characters allowed
in the edit control of a combo box
CBPaste() paste the contents of the Windows clipboard
into the edit control part of a combo box
CBResetContent() empty the list box and edit control parts
CBSelectString() find a string in the list box part, and (if
found) select and copy it into the edit control
CBSetCurSel() sets the position of the currently selected
item in the list box of a combo box
CBSetEditSel() sets the start and end of the selected part of
the edit control part of a combo box
CBShowDropDown() shows/hides the drop-down list box part
common dialogs
ChooseColor() let the user select a colour
ChooseFont() let the user select a font
GetOpenFileName() get the name of a file to open, from a
dialog with the user
GetPrintDC() access a printer for drawing
GetSaveFileName() get the name of a file to save into, from
a dialog with the user
PrintDlg() set up printer and print job information
cursor functions
CreateCursor() make a new cursor
DestroyCursor() free up a cursor
LoadCursor() load a standard cursor
SetCursor() use a cursor
ShowCursor() change visibility
DDE functions
A2Bin() convert a Clipper array to binary
AddAtom() add an atom to an application's atom table
Bin2A() convert binary data to a Clipper array
DDEAdvise() ask to be advised about changes to a DDE data
item
DDEExecute() ask a DDE server to execute commands
DDEGetData() get a DDE data item
DDEPoke() send a DDE data item to a DDE server
DDERequest() request the current value of a DDE data item
DDEStart() start a DDE conversation
DDEStop() stop a DDE conversation
DDEUnAdvise() turn off being advised about changes to a DDE
data item
DeleteAtom() delete an atom from the application's atom
table
FindAtom() find an atom in the application's atom table
GetAtomName() get the name of an atom in the application's
atom table
GlobalAddAtom() add an atom to the Windows system atom table
GlobalDeleteAtom() delete an atom from the Windows system atom
table
GlobalFindAtom() find an atom in the Windows system atom table
GlobalGetAtomName() get the name of an atom in the Windows system
atom table
device and device context functions
BeginPaint() start handling the WM_PAINT message
ClientToScreen() convert a point from client co-ordinates to
screen co-ordinates
CreateDC() create a device context
DeleteDC() delete a device context
EndPaint() finish handling the WM_PAINT message
GetDC() access a device
GetDeviceCaps() return information about a device
GetPrintDC() access a printer for drawing
ReleaseDC() release a device
ScreenToClient() convert a point's screen co-ordinates to
client co-ordinates
SetBrushOrg() set the origin that will be used for a brush
in a device context
dialog functions
AppendDialog() appends a new item to a dialog
CheckDlgButton() add/remove a check mark for a dialog button or
a check box
CheckRadioButton() add a check mark to a radio button in a group
and clear the others
CreateDialog() make a new dialog structure, or start a
modeless dialog
DefDlgProc() pass a message to the default dialog procedure
DestroyWindow() destroy a window
DialogBox() display and activate a modal dialog from a
dialog resource
EndDialog() terminate a modal dialog
GetDialogBaseUnits() return the dialog base units used when creating
dialog boxes
GetDialogResult() result from a dialog with the user
GetDlgCtrlID() get the numeric id of a child window
GetDlgItem() get the handle of a control in a dialog box
GetDlgItmInt() get the numeric value of the text in a control
in a dialog box
GetDlgItmText() get the text in a control in a dialog box
IsDialogMessage() try to handle a message in a dialog-like manner
MapDialogRect() convert dialog co-ordinates to screen (pixel)
co-ordinates
ModalDialog() activate a modal dialog box
SendDlgItemMessage() send a message to a control in a dialog box
SetDlgItem() set the text in a control in a dialog box
DLL functions
A2Bin() convert a Clipper array to binary
Bin2A() convert binary data to a Clipper array
CallDLL() call a func. in a dynamic link library
FreeLibrary() release a library (DLL)
GetProcAddress() access a function in a DLL
LoadLibrary() load a library (DLL)
drag and drop functions
DragAcceptFiles() register whether a window accepts dropped files
DragFinish() finish dropping files
DragQueryFile() the file name of a dropped file
DragQueryPoint() the mouse position when a file is dropped
drawing and output functions
Arc() draw an elliptical arc
BitBlt() copy a bitmap from a device context to another
Chord() draw a chord
DrawText() output a string in a rectangular area
Ellipse() draw an ellipse
FillRect() fill a rectangle
FloodFill() fill a screen area
FrameRect() draw a border
GetBkMode() get the current background mode
GetClientRect() get window co-ords
GetPixel() colour of a pixel
GetPolyFillMode() return the polygon-filling mode
GetROP2() get the current drawing mode
GetTabbedTextExtent() the width and height of a tabbed string
using the current font
GetTextExtent() return the width and height of a string
using the current font
GetTextMetrics() get the metrics for the current font
InvalidateRect() force an area to be redrawn
InvertRect() invert the pixels in a rectangular area
LineTo() draw a line
MoveTo() change the cursor position
PatBlt() create/copy a bitmap pattern
Pie() draw a pie-shaped wedge
Polygon() draw a closed polygon
PolyLine() draw several lines
Rectangle() a rectangle
RoundRect() draw a rounded rectangle
SetBkMode() set the current background mode
SetBrushOrg() set the origin that will be used for a brush
in a device context
SetPixel() change colour of pixel
SetPolyFillMode() set polygon-fill mode
SetROP2() set the current drawing mode
ShowDIB() output a device-independent bitmap
StretchDIBits() stretch/shrink a device-independent bitmap
TabbedTextOut() output a tabbed string at a specified position
TextOut() output a string at a specified position
UnrealizeObject() reset the origin of a brush or reset a
logical palette
ValidateRect() mark an area as not needing to be redrawn
edit control functions
CreateWindow() create a new window
DestroyWindow() destroy a window
EnableWindow() enable/disable keyboard and mouse input for a
window
IsChild() check relationship
IsWindow() if a valid window
IsWindowEnabled() whether input allowed
MoveWindow() re-position a window
SendMessage() send a message to a window
SetFocus() set the window with the input focus
In EDIT.PRG (and CLIP4WIN.LIB):
EditCanUndo() .t. if the last edit operation can be undone
EditCopy() copy the edit control contents to the clipboard
EditCut() cut the edit control contents to the clipboard
EditEmptyUndoBuffer() clears the edit control undo buffer
EditGetFirstVisibleLine() the number of the top line that's visible
EditGetLine() returns the specified line
EditGLineCount() the number of lines in a multi-line edit control
EditGetModify() .t. if the contents have been changed
EditGetPasswordChar() returns the character displayed when the user
enters text
EditGetSel() returns the start and end of the selected part
EditGetText() get all the text in an edit control
EditLimitText() sets the maximum number of characters allowed
EditLineFromChar() returns the line number indicated by the
character position
EditLineIndex() returns the character position of a line
within a multi-line edit control
EditLineLength() returns the length of the line indicated by the
character position
EditPaste() paste the contents of the clipboard into an
edit control
EditReplaceSel() replace the currently selected text
EditSetModify() sets/clears the flag that indicates whether the
contents of the edit control have been changed
EditSetPasswordChar() sets the character displayed when the user
enters text in a single-line edit control
EditSetReadOnly() makes the contents read-write or read-only
EditSetSel() sets the start and end of the selected part
EditSetText() change all the text in an edit control
EditUndo() attempts to undo the last edit control operation
event/message functions (also see: message functions)
AddHandler() add an event handler to the event processing
array
ChkEvent() check for a new event
DelHandler() remove an event handler from the event
processing array
Event() return the most recent event
HandleEvent() process a Windows event with the event array
MouseCol() return the column position of a mouse click
MouseRow() return the row position of a mouse click
MouseX() return the x-position of a mouse click
MouseY() return the y-position of a mouse click
PostMessage() put a message in a window's queue
SendMessage() send a message to a window
Online resources provided by: http://www.ClipX.Net --- NG 2 HTML conversion by Dave Pearson