Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: awt ::

service AccessibleToolBoxItem
Description
specifies accessibility support for a tool box item.
Since
OOo 1.1.2
See also
::com::sun::star::accessibility::AccessibleContext, ::com::sun::star::accessibility::XAccessibleComponent, ::com::sun::star::accessibility::XAccessibleExtendedComponent, ::com::sun::star::accessibility::XAccessibleAction, ::com::sun::star::accessibility::XAccessibleText, ::com::sun::star::accessibility::XAccessibleValue

Included Services - Summary
::com::sun::star::accessibility::AccessibleContext

This interface gives access to the structural information of a tool box item: (details)

Exported Interfaces - Summary
::com::sun::star::accessibility::XAccessibleComponent
(referenced entity's summary:)
The ::com::sun::star::accessibility::XAccessibleComponent interface should be supported by any class that can be rendered on the screen.
::com::sun::star::accessibility::XAccessibleExtendedComponent
(referenced entity's summary:)
The ::com::sun::star::accessibility::XAccessibleExtendedComponent interface contains additional methods to those of the ::com::sun::star::accessibility::XAccessibleComponent interface. These methods provide information that is used not as often. The division into two interfaces allows classes to support the more frequently used methods of the ::com::sun::star::accessibility::XAccessibleComponent interface and only support the ::com::sun::star::accessibility::XAccessibleExtendedComponent interface if that makes sense for the class.
::com::sun::star::accessibility::XAccessibleAction

This interface gives access to the actions that can be executed for a menu. The supported actions for a tool box item are: (details)

::com::sun::star::accessibility::XAccessibleText

This interface gives read-only access to the text representation of a tool box item.

::com::sun::star::accessibility::XAccessibleValue

This interface gives access to the numerical value of a tool box item, which is related to the tool box item's AccessibleStateType::CHECKED state.

Included Services - Details
::com::sun::star::accessibility::AccessibleContext
Description
This interface gives access to the structural information of a tool box item:
  • Role: The role of a tool box item is AccessibleRole::PUSH_BUTTON when the item is a push button, or AccessibleRole::TOGGLE_BUTTON when the item is a button and checkable, or AccessibleRole::PANEL when the item is a window, or AccessibleRole::FILLER when the item is a fill item, or AccessibleRole::SEPARATOR when the item is a separator.
  • Name: The name of a tool box item is the name set.
  • Description: The description of a tool box item is its localized help text.
  • Children: There can exist one child. This can be any kind of accessible object.
  • Parent: The parent is the tool box that contains the tool box item.
  • Relations: There are no relations.
  • States: The states supported by this service are
    • AccessibleStateType::DEFUNC is set if the object has already been disposed and subsequent calls to this object result in ::com::sun::star::lang::DisposedException exceptions.
    • AccessibleStateType::ENABLED is set if the object is enabled.
    • AccessibleStateType::FOCUSABLE is always set.
    • AccessibleStateType::FOCUSED is set if the object currently has the keyboard focus.
    • AccessibleStateType::SHOWING is set if the object is displayed on the screen.
    • AccessibleStateType::VISIBLE is always set.
    • AccessibleStateType::CHECKED is set if the tool box item is checked.
Exported Interfaces - Details
::com::sun::star::accessibility::XAccessibleComponent
(referenced entity's summary:)
The ::com::sun::star::accessibility::XAccessibleComponent interface should be supported by any class that can be rendered on the screen.
::com::sun::star::accessibility::XAccessibleExtendedComponent
(referenced entity's summary:)
The ::com::sun::star::accessibility::XAccessibleExtendedComponent interface contains additional methods to those of the ::com::sun::star::accessibility::XAccessibleComponent interface. These methods provide information that is used not as often. The division into two interfaces allows classes to support the more frequently used methods of the ::com::sun::star::accessibility::XAccessibleComponent interface and only support the ::com::sun::star::accessibility::XAccessibleExtendedComponent interface if that makes sense for the class.
::com::sun::star::accessibility::XAccessibleAction
Description
This interface gives access to the actions that can be executed for a menu. The supported actions for a tool box item are:
  • click
::com::sun::star::accessibility::XAccessibleText
Description
This interface gives read-only access to the text representation of a tool box item.
::com::sun::star::accessibility::XAccessibleValue
Description
This interface gives access to the numerical value of a tool box item, which is related to the tool box item's AccessibleStateType::CHECKED state.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.