Interface IUIAccessible

Package com.ms.ui

Previous

Contents

Index

Next

Interface IUIAccessible

Methods , Fields

public interface IUIAccessible 
{
  // Fields
  public static final int DISP_E_MEMBERNOTFOUND;	   
  public static final int E_INVALIDARG;			   
  public static final int E_NOTIMPL;			   
  public static final int S_FALSE;	
		         
  public static final int CHILDID_SELF;
			   
  public static final int NAVDIR_UP;                     
  public static final int NAVDIR_DOWN;                    
  public static final int NAVDIR_LEFT;                    
  public static final int NAVDIR_RIGHT;                   
  public static final int NAVDIR_NEXT;                    
  public static final int NAVDIR_PREVIOUS;                
  public static final int NAVDIR_FIRSTCHILD;              
  public static final int NAVDIR_LASTCHILD; 
              
  public static final int SELFLAG_NONE;                  
  public static final int SELFLAG_TAKEFOCUS;              
  public static final int SELFLAG_TAKESELECTION;          
  public static final int SELFLAG_EXTENDSELECTION;       
  public static final int SELFLAG_ADDSELECTION;          
  public static final int SELFLAG_REMOVESELECTION;       
  public static final int SELFLAG_VALID;  
     
  public static final int ROLE_SYSTEM_TITLEBAR;           
  public static final int ROLE_SYSTEM_MENUBAR;            
  public static final int ROLE_SYSTEM_SCROLLBAR;          
  public static final int ROLE_SYSTEM_GRIP;              
  public static final int ROLE_SYSTEM_SOUND;              
  public static final int ROLE_SYSTEM_CURSOR;             
  public static final int ROLE_SYSTEM_CARET;              
  public static final int ROLE_SYSTEM_ALERT;              
  public static final int ROLE_SYSTEM_WINDOW;             
  public static final int ROLE_SYSTEM_CLIENT;             
  public static final int ROLE_SYSTEM_MENUPOPUP;          
  public static final int ROLE_SYSTEM_MENUITEM;           
  public static final int ROLE_SYSTEM_TOOLTIP;            
  public static final int ROLE_SYSTEM_APPLICATION;        
  public static final int ROLE_SYSTEM_DOCUMENT;           
  public static final int ROLE_SYSTEM_PANE;              
  public static final int ROLE_SYSTEM_CHART;              
  public static final int ROLE_SYSTEM_DIALOG;             
  public static final int ROLE_SYSTEM_BORDER;             
  public static final int ROLE_SYSTEM_GROUPING;           
  public static final int ROLE_SYSTEM_SEPARATOR;          
  public static final int ROLE_SYSTEM_TOOLBAR;            
  public static final int ROLE_SYSTEM_STATUSBAR;          
  public static final int ROLE_SYSTEM_TABLE;              
  public static final int ROLE_SYSTEM_COLUMNHEADER;       
  public static final int ROLE_SYSTEM_ROWHEADER;          
  public static final int ROLE_SYSTEM_COLUMN;             
  public static final int ROLE_SYSTEM_ROW;                
  public static final int ROLE_SYSTEM_CELL;               
  public static final int ROLE_SYSTEM_LINK;               
  public static final int ROLE_SYSTEM_HELPBALLOON;       
  public static final int ROLE_SYSTEM_CHARACTER;          
  public static final int ROLE_SYSTEM_LIST;               
  public static final int ROLE_SYSTEM_LISTITEM;          
  public static final int ROLE_SYSTEM_OUTLINE;          
  public static final int ROLE_SYSTEM_OUTLINEITEM;
  public static final int ROLE_SYSTEM_PAGETAB;            
  public static final int ROLE_SYSTEM_PROPERTYPAGE;       
  public static final int ROLE_SYSTEM_INDICATOR;         
  public static final int ROLE_SYSTEM_GRAPHIC;            
  public static final int ROLE_SYSTEM_STATICTEXT;         
  public static final int ROLE_SYSTEM_TEXT;               
  public static final int ROLE_SYSTEM_PUSHBUTTON;         
  public static final int ROLE_SYSTEM_CHECKBUTTON;        
  public static final int ROLE_SYSTEM_RADIOBUTTON;        
  public static final int ROLE_SYSTEM_COMBOBOX;           
  public static final int ROLE_SYSTEM_DROPLIST;           
  public static final int ROLE_SYSTEM_PROGRESSBAR;        
  public static final int ROLE_SYSTEM_DIAL;               
  public static final int ROLE_SYSTEM_HOTKEYFIELD;        
  public static final int ROLE_SYSTEM_SLIDER;             
  public static final int ROLE_SYSTEM_SPINBUTTON;         
  public static final int ROLE_SYSTEM_DIAGRAM;           
  public static final int ROLE_SYSTEM_ANIMATION;          
  public static final int ROLE_SYSTEM_EQUATION;           
  public static final int ROLE_SYSTEM_BUTTONDROPDOWN;     
  public static final int ROLE_SYSTEM_BUTTONMENU;         
  public static final int ROLE_SYSTEM_BUTTONDROPDOWNGRID; 
  public static final int ROLE_SYSTEM_WHITESPACE;         
  public static final int ROLE_SYSTEM_PAGETABLIST;        
  public static final int ROLE_SYSTEM_CLOCK;              
           
  public static final int STATE_SYSTEM_UNAVAILABLE;       
  public static final int STATE_SYSTEM_SELECTED;          
  public static final int STATE_SYSTEM_FOCUSED;           
  public static final int STATE_SYSTEM_PRESSED;           
  public static final int STATE_SYSTEM_CHECKED;           
  public static final int STATE_SYSTEM_MIXED;             
  public static final int STATE_SYSTEM_READONLY;          
  public static final int STATE_SYSTEM_HOTTRACKED;       
  public static final int STATE_SYSTEM_DEFAULT;           
  public static final int STATE_SYSTEM_EXPANDED;         
  public static final int STATE_SYSTEM_COLLAPSED;        
  public static final int STATE_SYSTEM_BUSY;            
  public static final int STATE_SYSTEM_FLOATING;          
  public static final int STATE_SYSTEM_MARQUEED;          
  public static final int STATE_SYSTEM_ANIMATED;          
  public static final int STATE_SYSTEM_INVISIBLE;        
  public static final int STATE_SYSTEM_OFFSCREEN;         
  public static final int STATE_SYSTEM_SIZEABLE;          
  public static final int STATE_SYSTEM_MOVEABLE;          
  public static final int STATE_SYSTEM_SELFVOICING;       
  public static final int STATE_SYSTEM_FOCUSABLE;         
  public static final int STATE_SYSTEM_SELECTABLE;        
  public static final int STATE_SYSTEM_LINKED;           
  public static final int STATE_SYSTEM_TRAVERSED;         
  public static final int STATE_SYSTEM_MULTISELECTABLE;   
  public static final int STATE_SYSTEM_EXTSELECTABLE;    

  // Methods
  public void doDefaultAction();
  public Rectangle getBounds(Component comp);
  public String getDefaultAction();
  public String getDescription();
  public String getHelp();
  public String getKeyboardShortcut();
  public int getRoleCode();
  public int getStateCode();
  public String getValueText();
  public void setValueText(String value);
  public Component navigate(Component comp, int direction, boolean keyable);

}

An interface for accessing control information that could otherwise be retrieved only by viewing the graphical user interface (GUI).

Methods

doDefaultAction

public void doDefaultAction();
Performs the default action for this object.
Return Value:
No return value.

getBounds

public Rectangle getBounds(Component comp);
Retrieves the bounding rectangle of the current component in coordinates that are relative to the given component.
Return Value:
Returns the bounding rectangle of the component.

Parameter Description

comp The relative component reference for the coordinates of the bounding rectangle.

getDefaultAction

public String getDefaultAction();
Retrieves the default action for this object.
Return Value:
Returns a string describing the object's default action (for example, "Press" for a button).

getDescription

public String getDescription();
Provides a description of the object.
Return Value:
Returns a string describing the object beyond information provided by getRoleCode, getStateCode, and getName.

getHelp

public String getHelp();
Provides Help text for the object.
Return Value:
Returns a string describing the object's function beyond information provided by getRoleCode, getStateCode, and getName.
Remarks:
It is used to provide a ToolTip for the object when it is tracked.

getKeyboardShortcut

public String getKeyboardShortcut();
Describes the keystrokes that are needed to change the input focus from the current object to the selected object.
Return Value:
Returns a string describing a keystroke sequence.

getRoleCode

public int getRoleCode();
Retrieves the role of this object.
Return Value:
Returns the ROLE_SYSTEM_ code that best describes the role of the object.

getStateCode

public int getStateCode();
Determines the current state of the object.
Return Value:
Returns the combination of STATE_SYSTEM_ codes that best describe the state of the object.

getValueText

public String getValueText();
Provides Help text for the object.
Return Value:
Returns a string describing the object's function beyond information provided by getRoleCode, getStateCode, and getName.
Remarks:
This Help text is used for more complete help than the simple tips supplied with the getHelp method.

navigate

public Component navigate(Component comp, int direction, boolean keyable);
Navigates to another component from the specified component in the given direction.
Return Value:
Returns the component navigated to; returns null if no component in the specified direction exists.

Parameter Description

comp The component to navigate from.
dir The direction (logically or spatially) to navigate.
keyable If true, non-keyable components will be ignored during the navigation; otherwise, all components can be navigated to.

setValueText

public void setValueText(String value);
Sets an object's string value.
Return Value:
No return value.

Parameter Description

value A string that describes the visual information contained in the object beyond the information provided by getRoleCode,getStateCode, and getName.

Remarks:
An application of this could be to set the text contained in an UIEdit object.

Fields

CHILDID_SELF: The child ID returned as self.
DISP_E_MEMBERNOTFOUND: COM error, the specified member was not found.
E_INVALIDARG: COM error, invalid argument.
E_NOTIMPL: COM error, not implemented.
NAVDIR_DOWN: The navigation direction is down.
NAVDIR_FIRSTCHILD: Navigate to the first child object.
NAVDIR_LASTCHILD: Navigate to the last child object.
NAVDIR_LEFT: Navigate spatially to the left.
NAVDIR_NEXT: Navigate to the next object.
NAVDIR_PREVIOUS: Navigate to the previous object.
NAVDIR_RIGHT: Navigate spatially to the right.
NAVDIR_UP: The navigation direction is up.
ROLE_SYSTEM_ALERT: The role code that is used to describe an alert of some type.
ROLE_SYSTEM_ANIMATION: The role code that is used to describe an animation.
ROLE_SYSTEM_APPLICATION: The role code that is used to describe an application.
ROLE_SYSTEM_BORDER: The role that is code used to describe a border object.
ROLE_SYSTEM_BUTTONDROPDOWN: The role code that is used to describe a button that launches a drop-down when pressed.
ROLE_SYSTEM_BUTTONDROPDOWNGRID: A role code that is used to describe a button. When it is pressed, a drop-down grid is launched.
ROLE_SYSTEM_BUTTONMENU: The role code that is used to describe a button. When it is pressed, a menu is launched.
ROLE_SYSTEM_CARET: The role code that is used to describe a caret.
ROLE_SYSTEM_CELL: The role code that is used to describe a cell within a grid.
ROLE_SYSTEM_CHARACTER: The role code that is used to describe a single character.
ROLE_SYSTEM_CHART: A role code that is used to describe a chart.
ROLE_SYSTEM_CHECKBUTTON: The role code that is used to describe a check button.
ROLE_SYSTEM_CLIENT: The role code that is used to describe a client object.
ROLE_SYSTEM_CLOCK: The role code that is used to describe a clock.
ROLE_SYSTEM_COLUMN: A role code that is used to describe a column.
ROLE_SYSTEM_COLUMNHEADER: The role code that is used to describe a column header.
ROLE_SYSTEM_COMBOBOX: The role code that is used to describe a combobox.
ROLE_SYSTEM_CURSOR: The role code that is used to describe a cursor.
ROLE_SYSTEM_DIAGRAM: The role code that is used to describe a diagram.
ROLE_SYSTEM_DIAL: The role code that is used to describe a dial.
ROLE_SYSTEM_DIALOG: The role code that is used to describe a dialog box.
ROLE_SYSTEM_DOCUMENT: The role code that is used to describe a document.
ROLE_SYSTEM_DROPLIST: The role code that is used to describe a drop-down list.
ROLE_SYSTEM_EQUATION: The role code that is used to describe an equation.
ROLE_SYSTEM_GRAPHIC: The role code that is used to describe a graphic object.
ROLE_SYSTEM_GRIP: The role code that is used to describe a grip on a scrollbar.
ROLE_SYSTEM_GROUPING: The role code that is used to describe a grouping.
ROLE_SYSTEM_HELPBALLOON: The role code that is used to describe a Help balloon, similar to a ToolTip.
ROLE_SYSTEM_HOTKEYFIELD: The role code that is used to describe a keyboard shortcut field.
ROLE_SYSTEM_INDICATOR: The role code that is used to define an indicator.
ROLE_SYSTEM_LINK: The role code that is used to define a link between two objects.
ROLE_SYSTEM_LIST: The role code that is used to describe a list.
ROLE_SYSTEM_LISTITEM: The role code that is used to describe an item on a list.
ROLE_SYSTEM_MENUBAR: The role code that is used to define a menu bar.
ROLE_SYSTEM_MENUITEM: The role code that is used to describe an item on a menu bar.
ROLE_SYSTEM_MENUPOPUP: The role code that is used to describe a pop-up menu.
ROLE_SYSTEM_OUTLINE: The role code that is used to define a hierarchical list object, such as a tree.
ROLE_SYSTEM_OUTLINEITEM: The role code that is used to identify an object within a hierarchical list.
ROLE_SYSTEM_PAGETAB: The role code that is used to identify the tab on a page, and used to navigate easily through a collection of pages within a container.
ROLE_SYSTEM_PAGETABLIST: The role code that is used to describe a list of tabs.
ROLE_SYSTEM_PANE: The role code that is used to describe a window or a frame pane.
ROLE_SYSTEM_PROGRESSBAR: The role code that is used to describe a progress bar.
ROLE_SYSTEM_PROPERTYPAGE: The role code that is used to describe a Properties page.
ROLE_SYSTEM_PUSHBUTTON: The role code that is used to describe a push button.
ROLE_SYSTEM_RADIOBUTTON: The role code that is used to describe a radio button.
ROLE_SYSTEM_ROW: The role code that is used to describe a row within a grid.
ROLE_SYSTEM_ROWHEADER: The role code that is used to describe a row header.
ROLE_SYSTEM_SCROLLBAR: The role code that is used to describe a scroll bar.
ROLE_SYSTEM_SEPARATOR: The role code that is used to describe a separator bar between two fields.
ROLE_SYSTEM_SLIDER: The role code that is used to to describe a slider object.
ROLE_SYSTEM_SPINBUTTON: The role code that is used to to describe a spin button.
ROLE_SYSTEM_SOUND: The role code that is used to describe a sound.
ROLE_SYSTEM_STATICTEXT: The role code that is used to describe a static text object.
ROLE_SYSTEM_STATUSBAR: The role code that is used to describe a status bar.
ROLE_SYSTEM_TABLE: The role code that is used to describe a table.
ROLE_SYSTEM_TEXT: The role code that is used to describe a text field.
ROLE_SYSTEM_TITLEBAR: The role code that is used to describe a tile bar.
ROLE_SYSTEM_TOOLBAR: The role code that is used to describe a toolbar on a menu.
ROLE_SYSTEM_TOOLTIP: The role code that is used to describe a ToolTip, similar to a Help balloon.
ROLE_SYSTEM_WHITESPACE: The role code that is used to define white space.
ROLE_SYSTEM_WINDOW: The role code that is used to describe a window, a frame, or a panel.
S_FALSE: COM error, returned as false.
SELFLAG_ADDSELECTION: Selection flag for add selection.
SELFLAG_EXTENDSELECTION: Selection flag for extended selection.
SELFLAG_NONE: Selection flag for none selected.
SELFLAG_REMOVESELECTION: Selection flag for remove selection.
SELFLAG_TAKEFOCUS: Selection flag to transfer focus from an object to the currently selected one.
SELFLAG_TAKESELECTION: Selection flag for an object that becomes the only selected object in a container.
SELFLAG_VALID: Selection flag to denote a valid selection.
STATE_SYSTEM_ANIMATED: The bitwise system code that describes an animated state for an object.
STATE_SYSTEM_BUSY: The bitwise system code that describes an object's busy state.
STATE_SYSTEM_CHECKED: The bitwise system code that describes an object as checked.
STATE_SYSTEM_COLLAPSED: The bitwise system code that describes an object's collapsed state.
STATE_SYSTEM_DEFAULT: The bitwise system code that describes a default item within a list.
STATE_SYSTEM_EXPANDED: The bitwise system code that determines if the object is currently expanded.
STATE_SYSTEM_EXTSELECTABLE: The bitwise system code that describes an extendselected list object.
STATE_SYSTEM_FLOATING: The bitwise system code that determines an object's floating state.
STATE_SYSTEM_FOCUSABLE: The bitwise system code that describes whether an object may receive focus.
STATE_SYSTEM_FOCUSED: The bitwise system code that describes whether an object currently has focus.
STATE_SYSTEM_HOTTRACKED: The bitwise system code that describes whether an object is currently hot-tracked.
STATE_SYSTEM_INVISIBLE: The bitwise system code that describes whether an object is currently visible to the user.
STATE_SYSTEM_LINKED: The bitwise system code that describes whether an object is linked (for example, a hypertext link) to another.
STATE_SYSTEM_MARQUEED: The bitwise system code that describes a marqueed state.
STATE_SYSTEM_MIXED: The bitwise system code that describes an indeterminate state.
STATE_SYSTEM_MOVEABLE: The bitwise system code that determines whether an object is moveable.
STATE_SYSTEM_MULTISELECTABLE: The bitwise system code that describes a multiselect list object.
STATE_SYSTEM_OFFSCREEN: The bitwise system code that determines whether an object is currently off the screen.
STATE_SYSTEM_PRESSED: The bitwise system code that describes whether a button is currently pressed.
STATE_SYSTEM_READONLY: The bitwise system code that determines whether the user may change the contents of a given object.
STATE_SYSTEM_SELECTABLE: The bitwise system code that determines whether an object may be selected.
STATE_SYSTEM_SELECTED: The bitwise system code that determines whether an object is currently selected.
STATE_SYSTEM_SELFVOICING: The bitwise system code that defines an object that can use Text To Speech (TTS) to voice itself.
STATE_SYSTEM_SIZEABLE: The bitwise system code that determines whether an object may be resized.
STATE_SYSTEM_TRAVERSED: This bitwise system code determines whether a link has been traversed. It is similar to STATE_SYSTEM_LINKED.
STATE_SYSTEM_UNAVAILABLE: The bitwise system code that determines whether an object is currently available.

Parameter	Description
comp	The relative component reference for the coordinates of the bounding rectangle.

Parameter	Description
value	A string that describes the visual information contained in the object beyond the information provided by getRoleCode,getStateCode, and getName.