|
| 1 | +# A extended DesktopListbox Class for Xojo |
| 2 | + |
| 3 | +- Supports coloring of rows (odd/even) |
| 4 | +- In a multi-column list box, the entire row is highlighted |
| 5 | +- Inline edit, if a cell is editable, by slow SingleClicks within a certain time |
| 6 | +- No side effects to the functionality of the original DesktopListbox |
| 7 | + |
| 8 | +I developed this class on XOJO 2022R4.1 on Windows 11 and only tested it on Windows. |
| 9 | +Unfortunately, I cannot guarantee whether it will work on other platforms. |
| 10 | + |
| 11 | +If you want to contribute special code for other platforms, you are very welcome. If you find any errors, create an issue. It is quite possible that under certain conditions, not everything works as it should. |
| 12 | + |
| 13 | +## What is the difference to DesktopListbox |
| 14 | + |
| 15 | +- The new event **CellDoublePressed** have two parameter (row, column) |
| 16 | + |
| 17 | +- The new event **CellSinglePressed** only occurs if a click was actually made only once. This event occurs with a time delay (see property SingleClickTime) |
| 18 | + |
| 19 | +- The new event **CellEditRequest** only occurs when two slow SingleClicks have been performed on the same editable cell, within a certain time (see property EditTimeout). It should be **noted** that the **first click triggers a CellSinglePressed event**. In the original ListBox, a second click on the same cell would put it into EditMode, no matter how much time elapsed between clicks. Since this caused confusion for some users, this behavior has been optimized. |
| 20 | + |
| 21 | +- In the original list box (MultiColumn), only the first column is highlighted, when it is selected. By setting the **HighlightSelection** property to true (default), the entire line is automatically highlighted. The colors are DarkMode capable and can be changed at runtime. |
| 22 | + |
| 23 | +- even and odd rows can have different background and text colors. The option can be activated via the **colorizeRows** property (default is off). The colors are DarkMode capable and can be freely determined at runtime. |
| 24 | + |
| 25 | +- All specified default colors can be changed at runtime. For example in the opening event or somewhere else. |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +## The new Propertys |
| 30 | + |
| 31 | +| Property | Function | Type | |
| 32 | +| ------------------------ | ------------------------------------------------------------ | ---------- | |
| 33 | +| colorizeRows | If TRUE, the odd and even rows have different colors, see ColorOdd.... and ColorEven..... | Boolean | |
| 34 | +| HighlightSelection | If TRUE in MultiColumn Listbox, the hole row is marked as selected, see ColorHighlight..... | Boolean | |
| 35 | +| ColorEvenRowBackground | Background color for even rows | ColorGroup | |
| 36 | +| ColorEvenRowText | Text color for even rows | ColorGroup | |
| 37 | +| ColorHighlightBackground | Background color for a selected row | ColorGroup | |
| 38 | +| ColorHighlightText | Text color for a selected row | ColorGroup | |
| 39 | +| ColorOddRowBackground | Background color for odd rows | ColorGroup | |
| 40 | +| ColorOddRowText | Text color for odd rows | ColorGroup | |
| 41 | +| SingleClickTime | Two clicks within this time are evaluated as a DoublePressed event. A SinglePressed event is delayed by this time. You can adjust this at runtime. (default 250ms) | Integer | |
| 42 | +| EditTimeout | Two single clicks on the same editable cell immediately triggers an EditCellRequest event, if clicked in this time. You can adjust this at runtime. (default 5000ms) | Integer | |
| 43 | + |
| 44 | +## The Events in detail |
| 45 | + |
| 46 | +**Event CellDoublePressed(row as Integer, column as Integer)** |
| 47 | + |
| 48 | +``` |
| 49 | +A double click was performed on a cell in the listbox, on the given row/column. |
| 50 | +
|
| 51 | +If you start an modal dialog in this event, no normal DoublePressed event is sent to the instance. |
| 52 | +If you need an DoublePressed event in this situation return TRUE to raise a DoublePressed event. |
| 53 | +Default is false. The normal way is: Return allways false!!! See Notes in Class. |
| 54 | +``` |
| 55 | + |
| 56 | +**Event CellEditRequest(row as Integer, column as integer) As Boolean** |
| 57 | + |
| 58 | +``` |
| 59 | +The listbox wants to put an editable cell in inline edit mode on the given row/column. |
| 60 | +Return TRUE = Don't set this cell in EditMode |
| 61 | +Return FALSE = set this cell in Editmode (default) |
| 62 | +``` |
| 63 | + |
| 64 | +**Event CellSinglePressed(row as Integer, column as Integer)** |
| 65 | + |
| 66 | +``` |
| 67 | +A single click was performed on a cell in the listbox, on the given row/column. |
| 68 | +``` |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | +## Miscellaneous |
| 73 | + |
| 74 | +- There is a flag in the class for debug purposes, if this is set to true, o lot of debug messages are written to the system log (fDebug). Default is false (OFF) |
| 75 | +- If you want these functions in your project, import the WTEC_CellTag and WTEC_DesktopListbox classes into your project (see releases). |
| 76 | +- I know that my English is far from perfect. I'm happy to accept corrections :-) |
| 77 | + |
| 78 | +## History |
| 79 | + |
| 80 | +| Date/Version | Remarks | |
| 81 | +| ------------ | ------------- | |
| 82 | +| 07.06.2023 | First Release | |
| 83 | + |
| 84 | + |
| 85 | + |
0 commit comments