Menu
▾
▴
[Win32forth-cvs] win32forth/doc/classes Controls.htm,1.2,1.3
|
From: Dirk B. <db...@us...> - 2006-01-17 17:52:16
|
Update of /cvsroot/win32forth/win32forth/doc/classes In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17801/doc/classes Modified Files: Controls.htm Log Message: Started documenting ExControls.f (work in progress) Index: Controls.htm =================================================================== RCS file: /cvsroot/win32forth/win32forth/doc/classes/Controls.htm,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** Controls.htm 8 Jan 2006 09:28:07 -0000 1.2 --- Controls.htm 17 Jan 2006 17:51:59 -0000 1.3 *************** *** 16,20 **** <img border="0" src="../FORTHPRO.gif" width="32" height="32"> Win32Forth</h1> ! <hr /><h1>Controls -- Classes for standrad windows controls. </h1><hr /><a name="EditControl"></a> <h2>EditControl class --- 16,20 ---- <img border="0" src="../FORTHPRO.gif" width="32" height="32"> Win32Forth</h1> ! <hr /><h1>Controls -- Classes for standard windows controls. </h1><hr /><a name="EditControl"></a> <h2>EditControl class *************** *** 137,140 **** --- 137,444 ---- </p><pre><b><a name="0">;Class </a></b></pre><p>End of DialogWindow class + </p><hr /><h1>ExControls -- More (enhanced) classes for standard windows controls. + </h1><hr /><a name="TextBox"></a> + <h2>TextBox class + </h2><pre><b><a name="0">:Class TextBox <Super EditControl + </a></b></pre><p>Class for text edit controls + (enhaced Version of the EditControl class) + </p><pre><b><a name="0">:M SelectAll: ( -- ) + </a></b></pre><p>Select all the text in control. + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of TextBox class + </p><a name="PassWordBox"></a> + <h2>PassWordBox class + </h2><pre><b><a name="0">:Class PassWordBox <super TextBox + </a></b></pre><p>Editcontrol for entering Passwords. + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of PassWordBox class + </p><a name="MultiLineTextBox"></a> + <h2>MultiLineTextBox class + </h2><pre><b><a name="0">:Class MultiLineTextBox <super TextBox + </a></b></pre><p>MultiLineTextBox class + </p><pre><b><a name="0">:M SetMargins: ( left right -- ) + </a></b></pre><p>set margins for window + </p><pre><b><a name="0">:M Cut: ( -- ) + </a></b></pre><p>cut selected text to clipboard + </p><pre><b><a name="0">:M Copy: ( -- ) + </a></b></pre><p>copy selected text to clipboard + </p><pre><b><a name="0">:M Paste: ( -- ) + </a></b></pre><p>paste clipboard text to control + </p><pre><b><a name="0">:M Clear: ( -- ) + </a></b></pre><p>delete selected text (not to clipboard!) + </p><pre><b><a name="0">:M SetSelection: ( nEnd nStart -- ) + </a></b></pre><p>set selection range + </p><pre><b><a name="0">:M GetSelection: ( -- nEnd nStart) + </a></b></pre><p>return selection range + </p><pre><b><a name="0">:M SelectAll: ( -- ) + </a></b></pre><p>select all the text in control + </p><pre><b><a name="0">:M RemoveSelection: ( -- ) + </a></b></pre><p>remove any selection + </p><pre><b><a name="0">:M GetCursor: ( -- n ) + </a></b></pre><p>return location of cursor (chars from start) + </p><pre><b><a name="0">:M GetLine: ( -- n ) + </a></b></pre><p>return location of cursor (lines from start) + </p><pre><b><a name="0">:M Wrap: ( -- ) + </a></b></pre><p>set control to wrap text + </p><pre><b><a name="0">:M Unwrap: ( -- ) + </a></b></pre><p>set control to scroll instead of wrap text + </p><pre><b><a name="0">:M LineScroll: ( n -- ) + </a></b></pre><p>scroll n lines + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of MultiLineTextBox class + </p><a name="RichEditControl"></a> + <h2>RichEditControl class + </h2><pre><b><a name="0">:Class RichEditControl <Super MultiLineTextBox + </a></b></pre><p>RichEditControl class + </p><pre><b><a name="0">:M GetLines: ( -- nr ) + </a></b></pre><p>how many lines in control + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of RichEditControl class + </p><a name="ComboBox"></a> + <h2>ComboBox class + </h2><pre><b><a name="0">:Class ComboBox <super ComboControl + </a></b></pre><p>ComboBox control + (enhaced Version of the ComboControl class) + </p><pre><b><a name="0">:M InsertStringAt: ( lpszString posn -- ) + </a></b></pre><p>insert string in specified position (0 based) + </p><pre><b><a name="0">:M DeleteString: ( index -- ) + </a></b></pre><p>delete string in specified position (0 based) + </p><pre><b><a name="0">:M Clear: ( -- ) + </a></b></pre><p>clears all strings from combo box + </p><pre><b><a name="0">:M Find: ( lpszString -- index ) + </a></b></pre><p>search the list for an item beginning with the string (case-insensitive) + </p><pre><b><a name="0">:M FindExact: ( lpszString -- index ) + </a></b></pre><p>find the first item that matches the string exactly (case-insensitive) + </p><pre><b><a name="0">:M GetCount: ( -- n ) + </a></b></pre><p>return count of items in list + </p><pre><b><a name="0">:M SelectString: ( lpszString -- index ) + </a></b></pre><p>select item beginning with string + </p><pre><b><a name="0">:M GetStringAt: ( index -- a n ) + </a></b></pre><p>return string of specified item + </p><pre><b><a name="0">:M GetCurrent: ( -- index) + </a></b></pre><p>return current selection item + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of ComboBox class + </p><a name="ComboListBox"></a> + <h2>ComboListBox class + </h2><pre><b><a name="0">:Class ComboListBox <super ComboBox + </a></b></pre><p>ComboBox list control + </p><pre><b><a name="0">:M Start: ( Parent -- ) + </a></b></pre><p>we don't want the editcontrol in this control to be subclassed as with + super class. It shows the ibeam cursor so we override the start method + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of ComboListBox class + </p><a name="ListBox"></a> + <h2>ListBox class + </h2><pre><b><a name="0">:Class ListBox <super ListControl + </a></b></pre><p>ListBox control (single selection) + (enhaced Version of the ListControl class) + </p><pre><b><a name="0">:M AddString: ( lpszString -- ) + </a></b></pre><p>add a new string to the list box list + </p><pre><b><a name="0">:M InsertString: ( lpszString index -- ) + </a></b></pre><p>insert string in specified position (0 based) + </p><pre><b><a name="0">:M DeleteString: ( index -- ) + </a></b></pre><p>delete string in specified position (0 based) + </p><pre><b><a name="0">:M Find: ( lpszString -- index ) + </a></b></pre><p>search the list for an item beginning with the string (case-insensitive) + </p><pre><b><a name="0">:M FindExact: ( lpszString -- index ) + </a></b></pre><p>find the first item that matches the string exactly (case-insensitive) + </p><pre><b><a name="0">:M GetString: ( index -- a n ) + </a></b></pre><p>return string of specified item + </p><pre><b><a name="0">:M GetCurrent: ( -- index ) + </a></b></pre><p>return current selection item + </p><pre><b><a name="0">:M SelectString: ( lpszString -- index ) + </a></b></pre><p>select item beginning with string + </p><pre><b><a name="0">:M GetState: ( index -- f) + </a></b></pre><p>returns selection state of list item, tf=selected + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of ListBox class + </p><a name="MultiListbox"></a> + <h2>MultiListbox class + </h2><pre><b><a name="0">:Class MultiListbox <Super Listbox + </a></b></pre><p>ListBox control + MultiListbox allows multiple selections to be made. + Click once on an item to select it. Click again to deselect. + </p><pre><b><a name="0">:M Select: ( index -- ) + </a></b></pre><p>set selection of item + </p><pre><b><a name="0">:M Unselect: ( index -- ) + </a></b></pre><p>clear selection of item + </p><pre><b><a name="0">:M GetSelCount: ( -- n ) + </a></b></pre><p>returns number of selected items in list + </p><pre><b><a name="0">:M GetSelectedItems: { array cnt -- count } + </a></b></pre><p>return list of selected indices in array + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of MultiListbox class + </p><a name="MultiExListbox"></a> + <h2>MultiExListbox class + </h2><pre><b><a name="0">:Class MultiExListbox <Super MultiListbox + </a></b></pre><p>ListBox control + Also allows multiple selections to be made. + The difference is that Ctrl-Click selects and unselects + individual items and Shift-Click will select a range (as will + Shift-Drag. + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of MultiExListbox class + </p><a name="DragListbox"></a> + <h2>DragListbox class + </h2><pre><b><a name="0">:Class DragListbox <Super Listbox + </a></b></pre><p>ListBox control + Allows dragging of items in list box to re-order them + requires processing of drag list notification messages by the + application to actually do the dragging. + </p><pre><b><a name="0">:M Start: ( hParent -- ) + </a></b></pre><p>create an empty drag list box + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of DragListbox class + </p><a name="UpDownControl"></a> + <h2>UpDownControl class + </h2><pre><b><a name="0">:Class UpDownControl <Super Control + </a></b></pre><p>UpDownControl control + </p><pre><b><a name="0">:M StartSize: ( -- cx cy) + </a></b></pre><p>default window size + </p><pre><b><a name="0">:M StartPos: ( -- x y ) + </a></b></pre><p>default window position + </p><pre><b><a name="0">:M SetBuddy: ( hBuddy -- ) + </a></b></pre><p>assign buddy control + </p><pre><b><a name="0">:M GetValue: ( -- n ) + </a></b></pre><p>returns setting of up/down control + </p><pre><b><a name="0">:M SetValue: ( n -- ) + </a></b></pre><p>sets the up/down control position + </p><pre><b><a name="0">:M SetDecimal: ( -- ) + </a></b></pre><p>set display radix to decimal + </p><pre><b><a name="0">:M SetHex: ( -- ) + </a></b></pre><p>set display radix to hex + </p><pre><b><a name="0">:M GetBase: ( -- n ) + </a></b></pre><p>get current display radix + </p><pre><b><a name="0">:M SetRange: ( lower upper -- ) + </a></b></pre><p>set min & max limits + </p><pre><b><a name="0">:M GetRange: ( -- lower upper ) + </a></b></pre><p>retrieve min & max limits + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of UpDownControl control + </p><pre><b><a name="0">:M IsButtonChecked?: ( -- f ) + </a></b></pre><p>send message to self through parent + </p><pre><b><a name="0">:M BlackRect: ( -- ) + </a></b></pre><p>rectangle in the window frame color (default is black) + </p><pre><b><a name="0">:M GrayRect: ( -- ) + </a></b></pre><p>rectangle in the screen background color (default is gray) + </p><pre><b><a name="0">:M WhiteRect: ( -- ) + </a></b></pre><p>rectangle in the window background color (default is white) + </p><pre><b><a name="0">:M BlackFrame: ( -- ) + </a></b></pre><p>frame in the window frame color (default is black) + </p><pre><b><a name="0">:M GrayFrame: ( -- ) + </a></b></pre><p>frame in the screen background color (default is gray) + </p><pre><b><a name="0">:M WhiteFrame: ( -- ) + </a></b></pre><p>frame in the window background color (default is white) + </p><pre><b><a name="0">:M EtchedFrame: ( -- ) + </a></b></pre><p>draws an etched frame (frame appears lower than background) + </p><pre><b><a name="0">:M SunkenFrame: ( -- ) + </a></b></pre><p>draws frame with half-sunken border + </p><pre><b><a name="0">:M +Value: ( n -- ) + </a></b></pre><p>increases the value of progress bar by specified increment + </p><pre><b><a name="0">:M GetValue: ( -- n ) + </a></b></pre><p>returns the current position value + </p><pre><b><a name="0">:M SetValue: ( n -- ) + </a></b></pre><p>sets the current position value + </p><pre><b><a name="0">:M SetRange: ( min max -- ) + </a></b></pre><p>sets the minimum and maximum values for progress bar + </p><pre><b><a name="0">:M SetStep: ( n -- ) + </a></b></pre><p>sets the step increment + </p><pre><b><a name="0">:M GetStep: ( -- n ) + </a></b></pre><p>returns the current step increment + </p><pre><b><a name="0">:M StepIt: ( -- ) + </a></b></pre><p>advances the current position by the step increment + </p><pre><b><a name="0">:M GetLineSize: ( -- n ) + </a></b></pre><p>how much the value changes for "line" up/down + </p><pre><b><a name="0">:M SetLineSize: ( n -- ) + </a></b></pre><p>sets how much the value changes for "line" up/down + </p><pre><b><a name="0">:M GetPageSize: ( -- n ) + </a></b></pre><p>how much the value changes for "page" up/down + </p><pre><b><a name="0">:M SetPageSize: ( n -- ) + </a></b></pre><p>sets how much the value changes for "page" up/down + </p><pre><b><a name="0">:M GetValue: ( -- n) + </a></b></pre><p>gets current slider value + </p><pre><b><a name="0">:M SetValue: ( n -- ) + </a></b></pre><p>sets slider to value + </p><pre><b><a name="0">:M SetRangeMax: ( max f -- ) + </a></b></pre><p>tf= redraw + </p><pre><b><a name="0">:M SetRangeMin: ( min f -- ) + </a></b></pre><p>tf= redraw + </p><pre><b><a name="0">:M SetSelEnd: ( end f -- ) + </a></b></pre><p>tf=redraw + </p><pre><b><a name="0">:M SetSelStart: ( start f -- ) + </a></b></pre><p>tf=redraw + </p><pre><b><a name="0">:M GetThumbLength: ( -- n ) + </a></b></pre><p>retrieves the length of the slider in a trackbar + </p><pre><b><a name="0">:M GetThumbRect: ( lpRect) + </a></b></pre><p>retrieves the bounding rectangle for the slider + </p><pre><b><a name="0">:M ClearTicks: ( f -- ) + </a></b></pre><p>removes the current tick marks, tf=redraw + </p><pre><b><a name="0">:M GetTickPos: ( iTic -- n) + </a></b></pre><p>in client coordinates + </p><pre><b><a name="0">:M SetTickFreq: ( pos freq -- ) + </a></b></pre><p>must have TBS_AUTOTICKS style set + </p><pre><b><a name="0">:M SetRange: ( min max f) + </a></b></pre><p>tf= redraw + </p><pre><b><a name="0">:M SetSel: ( min max f) + </a></b></pre><p>tf= redraw + </p><pre><b><a name="0">:M ClearSel: ( f -- ) + </a></b></pre><p>clears the current selection in a trackbar, tf=redraw + </p><pre><b><a name="0">:M WindowStyle: ( -- style ) + </a></b></pre><p>override if another style is needed + </p><pre><b><a name="0">:M RaisedBorder: ( -- ) + </a></b></pre><p>text drawn below border (default) + </p><pre><b><a name="0">:M NoBorder: ( -- ) + </a></b></pre><p>text drawn at border level (no border) + </p><pre><b><a name="0">:M SunkenBorder: ( -- ) + </a></b></pre><p>text drawn above border + </p><pre><b><a name="0">:M MinHeight: ( #pixels -- ) + </a></b></pre><p>set minimum height of text region (not including borders) + </p><pre><b><a name="0">:M GetBorders: ( -- hWidth vWidth divWidth) + </a></b></pre><p>returns the border widths in pixels + </p><pre><b><a name="0">:M Redraw: ( -- ) + </a></b></pre><p>redraw the statusbar after changes (e.g., size) + </p><pre><b><a name="0">:M SetText: ( szText -- ) + </a></b></pre><p>sets simple status bar text + </p><pre><b><a name="0">:M Clear: ( -- ) + </a></b></pre><p>clears text from status window + </p><pre><b><a name="0">:M SetParts: ( aWidths nParts -- ) + </a></b></pre><p>width table address and count + </p><pre><b><a name="0">:M GetParts: ( -- aWidths nParts ) + </a></b></pre><p>retrieve data structure info + </p><pre><b><a name="0">:M SetSimple: ( -- ) + </a></b></pre><p>sets status bar to show single-part + </p><pre><b><a name="0">:M SetMulti: ( -- ) + </a></b></pre><p>sets status bar to show multiparts + </p><pre><b><a name="0">:M SetText: ( szText n -- ) + </a></b></pre><p>set text in n'th part + </p><pre><b><a name="0">:M SetIcon: ( hIcon -- ) + </a></b></pre><p>set the icon image to use with the button + </p><pre><b><a name="0">:M GetIcon: ( -- hIcon) + </a></b></pre><p>get the icon image used with the button + </p><pre><b><a name="0">:M SetFont: ( hndl -- ) + </a></b></pre><p>dummy for ForthForm + </p><pre><b><a name="0">:M MinSize: ( -- x y) + </a></b></pre><p>return minimum size required to display a month + </p><pre><b><a name="0">:M SetCustomFormat: ( z"format" -- ) + </a></b></pre><p>set the display format for time or date + </p><pre><b><a name="0">:M GetTime: ( -- hrs min secs ) + </a></b></pre><p>get user selected time + </p><pre><b><a name="0">:M SetTime: ( hr min sec -- ) + </a></b></pre><p>set time for user to edit + </p><pre><b><a name="0">:M GetDate: ( -- day month year ) + </a></b></pre><p>get user selected date + </p><pre><b><a name="0">:M InsertTab: ( index -- ) + </a></b></pre><p>tc_item mask and other members must be set + </p><pre><b><a name="0">:M GetTabInfo: ( index -- ) + </a></b></pre><p>tc_item mask member must be set + </p><pre><b><a name="0">:M SetTabInfo: ( index -- ) + </a></b></pre><p>tc_item members must be set + </p><pre><b><a name="0">:M ClientSize: ( -- x y w h ) + </a></b></pre><p>return size of display area + </p><pre><b><a name="0">:M WindowSize: ( 0 0 width height -- x y w h ) + </a></b></pre><p>given display area return window size required + </p><pre><b><a name="0">:M WindowTitle: ( -- null$ ) + </a></b></pre><p>SintillaControl asks for window title of parent </p><hr><p>Document $Id$</p> </body></html> |
