The Ecere SDK - sdk/blob - doc/ecere/ecere/gui/controls/EditBox.econ

   1 {
   2    name = "EditBox",
   3    description = "An empty box, allowing users to input data.",
   4    remarks = "Currently, Word Wrap is not fully implemented.",
   5    properties = [
   6       {
   7          "allCaps",
   8          {
   9             description = "When true, all data entered will be uppercase characters."
  10          }
  11       },
  12       {
  13          "caretFollowsScrolling",
  14          {
  15             description = "When true, the Caret does not leave the visible area when it is scrolled."
  16          }
  17       },
  18       {
  19          "contents",
  20          {
  21             description = "The contents of the Edit Box.<br>"
  22                "Example: char * contentsOfEditBox = editBox1.contents;"
  23          }
  24       },
  25       {
  26          "freeCaret",
  27          {
  28             description = "When true, the Caret is placed where the mouse is clicked, whether there is text there or not. The Caret cannot be placed on a line that does not yet have text."
  29          }
  30       },
  31       {
  32          "maxLineSize",
  33          {
  34             description = "The maximum number of characters that a line can hold.<br>"
  35                "Example: maxLineSize = 30;"
  36          }
  37       },
  38       {
  39          "maxNumLines",
  40          {
  41             description = "The maximum number of lines that the Edit Box contains.<br>"
  42                "Example: maxNumLines = 5;"
  43          }
  44       },
  45       {
  46          "multiLine",
  47          {
  48             description = "When true, the user can enter input on more than one line in the Edit Box."
  49          }
  50       },
  51       {
  52          "noCaret",
  53          {
  54             description = "When true, the Caret will not appear in the Edit Box. The property editor will automatically set the Edit Box to read only. This makes it so that the Edit Box can be used for read only information without the distraction or confusion of the Caret."
  55          }
  56       },
  57       {
  58          "noSelect",
  59          {
  60             description = "When true, selection of data is disabled in the Edit Box."
  61          }
  62       },
  63       {
  64          "overwrite",
  65          {
  66             description = "Returns true if the Insert key has been pressed, and false if it hasn't. This property cannot be set."
  67          }
  68       },
  69       {
  70          "readOnly",
  71          {
  72             description = "When true, the text in the edit box cannot be edited and can only be modified using the contents property."
  73          }
  74       },
  75       {
  76          "syntaxHighlighting",
  77          {
  78             description = "When true, text which is recognized as a key word in eC, a number, or a string, are coloured differently from the foreground colour."
  79          }
  80       },
  81       {
  82          "tabKey",
  83          {
  84             description = "When true, the Tab Key is processed within the Edit Box."
  85          }
  86       },
  87       {
  88          "tabSize",
  89          {
  90             description = "The number of spaces to jump when the Tab Key is pressed. Note: tabSize has no meaning if tabKey is not true."
  91          }
  92       },
  93       {
  94          "textHorzScroll",
  95          {
  96             description = "When true, the text will scroll to the left while it is being entered, so that the caret is always visible. This also enables the user to manually scroll left and right on the line using the left and right arrows.<br>"
  97                "When false, it is not possible to type past the width of the control."
  98          }
  99       },
 100       {
 101          "textVertScroll",
 102          {
 103             description = "When true, the text can be scrolled vertically using the up and down arrows. For this to work, multiLine must also be true.<br>"
 104                "When false, it is not possible to type past the bottom of the control."
 105          }
 106       },
 107       {
 108          "wrap",
 109          {
 110             description = "When true, automatically wraps the text to the next line of a multiLine Edit Box when the caret encounters the right most side of the Edit Box. This wraps from the beginning of the last word on the line."
 111          }
 112       }
 113    ],
 114    methods = [
 115       {
 116          "Load",
 117          {
 118             description = "Loads a file into the EditBox.",
 119             usage = "Used in the statements section of code. Once an instantiation of the EditBox control has been made, then Load() would be accessed through the . operator.",
 120             example = "File f = FileOpen(\"C:/fun.txt\", read);<br>"
 121                "if(f)<br>"
 122                "{<br>"
 123                "   myEditBox.Load(f);<br>"
 124                "   delete(f);<br>"
 125                "}",
 126             parameters = [
 127                {
 128                   "f",
 129                   {
 130                      description = "Any file already open.",
 131                      position = 1
 132                   }
 133                }
 134             ]
 135          }
 136       }
 137    ]
 138 }