Menu
▾
▴
[Win32forth-cvs] win32forth/doc/classes Controls.htm,1.3,1.4
|
From: Dirk B. <db...@us...> - 2006-01-21 09:01:55
|
Update of /cvsroot/win32forth/win32forth/doc/classes In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15604/doc/classes Modified Files: Controls.htm Log Message: - Moved some methods from the MultiLineTextBox class into it's TextBox super class. - Some more documenting of ExControls.f (still work in progress). Index: Controls.htm =================================================================== RCS file: /cvsroot/win32forth/win32forth/doc/classes/Controls.htm,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Controls.htm 17 Jan 2006 17:51:59 -0000 1.3 --- Controls.htm 21 Jan 2006 09:01:47 -0000 1.4 *************** *** 142,148 **** </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 --- 142,234 ---- </h2><pre><b><a name="0">:Class TextBox <Super EditControl </a></b></pre><p>Class for text edit controls ! (enhanced Version of the EditControl class) ! </p><pre><b><a name="0">:M SetWmSetFocus: ( xt -- ) ! </a></b></pre><p>Set handler for WM_SETFOCUS messages. ! </p><pre><b><a name="0">:M AddStyle: ( n -- ) ! </a></b></pre><p>Set the style of the control. Must be done before the control ! is created. ! </p><pre><b><a name="0">:M Enable: ( f -- ) ! </a></b></pre><p>Enable the control ! </p><pre><b><a name="0">:M Disable: ( -- ) ! </a></b></pre><p>Disable the control ! </p><pre><b><a name="0">:M ReadOnly: ( f -- ) ! </a></b></pre><p>Set or remove the read-only style of the edit control. ! A value of TRUE sets the read-only style; a value of FALSE removes it. ! </p><pre><b><a name="0">:M SetSelection: ( nEnd nStart -- ) ! </a></b></pre><p>Selects a range of characters in the edit control. <i> nEnd </i> specifies the ! ending character position of the selection. <i> nStart </i> specifies the ! starting character position of the selection. ! </p><p>The start value can be greater than the end value. The lower of the two values ! specifies the character position of the first character in the selection. The ! higher value specifies the position of the first character beyond the selection. ! </p><p>The start value is the anchor point of the selection, and the end value is the ! active end. If the user uses the SHIFT key to adjust the size of the selection, ! the active end can move but the anchor point remains the same. ! </p><p>The control displays a flashing caret at the end position regardless of the relative ! values of start and end. ! </p><pre><b><a name="0">:M GetSelection: ( -- nEnd nStart ) ! </a></b></pre><p>Get the starting and ending character positions of the current selection in the edit control </p><pre><b><a name="0">:M SelectAll: ( -- ) ! </a></b></pre><p>Set the focus to the edit control and select all the text in the 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>Get location of cursor (chars from start) ! </p><pre><b><a name="0">:M IsModified?: ( -- f ) ! </a></b></pre><p>Get the state of an edit control's modification flag. The flag indicates whether ! the contents of the edit control have been modified. ! </p><pre><b><a name="0">:M SetModify: ( f -- ) ! </a></b></pre><p>Sets or clears the modification flag for an edit control. The modification flag ! indicates whether the text within the edit control has been modified. ! </p><pre><b><a name="0">:M NotModified: ( -- ) ! </a></b></pre><p>Depreacted method. Use <i> SetModify: </i> instead. ! </p><pre><b><a name="0">:M Undo: ( -- ) ! </a></b></pre><p>Undoes the last edit control operation in the control's undo queue. ! </p><pre><b><a name="0">:M Redo: ( -- ) ! </a></b></pre><p>Redoes the last edit control operation in the control's redo queue. ! </p><pre><b><a name="0">:M Cut: ( -- ) ! </a></b></pre><p>Delete (cut) the current selection, if any, in the edit control and ! copy the deleted text to the clipboard in CF_TEXT format. ! </p><pre><b><a name="0">:M Copy: ( -- ) ! </a></b></pre><p>Copy the current selection to the clipboard in CF_TEXT format. ! </p><pre><b><a name="0">:M Paste: ( -- ) ! </a></b></pre><p>Copy the current content of the clipboard to the edit control at the current ! caret position. Data is inserted only if the clipboard contains data in CF_TEXT ! format. ! </p><pre><b><a name="0">:M Clear: ( -- ) ! </a></b></pre><p>Delete selected text. ! </p><pre><b><a name="0">:M SetFont: ( handle -- ) ! </a></b></pre><p>Set the font in the edit control. ! </p><pre><b><a name="0">:M SetTextLimit: ( n -- ) ! </a></b></pre><p>Set the text limit of an edit control. ! </p><p><i> n </i> Specifies the maximum number of characters the user can enter. This number does ! not include the null terminator. <br /> ! Edit controls on Windows NT/ 2000: If this parameter is zero, the text length is set ! to 0x7FFFFFFE characters for single-line edit controls or -1 for multiline edit controls. <br /> ! Edit controls on Windows 95/98: If this parameter is zero, the text length is set to 0x7FFE ! characters for single-line edit controls or 0xFFFF for multiline edit controls. ! </p><p>The SetTextLimit: method limits only the text the user can enter. It does not affect any text ! already in the edit control when the message is sent, nor does it affect the length of the text ! copied to the edit control by the SetText: method. If an application uses the SetText: method ! to place more text into an edit control than is specified in the SetTextLimit: method, the user can ! edit the entire contents of the edit control. ! </p><p>Before the SetTextLimit: method is called, the default limit for the amount of text a user can enter ! in an edit control is 32,767 characters. ! </p><p>Edit controls on Windows NT/ 2000: For single-line edit controls, the text limit is either 0x7FFFFFFE bytes ! or the value of <i> n </i>, whichever is smaller. For multiline edit controls, this value is either ! -1 bytes or the value of <i> n </i>, whichever is smaller. ! </p><p>Edit controls on Windows 95/98: For single-line edit controls, the text limit is either 0x7FFE bytes or ! the value of <i> n </i>, whichever is smaller. For multiline edit controls, this value is either 0xFFFF bytes ! or the value of <i> n </i>, whichever is smaller. ! </p><pre><b><a name="0">:M GetTextEx: { buffer$ maxlen -- buffer$ len } ! </a></b></pre><p>Copies the text of the edit control into a buffer. ! </p><p><i> buffer$ </i> is the address of the buffer that will receive the text. ! </p><p><i> maxlen </i> Specifies the maximum number of characters to copy to the ! buffer, including the NULL character. If the text exceeds this limit, it ! is truncated. ! </p><p>If the method succeeds, <i> len </i> is the length, in characters, of the copied ! string, not including the terminating null character. ! </p><pre><b><a name="0">:M SetTextZ: ( addrz -- ) ! </a></b></pre><p>Copy the text from the 0 terminated string <i> addrz </i> into the edit control. </p><pre><b><a name="0">;Class </a></b></pre><p>End of TextBox class *************** *** 150,154 **** <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 --- 236,241 ---- <h2>PassWordBox class </h2><pre><b><a name="0">:Class PassWordBox <super TextBox ! </a></b></pre><p>Class for text edit controls. All characters in the control are displayed ! as an asterisk <b> * </b>. </p><pre><b><a name="0">;Class </a></b></pre><p>End of PassWordBox class *************** *** 158,186 **** </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 --- 245,270 ---- </a></b></pre><p>MultiLineTextBox class </p><pre><b><a name="0">:M SetMargins: ( left right -- ) ! </a></b></pre><p>Sets the widths of the left and right margins for an edit control. </p><pre><b><a name="0">:M SelectAll: ( -- ) ! </a></b></pre><p>Select all the text in the multiline edit control. </p><pre><b><a name="0">:M GetLine: ( -- n ) ! </a></b></pre><p>Return location of the cursor (lines from start). </p><pre><b><a name="0">:M Wrap: ( -- ) ! </a></b></pre><p>Set control to wrap text. ! Note this method does nothing! </p><pre><b><a name="0">:M Unwrap: ( -- ) ! </a></b></pre><p>Set control to scroll instead of wrap text. ! Note this method does nothing! ! </p><pre><b><a name="0">:M GetLineCount: ( -- n ) ! </a></b></pre><p>Retrieves the number of lines in the multiline edit control. ! </p><p>The return value is an integer specifying the total number of ! text lines in the multiline edit control. If the control has no text, ! the return value is 1. The return value will never be less than 1. ! </p><pre><b><a name="0">:M GetSelText: ( addr -- n ) ! </a></b></pre><p>Retrieves the currently selected text from the edit control. ! </p><p><i> addr </i> is the address of the a buffer that receives the selected text. ! The calling application must ensure that the buffer is large enough to hold ! the selected text. ! </p><p>Note: The text is copyied to the clipboard, too! </p><pre><b><a name="0">:M LineScroll: ( n -- ) </a></b></pre><p>scroll n lines *************** *** 191,196 **** </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 --- 275,285 ---- </h2><pre><b><a name="0">:Class RichEditControl <Super MultiLineTextBox </a></b></pre><p>RichEditControl class + </p><pre><b><a name="0">:M GetSelText: ( addr -- n ) + </a></b></pre><p>Retrieves the currently selected text from the edit control. + </p><p><i> addr </i> is the address of the a buffer that receives the selected text. + The calling application must ensure that the buffer is large enough to hold + the selected text. </p><pre><b><a name="0">:M GetLines: ( -- nr ) ! </a></b></pre><p>Depreacted method. Use <i> GetLineCount: </i> instead. </p><pre><b><a name="0">;Class </a></b></pre><p>End of RichEditControl class *************** *** 199,203 **** </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) --- 288,292 ---- </h2><pre><b><a name="0">:Class ComboBox <super ComboControl </a></b></pre><p>ComboBox control ! (enhanced 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) *************** *** 233,237 **** </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 --- 322,326 ---- </h2><pre><b><a name="0">:Class ListBox <super ListControl </a></b></pre><p>ListBox control (single selection) ! (enhanced 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 *************** *** 317,322 **** --- 406,473 ---- </p><pre><b><a name="0">;Class </a></b></pre><p>End of UpDownControl control + </p><a name="CheckBox"></a> + <h2>CheckBox class + </h2><pre><b><a name="0">:Class CheckBox <super CheckControl + </a></b></pre><p>Class for check buttons + (enhanced Version of the CheckControl class) </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">;Class + </a></b></pre><p>End of CheckBox class + </p><a name="RadioButton"></a> + <h2>RadioButton class + </h2><pre><b><a name="0">:Class RadioButton <super RadioControl + </a></b></pre><p>Class for radio buttons + (enhanced Version of the RadioControl class) + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of RadioButton class + </p><a name="PushButton"></a> + <h2>PushButton class + </h2><pre><b><a name="0">:Class PushButton <super ButtonControl + </a></b></pre><p>Class for push buttons + (enhanced Version of the ButtonControl class) + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of PushButton class + </p><a name="DefPushButton"></a> + <h2>DefPushButton class + </h2><pre><b><a name="0">:Class DefPushButton <Super PushButton + </a></b></pre><p>Class for the default push buttons + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of DefPushButton class + </p><a name="Label"></a> + <h2>Label class + </h2><pre><b><a name="0">:Class Label <super StaticControl + </a></b></pre><p>Class for static controls + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of Label class + </p><a name="StaticImage"></a> + <h2>StaticImage class + </h2><pre><b><a name="0">|Class StaticImage <Super Label + </a></b></pre><p>Base class for static control showing an image. + This is an intern class; don't use it directly. + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of StaticImage class + </p><a name="StaticBitmap"></a> + <h2>StaticBitmap class + </h2><pre><b><a name="0">:Class StaticBitmap <Super StaticImage + </a></b></pre><p>Static control showing a bitmap + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of StaticImage class + </p><a name="StaticIcon"></a> + <h2>StaticIcon class + </h2><pre><b><a name="0">:Class StaticIcon <Super StaticImage + </a></b></pre><p>Static control showing an icon + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of StaticIcon class + </p><a name="StaticMetafile"></a> + <h2>StaticMetafile class + </h2><pre><b><a name="0">:Class StaticMetafile <Super StaticImage + </a></b></pre><p>Static control showing an enhanced metafile + </p><pre><b><a name="0">;Class + </a></b></pre><p>End of StaticMetafile class + </p><a name="StaticFrame"></a> + <h2>StaticFrame class + </h2><pre><b><a name="0">:Class StaticFrame <Super Label + </a></b></pre><p>Static control showing a frame </p><pre><b><a name="0">:M BlackRect: ( -- ) </a></b></pre><p>rectangle in the window frame color (default is black) *************** *** 335,339 **** </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 ) --- 486,494 ---- </p><pre><b><a name="0">:M SunkenFrame: ( -- ) </a></b></pre><p>draws frame with half-sunken border ! </p><pre><b><a name="0">;Class ! </a></b></pre><p>End of StaticFrame class ! </p><hr><p>Document $Id$</p> ! </body></html> ! <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 ) |
