TECLightView: what changed
Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.
Title: TECLightView
| Old | New | Line | |
|---|---|---|---|
| 1 | + | ## Overview | |
| 2 | + | ||
| 3 | + | **TECLightView**  is a lightweight text component. It can display text, images and links. It implements vertical scrollbar only. It does not implement carret. | |
| 4 | + | ||
| 5 | + | <figure> | |
| 6 | + | <img src="teclightview.png" title="teclightview.png" /> | |
| 7 | + | <figcaption>teclightview.png</figcaption> | |
| 8 | + | </figure> | |
| 9 | + | ||
| 10 | + | TECLightView is part of [[Eye-Candy Controls]] (shortly ECControls or EC-Controls) set of visual controls written for Lazarus. Their design is based on Themes, therefore its look is very native everywhere, no matter what widgetset you use. | |
| 11 | + | ||
| 12 | + | TECLightView is installed to the tab EC-C on the Lazarus component palette. | |
| 13 | + | ||
| 14 | + | Each release is announced on Lazarus Forum in section Third Party Announcements. There are always attached files `README.txt` (list of all known issues) and `CHANGELOG.txt` (list of all changes from previous release). | |
| 15 | + | ||
| 16 | + | ### License | |
| 17 | + | ||
| 18 | + | GNU Lesser General Public License 2.0 with linking exception (a.k.a. Modified LGPL). File ectabctrl.pas contains license header. Also, files `COPYING.modifiedLGPL.txt` and `COPYING.LGPL.txt` are bundled to each archive. | |
| 19 | + | ||
| 20 | + | ### Author | |
| 21 | + | ||
| 22 | + | This component is written by Blaazen. Copyright notice and real name is mentioned in the header of the unit. You can contact author on Lazarus Forum (nickname: Blaazen) in any thread about EC-Controls. If you are logged in to forum, you can get author's e-mail or send him private message. | |
| 23 | + | ||
| 24 | + | ### Download and Install | |
| 25 | + | ||
| 26 | + | See [[Eye-Candy Controls|Eye-Candy Controls#Install]] | |
| 27 | + | ||
| 28 | + | ## Tags | |
| 29 | + | ||
| 30 | + | | Tag | Pair | Parameter | Description | Example | | |
| 31 | + | |----|----|----|----|----| | |
| 32 | + | | a | N | string | Link (URL) | %a"[https://www.getlazarus.org"\\](https://www.getlazarus.org%22\) | | |
| 33 | + | | b | Y | \- | Bold text | %b\Bold text.%b\\ | | |
| 34 | + | | c | N | \- | Centered text | %c\Centered text. | | |
| 35 | + | | d | Y | \- | Stretchdraw images | %d\\%x"image.jpeg"\\%d\\ | | |
| 36 | + | | e | N | string | Link (mailto:) | %e"firstname.surename@domain.org"\\ | | |
| 37 | + | | f | N | integer | Font height (0=default) | %f2\\ %f-2\\ %f0\\ | | |
| 38 | + | | g | N | integer | Image from ImageList (property Images) | %g2\\ | | |
| 39 | + | | h | Y | color | Text background color (\$BBGGRR) | %h\$FF0000\Text with blue background.%h\\ | | |
| 40 | + | | i | Y | \- | Italic text | %i\Italic text.%i\\ | | |
| 41 | + | | j | N | \- | Align images to the left | %j\\ | | |
| 42 | + | | k | N | \- | Align images to the right | %k\\ | | |
| 43 | + | | l | N | \- | Left aligned text | %l\Left aligned text. | | |
| 44 | + | | m | Y | \- | Monospaced text | %m\Monospaced text.%m\\ | | |
| 45 | + | | n | N | \- | New line | %n\\ | | |
| 46 | + | | o | N | integer | Horizontal line | %o1\\ %o2\\ %o3\\ | | |
| 47 | + | | p | Y | \- | Preformatted text | %p\Preformatted text: %n\\ tag for a new line not needed.%p\\ | | |
| 48 | + | | q | N | \- | Align images to center | %q\\ | | |
| 49 | + | | r | N | \- | Right aligned text | %r\Right aligned text. | | |
| 50 | + | | s | Y | \- | Strikeout text | %s\Strikeout text.%s\\ | | |
| 51 | + | | t | Y | color | Font color (\$BBGGRR) | %t\$FF0000\Blue text.%t\\ | | |
| 52 | + | | u | Y | \- | Underlined text | %u\Underlined text.%u\\ | | |
| 53 | + | | v | N | \- | New line below image (when text floats around) | %v\\ | | |
| 54 | + | | w | N | string | Image from resources (no extension in name) | %w"image"\\ | | |
| 55 | + | | x | N | string | Image from file (bmp/jpeg/png) | %x"image.jpeg"\\ | | |
| 56 | + | | y | Y | integer | Link (OnInterLinkClick event) | %y0\OnInterLinkClick event 0.%y\\ | | |
| 57 | + | | z | N | \- | {Reserved for internal text layout} | \- | | |
| 58 | + | ||
| 59 | + | ## Using the Component | |
| 60 | + | ||
| 61 | + | ### Mouse | |
| 62 | + | ||
| 63 | + | Left button | |
| 64 | + | ||
| 65 | + | Click on a %a\\ tag opens the default web browser on the specified URL. | |
| 66 | + | ||
| 67 | + | Click on a %e\\ tag open the default email client. | |
| 68 | + | ||
| 69 | + | Click on a %y\\ tag triggers OnInterLinkClick event with integer parameter AIndex. | |
| 70 | + | ||
| 71 | + | Middle button | |
| 72 | + | ||
| 73 | + | Does nothing. | |
| 74 | + | ||
| 75 | + | Right button | |
| 76 | + | ||
| 77 | + | Opens context menu. | |
| 78 | + | ||
| 79 | + | Mouse Wheel | |
| 80 | + | ||
| 81 | + | Scrolls the content up/down. | |
| 82 | + | ||
| 83 | + | ### Keyboard | |
| 84 | + | ||
| 85 | + | (Component must be focused). | |
| 86 | + | ||
| 87 | + | Arrow keys Up/Down scrolls the content up/down. | |
| 88 | + | ||
| 89 | + | PageUp/PageDown scrolls the content up/down. | |
| 90 | + | ||
| 91 | + | ### Code | |
| 92 | + | ||
| 93 | + | `property PathToPictures: string;` | |
| 94 | + | ||
| 95 | + | Path to folder with images. Needed for the %x"filename"\\ tags. | |
| 96 | + | ||
| 97 | + | `property TextData: string;` | |
| 98 | + | ||
| 99 | + | This property is for source data, i.e. tags with parameters and text. | |
| 100 | + | ||
| 101 | + | --- | |
| 102 | + | *From the Free Pascal wiki, page "TECLightView", as it stood on 2020-07-18 after a change by FTurtle, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |