org.symbian.wrttools.doc.WRTKit/html/WRTKit_NavigationButton_Class-GUID-3c5aaba9-899d-463a-8337-b6f7c09e190b.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/org.symbian.wrttools.doc.WRTKit/html/WRTKit_NavigationButton_Class-GUID-3c5aaba9-899d-463a-8337-b6f7c09e190b.html Thu Mar 04 15:42:37 2010 -0800
@@ -0,0 +1,418 @@
+<?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 NavigationButton 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-3C5AABA9-899D-463A-8337-B6F7C09E190B" name="DC.Identifier" />
+<meta content="en" name="DC.Language" />
+<link href="commonltr.css" type="text/css" rel="stylesheet" />
+<title>
+WRTKit NavigationButton Class</title>
+</head>
+<body id="GUID-3C5AABA9-899D-463A-8337-B6F7C09E190B"><a name="GUID-3C5AABA9-899D-463A-8337-B6F7C09E190B"><!-- --></a>
+
+
+
+ <h1 class="topictitle1">
+WRTKit NavigationButton Class</h1>
+
+ <div>
+
+ <div class="section"><h2 class="sectiontitle">
+Description</h2>
+
+
+ <p>
+
+ The NavigationButton class implements a control that is intended for use in navigation
+ menu -style user interfaces. A navigation button is typically used to let users move
+ between views.
+ </p>
+
+ <div class="fignone" id="GUID-3C5AABA9-899D-463A-8337-B6F7C09E190B__GUID-63D51F0D-3760-4F4B-9B59-0B594D79A927"><a name="GUID-3C5AABA9-899D-463A-8337-B6F7C09E190B__GUID-63D51F0D-3760-4F4B-9B59-0B594D79A927"><!-- --></a><span class="figcap">Figure 1.
+NavigationButton controls</span>
+
+
+ <br /><img src="NavigationButton_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-F759C60D-D535-47D8-BB64-5F1403236F2A"><a name="GUID-F759C60D-D535-47D8-BB64-5F1403236F2A"><!-- --></a>
+
+ <h2 class="topictitle2">
+Constructor</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[NavigationButton] new NavigationButton(String id, String image, String text)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Creates a new instance of the NavigationButton 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>
+image</p>
+
+
+
+ <p>
+
+ Icon image that is displayed on the face of the button. No size is enforced but
+ the image should be about 30x30 pixels. PNG images with transparency are
+ recommended. If null is passed for the image then no image will be displayed.
+ </p>
+
+
+ </li>
+
+ <li>
+
+ <p>
+text</p>
+
+
+
+ <p>
+
+ Text that is displayed on the face of the button. Typically this should be
+ the view that the widget navigates to 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 NavigationButton class.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+ <div class="nested1" id="GUID-9199B58D-5A98-4A6D-AF18-D6FF1CAAA5EC"><a name="GUID-9199B58D-5A98-4A6D-AF18-D6FF1CAAA5EC"><!-- --></a>
+
+ <h2 class="topictitle2">
+getText()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[String] NavigationButton.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-B44BA4D5-E5E0-4711-B295-8039AC7A50A8"><a name="GUID-B44BA4D5-E5E0-4711-B295-8039AC7A50A8"><!-- --></a>
+
+ <h2 class="topictitle2">
+setText()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[void] NavigationButton.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 typically should indicate where the widget navigates
+ 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>
+
+ <div class="nested1" id="GUID-47A43DA5-CE78-438C-928D-0F5579A707B3"><a name="GUID-47A43DA5-CE78-438C-928D-0F5579A707B3"><!-- --></a>
+
+ <h2 class="topictitle2">
+getImage()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[String] NavigationButton.getImage(void)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Retrieves the icon image URL of the button.
+ </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 icon image URL of the button or null if none.
+ </p>
+
+ </div>
+
+ </div>
+
+ </div>
+
+ <div class="nested1" id="GUID-24F9C276-B75B-45E2-AB2D-ED751CAB18AA"><a name="GUID-24F9C276-B75B-45E2-AB2D-ED751CAB18AA"><!-- --></a>
+
+ <h2 class="topictitle2">
+setImage()</h2>
+
+ <div>
+
+ <div class="section"><h3 class="sectiontitle">
+Syntax</h3>
+
+
+ <pre>
+[void] NavigationButton.setImage(String image)</pre>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Description</h3>
+
+
+ <p>
+
+ Sets the icon image URL for the button. Passing null to this method
+ hides the icon image.
+ </p>
+
+ </div>
+
+ <div class="section"><h3 class="sectiontitle">
+Arguments</h3>
+
+
+ <br /><ul>
+
+ <li>
+
+ <p>
+image</p>
+
+
+
+ <p>
+
+ The URL of the icon image to display on the button or null for no image.
+ </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