doc: Fixed newlines (specified by <BR> rather than \n)
[sdk] / doc / ecere / ecere / gui / Anchor.econ
1 {
2    name = "Anchor",
3    description = "Defines the position of a Window/Control based on its top, left, bottom, right, middle horizontal, and middle vertical points relative to the parents client area, rather than just the top left corner.",
4    usage = "Specified as a property of a GUI element. Each individual property of the Anchor class can be set with an absolute value in pixels, or a relative value in percentages.",
5    example = "Window { anchor = { right = 16, bottom = 32 } };// This sets the window to appear with its right side being 16 pixels from the right side of the Parents client area, and 32 pixels from the bottom.<br>"
6       "Window { anchor = { horz = 100, vert = 100 } };// This sets the window to appear with its center being 100 pixels from the left of the parents client area, and 100 pixels from the top.<br>"
7       "Window { anchor = { horz = 0.5, vert = 0.5 } }; // This sets the window to appear with it's center being at 50% of the parents client area width, and 50% of the client area height.",
8    remarks = "This is particularly useful if you want to ensure that a particular control remains a specific distance from any one side of its parent.",
9    also = "Window",
10    fields = [
11       {
12          "bottom",
13          {
14             description = "The bottom most side of the Window/Control in relation to its parents client area."
15          }
16       },
17       {
18          "horz",
19          {
20             description = "The middle point of the Window/Control on the x-axis, in relation to its parents client area."
21          }
22       },
23       {
24          "left",
25          {
26             description = "The left most side of the Window/Control in relation to its parents client area."
27          }
28       },
29       {
30          "right",
31          {
32             description = "The right most side of the Window/Control in relation to its parents client area."
33          }
34       },
35       {
36          "top",
37          {
38             description = "The top most side of the Window/Control in relation to its parents client area."
39          }
40       },
41       {
42          "vert",
43          {
44             description = "The middle point of the Window/Control on the y-axis, in relation to its parents client area."
45          }
46       }
47    ]
48 }