org.symbian.tools.wrttools.doc.WRTKit/html/WRTKit_FormButton_Class-GUID-9f99492d-b232-4a78-baed-bd284839b367.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/org.symbian.tools.wrttools.doc.WRTKit/html/WRTKit_FormButton_Class-GUID-9f99492d-b232-4a78-baed-bd284839b367.html Fri Mar 05 19:31:41 2010 -0800
@@ -0,0 +1,278 @@
+<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang="en" xml:lang="en">
+<head>
+<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+<meta name="copyright" content="(C) Copyright 2005" />
+<meta name="DC.rights.owner" content="(C) Copyright 2005" />
+<meta content="concept" name="DC.Type" />
+<meta name="DC.Title" content="WRTKit FormButton Class" />
+<meta scheme="URI" name="DC.Relation" content="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html" />
+<meta content="XHTML" name="DC.Format" />
+<meta content="GUID-9F99492D-B232-4A78-BAED-BD284839B367" name="DC.Identifier" />
+<meta content="en" name="DC.Language" />
+<link href="commonltr.css" type="text/css" rel="stylesheet" />
+<title>
+WRTKit FormButton Class</title>
+</head>
+<body id="GUID-9F99492D-B232-4A78-BAED-BD284839B367"><a name="GUID-9F99492D-B232-4A78-BAED-BD284839B367"><!-- --></a>
+
+
+
+ <h1 class="topictitle1">
+WRTKit FormButton Class</h1>
+
+ <div>
+
+ <div class="section"><h2 class="sectiontitle">
+Description</h2>
+
+
+ <p>
+
+ The FormButton class implements a control that is intended for use in form-style
+ user interfaces. A form button is typically used to let users trigger actions.
+ </p>
+
+ <div class="fignone" id="GUID-9F99492D-B232-4A78-BAED-BD284839B367__GUID-90873EC3-1248-4FC8-A318-06F71E370C67"><a name="GUID-9F99492D-B232-4A78-BAED-BD284839B367__GUID-90873EC3-1248-4FC8-A318-06F71E370C67"><!-- --></a><span class="figcap">Figure 1.
+FormButton controls</span>
+
+
+ <br /><img src="FormButton_Controls_Screenshot_1.png" /><br />
+ </div>
+
+ </div>
+
+ <div class="section"><h2 class="sectiontitle">
+Inherits from</h2>
+
+
+ <p>
+
+ <a href="WRTKit_ActionControl_Class-GUID-6a7cb034-d676-4119-b799-7b3e3b5948e4.html">
+ActionControl</a>
+ </p>
+
+ </div>
+
+ </div>
+
+ <div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div>
+</div>
+</div>
+<div class="nested1" id="GUID-C6970E99-D851-4FC1-BB92-BAA26FD83DB7"><a name="GUID-C6970E99-D851-4FC1-BB92-BAA26FD83DB7"><!-- --></a>
+
+ <h2 class="topictitle2">
+Constructor</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[FormButton] new FormButton(String id, String text)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Creates a new instance of the FormButton class.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <br /><ul>
+
+ <li>
+
+ <p>
+id</p>
+
+
+
+ <p>
+
+ Unique identifier for the control. Can be retrieved using the id property defined
+ in the UIElement class that this control inherits from. Useful for example to
+ identify the source of an event in event callback functions or to apply a CSS
+ rule to only this particular control. The identifier can be null, in which case
+ no id will be set for the control.
+ </p>
+
+
+ </li>
+
+ <li>
+
+ <p>
+text</p>
+
+
+
+ <p>
+
+ Text that is displayed on the face of the button. Typically this should be
+ a verb that indicates what happens when the button is pressed.
+ The value is an XHTML string.
+ </p>
+
+
+ </li>
+
+ </ul>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Return value</h3>
+
+
+ <p>
+
+ A new instance of the FormButton class.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+ <div class="nested1" id="GUID-26359B98-7773-43B5-A788-E15FCC1F0E41"><a name="GUID-26359B98-7773-43B5-A788-E15FCC1F0E41"><!-- --></a>
+
+ <h2 class="topictitle2">
+getText()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[String] FormButton.getText(void)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Retrieves the current text of the button.
+ The value is an XHTML string.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <p>
+
+ This method does not take any arguments.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Return value</h3>
+
+
+ <p>
+
+ The current text of the button.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+ <div class="nested1" id="GUID-0ACF25DA-ECF5-4D0A-8480-609497840FE4"><a name="GUID-0ACF25DA-ECF5-4D0A-8480-609497840FE4"><!-- --></a>
+
+ <h2 class="topictitle2">
+setText()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[void] FormButton.setText(String text)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Sets the text of the button. The text is displayed on the face
+ of the button and indicates what happens when the button is pressed.
+ The value is an XHTML string.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <br /><ul>
+
+ <li>
+
+ <p>
+text</p>
+
+
+
+ <p>
+
+ The text to be displayed on the face of the button. Passing null
+ results in no text.
+ </p>
+
+
+ </li>
+
+ </ul>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Return value</h3>
+
+
+ <p>
+
+ This method does not return a value.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+
+</body>
+</html>
\ No newline at end of file