diff -r 42e9659b68d1 -r 41890dfa56f5 org.symbian.wrttools.doc.WRTKit/html/WRTKit_Control_Class-GUID-6ddb8154-3fed-40fc-b282-85e6d3ad494f.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/org.symbian.wrttools.doc.WRTKit/html/WRTKit_Control_Class-GUID-6ddb8154-3fed-40fc-b282-85e6d3ad494f.html Thu Mar 04 15:42:37 2010 -0800 @@ -0,0 +1,609 @@ + + +
+ + + + + + + + + + ++ + The Control class is an abstract base class for user interface controls. + Don't instantiate Control directly but rather one of its subclasses. +
+ ++ + +UIElement +
+ ++FocusStateChanged
+ + + ++ + This event is fired when focus state of the control has changed. +
+ + ++HoverStateChanged
+ + + ++ + This event is fired when hover state of the control has changed. +
+ + ++[String] Control.getCaption(void)+ +
+ + Retrieves the current caption of the control. + The value is an XHTML string. +
+ ++ + This method does not take any arguments. +
+ ++ + The current caption of the control or null if the control doesn't have a caption. +
+ ++[void] Control.setCaption(String caption)+ +
+ + Sets the caption for the control. If null is specified as the caption + then the caption is removed (entirely hidden) for the control. + The value is an XHTML string. +
+ ++caption
+ + + ++ + The new caption for the control or null for no caption. +
+ + ++ + This method does not return a value. +
+ ++[Boolean] Control.isEnabled(void)+ +
+ + Retrieves the enabled state of the control. +
+ ++ + This method does not take any arguments. +
+ ++ + The current enabled state of the control. +
+ ++[void] Control.setEnabled(Boolean state)+ +
+ + Sets the enabled state for the control. +
+ ++state
+ + + ++ + The new enabled state for the control; true to enable, false to disable. +
+ + ++ + This method does not return a value. +
+ ++[Boolean] Control.isFocusable(void)+ +
+ + Retrieves the focusable state of a control. The focusable state tells + whether the control can be focused or not. E.g. a label control cannot + be focused because it does not have any interactive action to perform. +
+ ++ + This method does not take any arguments. +
+ ++ + The focusable state of the control. +
+ ++[Boolean] Control.isFocused(void)+ +
+ + Retrieves the focused state of the control. +
+ ++ + This method does not take any arguments. +
+ ++ + The current focused state of the control. +
+ ++[void] Control.setFocused(Boolean state)+ +
+ + Sets the focused state for the control. Note that it's not always possible + to carry out the request to focus a control. E.g. a control might not be + visible or the focus might be locked to another control. +
+ ++state
+ + + ++ + The new focused state for the control; true to focus, false to blur. +
+ + ++ + This method does not return a value. +
+ ++[void] Control.updateStyleFromState()+ +
+ + Called to let the control update its style to match its internal state. + The method doesn't need to be called manually as the toolkit takes care of + calling it whenever the state of a control changes. Override this method + if you wish to implement custom styling for a control. Typically using + CSS rules will be sufficient for customizing looks so only use this method + when CSS is insufficient. +
+ ++ + This method does not take any arguments. +
+ ++ + This method does not return a value. +
+ +