From 67666aaccb4b4743a084b214722e1173e827e9d1 Mon Sep 17 00:00:00 2001
From: "ctrlaltca@gmail.com" <>
Date: Wed, 1 Jun 2011 22:14:00 +0000
Subject: upported recent documentation changes from branch/3.1 to trunk/

---
 framework/Web/UI/WebControls/TColorPicker.php | 25 +++++++++++++++++++++----
 1 file changed, 21 insertions(+), 4 deletions(-)

(limited to 'framework/Web/UI/WebControls/TColorPicker.php')

diff --git a/framework/Web/UI/WebControls/TColorPicker.php b/framework/Web/UI/WebControls/TColorPicker.php
index 0fc7eef4..1066bf76 100644
--- a/framework/Web/UI/WebControls/TColorPicker.php
+++ b/framework/Web/UI/WebControls/TColorPicker.php
@@ -13,8 +13,25 @@
 /**
  * TColorPicker class.
  *
- * Be aware, this control is EXPERIMENTAL and is not stablized yet.
+ * TColorPicker displays a text box for color input purpose.
+ * Next to the textbox there's a button filled with the current chosen color.
+ * Users can write a color name directly in the text box as an hex triplet (also known as HTML notation, eg: #FF00FF).
+ * Alternatively, if the <b>ShowColorPicker</b> property is enabled (it is by default), users can click the button
+ * to have a color picker UI appear. A color chan be chosen directly by clicking on the color picker.
  *
+ * TColorPicker has three different color picker UI <b>Mode</b>s:
+ *  # <b>Simple</b> - Grid with 12 simple colors.
+ *  # <b>Basic</b> - Grid with the most common 70 colors. This is the default mode.
+ *  # <b>Full</b> - Full-featured color picker.
+ * 
+ * The <b>CssClass</b> property can be used to override the CSS class name
+ * for the color picker panel. The <b>ColorStyle</b> property sets the packages
+ * styles available. E.g. <b>default</b>.
+ * 
+ * If the <b>Mode</b> property is set to <b>Full</b>, the color picker panel will
+ * display an "Ok" and "Cancel" buttons. You can customize the button labels setting the <b>OKButtonText</b>
+ * and <b>CancelButtonText</b> properties.
+ * 
  * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
  * @version $Id$
  * @package System.Web.UI.WebControls
@@ -226,9 +243,9 @@ class TColorPicker extends TTextBox
  * that a {@link TColorPicker} control can take.
  *
  * The following enumerable values are defined:
- * - Simple
- * - Basic
- * - Full
+ * # Simple - Grid with 12 simple colors.
+ * # Basic - Grid with the most common 70 colors. This is the default mode.
+ * # Full - Full-featured color picker.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @version $Id$
-- 
cgit v1.2.3