From 53c66309b0c24285a875aba40f8e8ac32f72f52e Mon Sep 17 00:00:00 2001
From: Graeme Geldenhuys <graeme@mastermaths.co.za>
Date: Fri, 27 Nov 2009 17:01:36 +0200
Subject: Quick summary documentation for RichTextView.

---
 docview/components/richtext/RichTextView.txt | 60 ++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 docview/components/richtext/RichTextView.txt

(limited to 'docview')

diff --git a/docview/components/richtext/RichTextView.txt b/docview/components/richtext/RichTextView.txt
new file mode 100644
index 00000000..df0ed03e
--- /dev/null
+++ b/docview/components/richtext/RichTextView.txt
@@ -0,0 +1,60 @@
+TRichTextView component
+for fpGUI Toolkit
+
+Summary
+-------
+
+This component displays 'rich' text, with various fonts, colors, 
+styles and alignment.
+
+The major features are:
+  Fast, accurate drawing of text
+
+Features to come...
+  Selection and copy
+  Built-in default popup menu
+
+
+Using the component
+-------------------
+
+Put a component on your form. Adjust the properties as you see fit.
+At runtime, load the text into the control using AddText, AddParagraph, 
+and Clear. 
+
+Formatting syntax
+
+This is a HTML-like set of tags. But note that tag pairs don't have to
+match up.
+
+  <b> </b>       bold on, off
+  <u> </u>       underline on, off
+  <i> </i>       italic on, off
+  <h1> <h2> <h3> heading 1-3, set with Heading1Font etc
+  </h>           normal text
+  <tt> </tt>     fixed font 
+  <red> etc      colors
+  <left>         left alignment (word wrap)
+  <unaligned>    no right margin
+  <center>       centered
+  <right>        right alignment
+  <justify>      full justification (not implemented)
+  <defaultalign> default alignment
+  <margin x>     set left margin to x pixels
+  <link linktext> </link>
+    start, end link. 
+    The OnClickLink and OnOverLink events are called with linktext
+  <image x>      Display image x from associated TImageList
+    
+
+Example
+
+RichText.AddParagraph( '<h1>This is a big heading</h>' );  
+RichText.AddParagraph( 'Here is some <b>bold</b> text' );  
+  
+
+Problems/limitations
+--------------------
+Yes, there probably are some. :)
+
+
-- 
cgit v1.2.3-70-g09d2