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

   1 {
   2    name = "DropBox",
   3    description = "Closely related to the EditBox, this control offers a list of options to choose from which drops down from the EditBox",
   4    remarks = "Unlike most properties and members, the selectionColor property can only be adjusted through the property editor, and does not have a code equivalent.",
   5    fields = [
   6       {
   7          "button",
   8          {
   9             description = "The button which is attached to this control."
  10          }
  11       }
  12    ],
  13    properties = [
  14       {
  15          "activeColor",
  16          {
  17             description = "When true, the active text in the EditBox portion of this control is highlighted with selectionColor."
  18          }
  19       },
  20       {
  21          "activeStipple",
  22          {
  23             description = "When true, the active text in the EditBox portion of this control is outlined with a dotted line."
  24          }
  25       },
  26       {
  27          "alignment",
  28          {
  29             description = "Sets the alignment of the text. Left, Center, or Right."
  30          }
  31       },
  32       {
  33          "changeContents",
  34          {
  35
  36          }
  37       },
  38       {
  39          "contents",
  40          {
  41             description = "When editText is true, then the EditBox portion of the control displays this string."
  42          }
  43       },
  44       {
  45          "editBox",
  46          {
  47             description = "Allows the users to enter data. This is the EditBox portion of this control."
  48          }
  49       },
  50       {
  51          "editText",
  52          {
  53             description = "When true, allows the user to enter data manually."
  54          }
  55       },
  56       {
  57          "maxShown",
  58          {
  59             description = "The number of items to show in the drop down list.<br>"
  60                "Example: DropBox dropBox1 { this, maxShown = 2 };"
  61          }
  62       },
  63       {
  64          "noHighlight",
  65          {
  66             description = "When true, only the text alone is highlighted, instead of the entire box."
  67          }
  68       },
  69       {
  70          "pullDown",
  71          {
  72             description = "The window which contains the drop down list."
  73          }
  74       },
  75       {
  76          "rowHeight",
  77          {
  78             description = "The height of each row of the drop down list. One item is listed per row.<br>"
  79                "Example: DropBox dropBox1 { this, rowHeight = 16 };"
  80          }
  81       },
  82       {
  83          "selectionColor",
  84          {
  85             description = "The color of the highlighting for the EditBox portion of this control."
  86          }
  87       },
  88       {
  89          "showButton",
  90          {
  91             description = "When true, a button is placed at the right side of the DropBox giving a visual clue that there is a drop down list of options to select."
  92          }
  93       },
  94       {
  95          "showNone",
  96          {
  97             description = "When true, \"(none)\" is included in the list of items."
  98          }
  99       }
 100    ],
 101    methods = [
 102       {
 103          "AddString",
 104          {
 105             description = "Adds a literal string to the listing of the DropBox.",
 106             parameters = [
 107                {
 108                   "string",
 109                   {
 110                      description = "The literal string to add to the DropBox.",
 111                      position = 1
 112                   }
 113                }
 114             ]
 115          }
 116       }
 117    ]
 118 }