diff options
Diffstat (limited to 'offapi/com/sun/star/accessibility')
31 files changed, 112 insertions, 112 deletions
diff --git a/offapi/com/sun/star/accessibility/Accessible.idl b/offapi/com/sun/star/accessibility/Accessible.idl index a3b5e5bfc8df..c3d5d5e52585 100644 --- a/offapi/com/sun/star/accessibility/Accessible.idl +++ b/offapi/com/sun/star/accessibility/Accessible.idl @@ -25,9 +25,9 @@ module com { module sun { module star { module accessibility { /** Every class has to support this service in order to be accessible. - <p>It provides the means to derive a <type>XAccessibleContext</type> + <p>It provides the means to derive a XAccessibleContext object--which may but usually is not the same object as the object that - supports the <type>XAccessible</type> interface--that provides the + supports the XAccessible interface--that provides the actual information that is needed to make it accessible.</p> <p>Service <code>Accessible</code> is just a wrapper for the interface diff --git a/offapi/com/sun/star/accessibility/AccessibleContext.idl b/offapi/com/sun/star/accessibility/AccessibleContext.idl index d9fe07c7f288..e3233a3eea05 100644 --- a/offapi/com/sun/star/accessibility/AccessibleContext.idl +++ b/offapi/com/sun/star/accessibility/AccessibleContext.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module accessibility { are organized can be navigated in freely. It typically represents spatial relationship of one object containing a set of children like a dialog box contains a set of buttons. Additionally the - <type>XAccessibleContext</type> interface of this service exposes + XAccessibleContext interface of this service exposes methods that provide access to the actual object's content. This can be the object's role, name, description, and so on.</p> diff --git a/offapi/com/sun/star/accessibility/AccessibleEventId.idl b/offapi/com/sun/star/accessibility/AccessibleEventId.idl index c5d0bdf5e886..55baaf8dffc8 100644 --- a/offapi/com/sun/star/accessibility/AccessibleEventId.idl +++ b/offapi/com/sun/star/accessibility/AccessibleEventId.idl @@ -21,7 +21,7 @@ module com { module sun { module star { module accessibility { -/** These constants identify the type of <type>AccessibleEventObject</type> +/** These constants identify the type of AccessibleEventObject objects. <p>The <member>AccessibleEventObject::OldValue</member> and @@ -148,15 +148,15 @@ constants AccessibleEventId /** A visible data event indicates the change of the visual appearance of an accessible object. This includes for example most of the - attributes available over the <type>XAccessibleComponent</type> and - <type>XAccessibleExtendedComponent</type> interfaces. The + attributes available over the XAccessibleComponent and + XAccessibleExtendedComponent interfaces. The <member>AccessibleEventObject::OldValue</member> and <member>AccessibleEventObject::NewValue</member> fields are left empty. */ const short VISIBLE_DATA_CHANGED = 10; /** This constant indicates changes of the value of an - <type>XAccessibleValue</type> interface. The + XAccessibleValue interface. The <member>AccessibleEventObject::OldValue</member> and <member>AccessibleEventObject::NewValue</member> field contain the old and new value as a number. Its exact type is implementation @@ -245,7 +245,7 @@ constants AccessibleEventId /** Events of this type signal changes of the selection. The old or new selection is <em>not</em> available through the event object. You - have to query the <type>XAccessibleText</type> interface of the + have to query the XAccessibleText interface of the event source for this information. The type of content of the <member>AccessibleEventObject::OldValue</member> and <member>AccessibleEventObject::NewValue</member> fields is not @@ -254,8 +254,8 @@ constants AccessibleEventId const short TEXT_SELECTION_CHANGED = 21; /** Use this id to indicate general text changes, i.e. changes to text - that is exposed through the <type>XAccessibleText</type> and - <type>XAccessibleEditableText</type> interfaces. + that is exposed through the XAccessibleText and + XAccessibleEditableText interfaces. <p>The affected text ranges are represented by <type scope="com::sun::star::accessibility">TextSegment</type> structures.<p> @@ -322,7 +322,7 @@ constants AccessibleEventId /** Constant used to indicate that the column header has changed. The <member>AccessibleEventObject::OldValue</member> is empty, the <member>AccessibleEventObject::NewValue</member> field contains an - <type>AccessibleTableModelChange</type> representing the header + AccessibleTableModelChange representing the header change. */ const short TABLE_COLUMN_HEADER_CHANGED = 27; @@ -330,7 +330,7 @@ constants AccessibleEventId /** Constant used to indicate that the table data has changed. The <member>AccessibleEventObject::OldValue</member> is empty, the <member>AccessibleEventObject::NewValue</member> field contains an - <type>AccessibleTableModelChange</type> representing the data + AccessibleTableModelChange representing the data change. */ const short TABLE_MODEL_CHANGED = 28; @@ -345,7 +345,7 @@ constants AccessibleEventId /** Constant used to indicate that the row header has changed. The <member>AccessibleEventObject::OldValue</member> is empty, the <member>AccessibleEventObject::NewValue</member> field contains an - <type>AccessibleTableModelChange</type> representing the header + AccessibleTableModelChange representing the header change. */ const short TABLE_ROW_HEADER_CHANGED = 30; diff --git a/offapi/com/sun/star/accessibility/AccessibleEventObject.idl b/offapi/com/sun/star/accessibility/AccessibleEventObject.idl index 781a8f1cdf0f..3ce87339813e 100644 --- a/offapi/com/sun/star/accessibility/AccessibleEventObject.idl +++ b/offapi/com/sun/star/accessibility/AccessibleEventObject.idl @@ -24,10 +24,10 @@ module com { module sun { module star { module accessibility { /** this struct describes an accessible event, that is broadcasted from - the <type>XAccessibleEventBroadcaster</type> and notified to - <type>XAccessibleEventListener</type>. + the XAccessibleEventBroadcaster and notified to + XAccessibleEventListener. - <p>It is usually implemented by <type>AccessibleContext</type>. + <p>It is usually implemented by AccessibleContext. @since OOo 1.1.2 */ @@ -35,7 +35,7 @@ struct AccessibleEventObject: ::com::sun::star::lang::EventObject { /** specifies the type of this event. - <p>For a list of possible events see <type>AccessibleEventId</type>. + <p>For a list of possible events see AccessibleEventId. */ short EventId; diff --git a/offapi/com/sun/star/accessibility/AccessibleRelation.idl b/offapi/com/sun/star/accessibility/AccessibleRelation.idl index b715abf5675d..f3b5e8402cea 100644 --- a/offapi/com/sun/star/accessibility/AccessibleRelation.idl +++ b/offapi/com/sun/star/accessibility/AccessibleRelation.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module accessibility { -/** An <type>AccessibleRelation</type> object defines a one-to-many +/** An AccessibleRelation object defines a one-to-many relation. <p>The represented relation points from the implementing object to a set @@ -36,7 +36,7 @@ struct AccessibleRelation /** Type of the relation. <p>Its value has to be one of the constants defined by - <type>AccessibleRelationType</type>. If that value is INVALID then + AccessibleRelationType. If that value is INVALID then the whole relation is regarded as invalid. The content of the TargetSet is then undefined.</p> diff --git a/offapi/com/sun/star/accessibility/AccessibleRelationType.idl b/offapi/com/sun/star/accessibility/AccessibleRelationType.idl index 32a94afc17dd..2219c26cfd8f 100644 --- a/offapi/com/sun/star/accessibility/AccessibleRelationType.idl +++ b/offapi/com/sun/star/accessibility/AccessibleRelationType.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module accessibility { /** Collection of relation types. <p>This list of constants defines the available types of relations that - are usable by <type>AccessibleRelation</type>.</p> + are usable by AccessibleRelation.</p> <p>We are using constants instead of a more typesafe enum. The reason for this is that IDL enums may not be extended. Therefore, in order to diff --git a/offapi/com/sun/star/accessibility/AccessibleRole.idl b/offapi/com/sun/star/accessibility/AccessibleRole.idl index 9f57f8f53201..1b5b4e213d1a 100644 --- a/offapi/com/sun/star/accessibility/AccessibleRole.idl +++ b/offapi/com/sun/star/accessibility/AccessibleRole.idl @@ -25,12 +25,12 @@ module com { module sun { module star { module accessibility { /** Collection of roles. <p>This collection of constants defines the set of possible roles of - classes implementing the <type>XAccessible</type> interface according to + classes implementing the XAccessible interface according to the Java class javax.accessibility.AccessibleRole. The role of an object describes its generic function like "button", "menu", or "text". You can obtain an object's role by calling the <member>getAccessibleRole</member> method of the - <type>XAccessibleContext</type> interface.</p> + XAccessibleContext interface.</p> <p>We are using constants instead of a more typesafe enum. The reason for this is that IDL enums may not be extended. Therefore, in order to diff --git a/offapi/com/sun/star/accessibility/AccessibleStateType.idl b/offapi/com/sun/star/accessibility/AccessibleStateType.idl index acf0a302db58..f0c13cee6e0c 100644 --- a/offapi/com/sun/star/accessibility/AccessibleStateType.idl +++ b/offapi/com/sun/star/accessibility/AccessibleStateType.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module accessibility { /** Collection of state types. <p>This list of constants defines the available set of states that an - object that implements <type>XAccessibleContext</type> can be in.</p> + object that implements XAccessibleContext can be in.</p> <p>The comments describing the states is taken verbatim from the Java Accessibility API 1.4 documentation.</p> diff --git a/offapi/com/sun/star/accessibility/AccessibleTableModelChange.idl b/offapi/com/sun/star/accessibility/AccessibleTableModelChange.idl index c79904340610..ae49447cecb6 100644 --- a/offapi/com/sun/star/accessibility/AccessibleTableModelChange.idl +++ b/offapi/com/sun/star/accessibility/AccessibleTableModelChange.idl @@ -26,9 +26,9 @@ module com { module sun { module star { module accessibility { /** This structure lets an event give access to a change of a table model. - <p>The data members of the <type>AccessibleTableModelChange</type> structure + <p>The data members of the AccessibleTableModelChange structure give access to the type and cell range of a change of a table model. See - <type>AccessibleTableModelChangeType</type> for details of the change + AccessibleTableModelChangeType for details of the change type. The range of the affected rows, columns, and/or cells can be obtained by accessing the other four data members.</p> @@ -37,11 +37,11 @@ module com { module sun { module star { module accessibility { struct AccessibleTableModelChange { /** The type of the event as defined in - <type>AccessibleTableModelChangeType</type>. + AccessibleTableModelChangeType. <p>The model change either inserted or deleted one or more rows and/or columns or modified the content of a number of cells. See - <type>AccessibleTableModelChangeType</type> for details of the type + AccessibleTableModelChangeType for details of the type of the model change.</p> */ short Type; diff --git a/offapi/com/sun/star/accessibility/AccessibleTableModelChangeType.idl b/offapi/com/sun/star/accessibility/AccessibleTableModelChangeType.idl index cef7f8204d3d..6b933b9bfb31 100644 --- a/offapi/com/sun/star/accessibility/AccessibleTableModelChangeType.idl +++ b/offapi/com/sun/star/accessibility/AccessibleTableModelChangeType.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module accessibility { /** Type of a change made to a table model. <p>The value of this constants group are used by the - <type>AccessibleTableModelChange</type> structure to specify the + AccessibleTableModelChange structure to specify the type of change that has been made to a table model.</p> <p>Two of the constants, @@ -44,7 +44,7 @@ constants AccessibleTableModelChangeType { /** One or more rows and/or columns have been inserted. - <p>Use the fields of the <type>AccessibleTableModelChange</type> + <p>Use the fields of the AccessibleTableModelChange structure to determine the indices of the rows and/or columns that have been inserted.</p> */ @@ -53,7 +53,7 @@ constants AccessibleTableModelChangeType /** One or more rows and/or columns have been deleted. <p>The affected area of the table is stored in the fields of the - <type>AccessibleTableModelChange</type> structure.</p> + AccessibleTableModelChange structure.</p> */ const short DELETE = 2; @@ -61,7 +61,7 @@ constants AccessibleTableModelChangeType <p>The number of rows and columns remains unchanged. Only (some of) the content of the cells in the range that is specified by the - fields of the <type>AccessibleTableModelChange</type> structure have + fields of the AccessibleTableModelChange structure have been changed.</p> */ const short UPDATE = 3; diff --git a/offapi/com/sun/star/accessibility/AccessibleTextType.idl b/offapi/com/sun/star/accessibility/AccessibleTextType.idl index 7bad07cd62c9..23df274df2ee 100644 --- a/offapi/com/sun/star/accessibility/AccessibleTextType.idl +++ b/offapi/com/sun/star/accessibility/AccessibleTextType.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module accessibility { <p>This collection describes the types of text portions that can be accessed with the help of the methods of the - <type>XAccessibleText</type> interface.</p> + XAccessibleText interface.</p> @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/accessibility/TextSegment.idl b/offapi/com/sun/star/accessibility/TextSegment.idl index 49630e02b61f..12cf1b672caa 100644 --- a/offapi/com/sun/star/accessibility/TextSegment.idl +++ b/offapi/com/sun/star/accessibility/TextSegment.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module accessibility { /** This structure describes a text segment that is embedded in a larger portion of text. It is used for example by the - <type>XAccessibleText</type> interface to describe a text portion that + XAccessibleText interface to describe a text portion that was inserted into or deleted from an accessible text. <p>The indices <member>TextSegment::SegmentStart</member> and @@ -32,7 +32,7 @@ module com { module sun { module star { module accessibility { The <member>TextSegment::SegmentText</member> member contains the text between these two indices including the start index but not the end index. With it you can use this structure without having to - access the <type>XAccessibleText</type> interface that represents the + access the XAccessibleText interface that represents the enclosing text.</p> <p>An empty text segment is expressed by diff --git a/offapi/com/sun/star/accessibility/XAccessible.idl b/offapi/com/sun/star/accessibility/XAccessible.idl index a738d2b73b04..e8e6c80469e5 100644 --- a/offapi/com/sun/star/accessibility/XAccessible.idl +++ b/offapi/com/sun/star/accessibility/XAccessible.idl @@ -29,20 +29,20 @@ module com { module sun { module star { module accessibility { /** This interface has to be implemented by any class that wants to be accessible. - <p>It is used to provide access to the <type>XAccessibleContext</type> + <p>It is used to provide access to the XAccessibleContext interface but allows at the same time that that interface is implemented by another class.</p> - <p>The distinction between the interfaces <type>XAccessible</type> and - <type>XAccessibleContext</type> makes it possible to split up the + <p>The distinction between the interfaces XAccessible and + XAccessibleContext makes it possible to split up the implementation of the class that is made accessible and the actual accessibility code into two (mostly) independent parts. The only necessary dependence is the <member scope="XAccessible">getAccessibleContext()</member> function that returns the accessible context. This one-way link has to be persistent in some sense: As long as there is at least one reference to - a specific <type>XAccessibleContext</type> object the - <type>XAccessible</type> object has to return the same context for every + a specific XAccessibleContext object the + XAccessible object has to return the same context for every call to <member scope="XAccessible">getAccessibleContext()</member>. This is necessary to allow the use of object identity for comparing accessibility contexts for being equal.</p> @@ -56,11 +56,11 @@ interface XAccessible : ::com::sun::star::uno::XInterface /** Returns the AccessibleContext associated with this object. <p>The idea to let this interface only return an - <type>XAccessibleContext</type> instead of directly supporting its + XAccessibleContext instead of directly supporting its functions is to allow the separation of the implementation of the functions that make a class accessible from the implementation of - that class. You may, of course, implement <type>XAccessible</type> - and <type>XAccessibleContext</type> in one class.</p> + that class. You may, of course, implement XAccessible + and XAccessibleContext in one class.</p> @return A reference to the object that contains the actual accessibility diff --git a/offapi/com/sun/star/accessibility/XAccessibleAction.idl b/offapi/com/sun/star/accessibility/XAccessibleAction.idl index de46557196ca..bb88415901c7 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleAction.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleAction.idl @@ -88,7 +88,7 @@ interface XAccessibleAction : ::com::sun::star::uno::XInterface /** Returns a key binding object, if there is one, associated with the specified action. Note that there can be several alternative key - bindings for an action. See <type>XAccessibleKeyBinding</type> for + bindings for an action. See XAccessibleKeyBinding for more information about how key bindings are represented. @param nIndex diff --git a/offapi/com/sun/star/accessibility/XAccessibleComponent.idl b/offapi/com/sun/star/accessibility/XAccessibleComponent.idl index 583972cbf6c6..bd497266fee1 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleComponent.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleComponent.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module accessibility { interface XAccessible; -/** The <type>XAccessibleComponent</type> interface should be supported by +/** The XAccessibleComponent interface should be supported by any class that can be rendered on the screen. <p>This interface provides the standard mechanism for an assistive @@ -43,7 +43,7 @@ module com { module sun { module star { module accessibility { and <code>javax.accessibility.AccessibleExtendedComponent</code>.</p> <p>Further information about the graphical appearance of an object can - be expressed with the <type>XAccessibleExtendedComponent</type> + be expressed with the XAccessibleExtendedComponent interface.</p> <p>Coordinates used by the functions of this interface are specified in @@ -68,7 +68,7 @@ module com { module sun { module star { module accessibility { bindings are associated with actions and directly with a component. This distinction becomes important when there are more than one action. To get access to the key bindings you have to get the - <type>XAccessibleAction</type> interface of a component, provided that + XAccessibleAction interface of a component, provided that it is supported, and use the <method scope="XAccessibleAction">getAccessibleKeyBinding()</method>.</p> diff --git a/offapi/com/sun/star/accessibility/XAccessibleContext.idl b/offapi/com/sun/star/accessibility/XAccessibleContext.idl index 3ed97715b60e..eccfe0f2adca 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleContext.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleContext.idl @@ -163,7 +163,7 @@ interface XAccessibleContext : ::com::sun::star::uno::XInterface <p>The returned state set is a copy: Changing the returned state set will not be reflected by changing the object's set of states. See - the documentation of <type>XAccessibleStateSet</type> for a + the documentation of XAccessibleStateSet for a description of the individual states.</p> @return @@ -182,7 +182,7 @@ interface XAccessibleContext : ::com::sun::star::uno::XInterface @return If this object does not have a locale, the locale of its parent is returned. If it does not have (yet) a parent it throws the - exception <type>IllegalAccessibleComponentStateException</type>. + exception IllegalAccessibleComponentStateException. @throws IllegalAccessibleComponentStateException when this object does not (yet) have a parent. diff --git a/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl b/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl index ccfbba3fa2f7..af74015ed0d8 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module accessibility { representation. <p>This interface is typically used in conjunction with the - <type>XAccessibleText</type> interface and extents it about the ability + XAccessibleText interface and extents it about the ability to modify the text represented by that interface.</p> @since OOo 1.1.2 diff --git a/offapi/com/sun/star/accessibility/XAccessibleEventBroadcaster.idl b/offapi/com/sun/star/accessibility/XAccessibleEventBroadcaster.idl index e3e859ed1054..a8fa56ea443e 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleEventBroadcaster.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleEventBroadcaster.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module accessibility { interface XAccessibleEventListener; /** makes it possible to register listeners which are called whenever - an accessibility event (see <type>AccessibleEventObject</type>) occurs. + an accessibility event (see AccessibleEventObject) occurs. @see AccessibleEventObject @see XAccessibleEventListener @@ -37,12 +37,12 @@ module com { module sun { module star { module accessibility { interface XAccessibleEventBroadcaster: ::com::sun::star::uno::XInterface { - /** registers the given <type>XAccessibleEventListener</type>. + /** registers the given XAccessibleEventListener. */ void addAccessibleEventListener( [in] XAccessibleEventListener xListener ); - /** unregisters the given <type>XAccessibleEventListener</type>. + /** unregisters the given XAccessibleEventListener. */ void removeAccessibleEventListener( [in] XAccessibleEventListener xListener ); }; diff --git a/offapi/com/sun/star/accessibility/XAccessibleEventListener.idl b/offapi/com/sun/star/accessibility/XAccessibleEventListener.idl index 396c504bbf4d..10cef20d50a7 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleEventListener.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleEventListener.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module accessibility { interface XAccessibleEventListener: ::com::sun::star::lang::XEventListener { - /** is called whenever a accessible event (see <type>AccessibleEventObject</type>) occurs. + /** is called whenever a accessible event (see AccessibleEventObject) occurs. */ void notifyEvent( [in] AccessibleEventObject aEvent ); }; diff --git a/offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl b/offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl index 00762e053b62..a5af6c73b44f 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl @@ -31,12 +31,12 @@ module com { module sun { module star { module accessibility { -/** The <type>XAccessibleExtendedComponent</type> interface contains - additional methods to those of the <type>XAccessibleComponent</type> +/** The XAccessibleExtendedComponent interface contains + additional methods to those of the 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 <type>XAccessibleComponent</type> - interface and only support the <type>XAccessibleExtendedComponent</type> + frequently used methods of the XAccessibleComponent + interface and only support the XAccessibleExtendedComponent interface if that makes sense for the class. <p>This interface provides extended access to retrieve information diff --git a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl index e095eb4c6fea..e6779ac33731 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module accessibility { <p>Single hyperlinks correspond to simple <a href> tags. Groups of hyperlinks are contained in client side image maps. Linked objects and anchors are implementation dependent. This interface inherits the - <type>XAccessibleAction</type> interface. Especially that interface's + XAccessibleAction interface. Especially that interface's <member>XAccessibleAction::getActionCount</member> method is needed to obtain a maximum value for the indices passed to the <member>XAccessibleHyperlink::getAccessibleActionAnchor</member> and @@ -40,7 +40,7 @@ module com { module sun { module star { module accessibility { <p>Furthermore, the object that implements this interface has to be connected implicitly or explicitly with an object that implements the - the <type>XAccessibleText</type> interface. The + the XAccessibleText interface. The <member>XAccessibleHyperlink::getStartIndex</member> and <member>XAccessibleHyperlink::getEndIndex</member> methods return indices with respect to the text exposed by that interface.</p> @@ -91,24 +91,24 @@ interface XAccessibleHyperlink : /** Returns the index at which the textual representation of the hyperlink (group) starts. - <p>The returned value relates to the <type>XAccessibleText</type> + <p>The returned value relates to the XAccessibleText interface that owns this hyperlink.</p> @return The index relates to the text exposed by the - <type>XAccessibleHypertext</type> interface. + XAccessibleHypertext interface. */ long getStartIndex (); /** Returns the index at which the textual representation of the hyperlink (group) ends. - <p>The returned value relates to the <type>XAccessibleText</type> + <p>The returned value relates to the XAccessibleText interface that owns this hyperlink.</p> @return The index relates to the text exposed by the - <type>XAccessibleText</type> interface. + XAccessibleText interface. */ long getEndIndex (); diff --git a/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl b/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl index 92707d3178fb..f05ef585ec0a 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl @@ -31,13 +31,13 @@ module com { module sun { module star { module accessibility { /** Implement this interface to expose the hypertext structure of a document. - <p>The <type>XAccessibleHypertext</type> interface is the main interface + <p>The XAccessibleHypertext interface is the main interface to expose hyperlinks in a document, typically a text document, that are used to reference other (parts of) documents. For supporting the <member>XAccessibleHypertext::getLinkIndex</member> method of this interface and other character related methods of the - <type>XAccessibleHyperlink</type> interface, it is necessary to also - support the <type>XAccessibleText</type> interface.</p> + XAccessibleHyperlink interface, it is necessary to also + support the XAccessibleText interface.</p> @see XAccessibleHyperlink, XAccessibleText @@ -57,7 +57,7 @@ interface XAccessibleHypertext /** Return the specified link. - <p>The returned <type>XAccessibleHyperlink</type> object + <p>The returned XAccessibleHyperlink object encapsulates the hyperlink and provides several kinds of information describing it.</p> @@ -82,7 +82,7 @@ interface XAccessibleHypertext @param nCharIndex Index of the character for which to return the link index. If - the <type>XAccessibleText</type> interface is used to represent + the XAccessibleText interface is used to represent the text containing the link, then the character index is only valid if it is greater than or equal to zero and lower then the number of characters in the text. See that interface's diff --git a/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl b/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl index 8b374aba1d21..5c6a7cb698f9 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl @@ -32,8 +32,8 @@ module com { module sun { module star { module accessibility { <p>There can be zero, one, or more key bindings. Each key binding consists of a sequence of <type scope="::com::sun::star::awt">KeyStroke</type> objects. The association of an action with a key binding is established - by the <type>XAccessibleAction</type> interface returning an - <type>XAccessibleKeyBinding</type> object.</p> + by the XAccessibleAction interface returning an + XAccessibleKeyBinding object.</p> <p>A key binding describes alternative ways how to invoke an action with pressing one or more keys after each other. Each individual sequence of diff --git a/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl b/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl index 8c3cc17e35ff..fd539bc9a7b7 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module accessibility { and line numbers. <p>This interface is typically used in conjunction with the - <type>XAccessibleText</type> interface and extents it with a notion + XAccessibleText interface and extents it with a notion of line numbers</p> @since OOo 3.0 diff --git a/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl b/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl index 02fbd70bd51a..db940a0b8fd6 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl @@ -28,9 +28,9 @@ module com { module sun { module star { module accessibility { /** Implement this interface to give access to an object's set of relations. - <p>Such relation are modeled with the <type>AccessibleRelation</type> + <p>Such relation are modeled with the AccessibleRelation structure. This interface is used for representing sets of relations - between <type>Accessible</type> objects. Most of the convenience + between Accessible objects. Most of the convenience methods of the corresponding AccessibleRelationSet interface of the Java Accessibility API have been removed from this interface in order to clean it up. These methods are <member>add</member>, @@ -71,7 +71,7 @@ interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface @param aRelationType The type of relation to look for in this set of relations. This has to be one of the constants of - <type>AccessibleRelationType</type>. + AccessibleRelationType. @return Returns <TRUE/> if there is a (at least one) relation of the @@ -83,7 +83,7 @@ interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface @param aRelationType The type of the relation to return. This has to be one of the - constants of <type>AccessibleRelationType</type>. + constants of AccessibleRelationType. @return If a relation with the given type could be found than (a copy diff --git a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl index 2db010ae78db..c8ed13aee1bc 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl @@ -33,8 +33,8 @@ module com { module sun { module star { module accessibility { currently selected children. Every object that has children that can be selected should support this interface.</p> - <p>The <type>XAccessibleSelection</type> interface has to be implemented - in conjunction with the <type>XAccessibleContext</type> interface that + <p>The XAccessibleSelection interface has to be implemented + in conjunction with the XAccessibleContext interface that provides the children on which the first operates.</p> <p>It depends on the class implementing this interface, whether it @@ -44,7 +44,7 @@ module com { module sun { module star { module accessibility { */ interface XAccessibleSelection : ::com::sun::star::uno::XInterface { - /** Selects the specified <type>Accessible</type> child of the + /** Selects the specified Accessible child of the object. <p>Depending on the implementing class the child is added to the @@ -119,7 +119,7 @@ interface XAccessibleSelection : ::com::sun::star::uno::XInterface @return If the index is valid, i.e. not negative and lower than the number of selected children, then a valid reference to the - corresponding <type>XAccessible</type> child is returned. + corresponding XAccessible child is returned. Otherwise an exception is thrown. @throws ::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to diff --git a/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl b/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl index 170f4e1e9391..e08e194587a2 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl @@ -29,10 +29,10 @@ module com { module sun { module star { module accessibility { /** Implement this interface to represent a set of states. - <p>The interface <type>XAccessibleStateSet</type> represents a set of + <p>The interface XAccessibleStateSet represents a set of states of an accessible object. It can hold any combination of states defined by the constants collection - <type>AccessibleStateType</type>.</p> + AccessibleStateType.</p> @since OOo 1.1.2 */ @@ -51,7 +51,7 @@ interface XAccessibleStateSet : ::com::sun::star::uno::XInterface @param aState The state for which to check membership. This has to be one of - the constants of <type>AccessibleStateType</type>. + the constants of AccessibleStateType. @return Returns <TRUE/> if the given state is a member of this object's @@ -66,7 +66,7 @@ interface XAccessibleStateSet : ::com::sun::star::uno::XInterface This sequence of states is interpreted as set and every of its members, duplicates are ignored, is checked for membership in this object's state set. Each state has to be one of the - constants of <type>AccessibleStateType</type>. + constants of AccessibleStateType. @return Returns <TRUE/> if all states of the given state set are members diff --git a/offapi/com/sun/star/accessibility/XAccessibleTable.idl b/offapi/com/sun/star/accessibility/XAccessibleTable.idl index 221c92bbd7c4..ea60a3b8ac22 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTable.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTable.idl @@ -29,13 +29,13 @@ module com { module sun { module star { module accessibility { /** Implement this interface to give access to a two-dimensional table. - <p>The <type>XAccessibleTable</type> interface is used to represent + <p>The XAccessibleTable interface is used to represent two-dimensional tables. This interface combines the two interfaces <code>javax.accessibility.AccessibleTable</code> and <code>javax.accessibility.AccessibleExtendedTable</code> of the Java Accessibility API (version 1.4).</p> - <p>All <type>XAccessible</type> objects that represent cells or + <p>All XAccessible objects that represent cells or cell-clusters of a table have to be at the same time children of the table. This is necessary to be able to convert row and column indices into child indices and vice versa with the methods @@ -165,7 +165,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface long getAccessibleColumnExtentAt ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); - /** Returns the row headers as an <type>XAccessibleTable</type> + /** Returns the row headers as an XAccessibleTable object. <p>Content and size of the returned table are implementation @@ -173,11 +173,11 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @return Returns always a valid reference to an - <type>XAccessibleTable</type> object. + XAccessibleTable object. */ XAccessibleTable getAccessibleRowHeaders (); - /** Returns the column headers as an <type>XAccessibleTable</type> + /** Returns the column headers as an XAccessibleTable object. <p>Content and size of the returned table are implementation @@ -185,7 +185,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @return Returns always a valid reference to an - <type>XAccessibleTable</type> object. + XAccessibleTable object. */ XAccessibleTable getAccessibleColumnHeaders (); @@ -246,7 +246,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface boolean isAccessibleColumnSelected ([in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); - /** Returns the <type>XAccessible</type> object at the specified row + /** Returns the XAccessible object at the specified row and column in the table. <p>This method has been renamed from the Java name @@ -264,7 +264,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @return If both row and column index are valid then the corresponding - <type>XAccessible</type> object is returned that represents the + XAccessible object is returned that represents the requested cell regardless of whether the cell is currently visible (on the screen). @@ -288,7 +288,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @return Returns a reference to an implementation dependent - <type>XAccessible</type> object representing the table's summary + XAccessible object representing the table's summary or an empty reference if the table does not support a summary. */ XAccessible getAccessibleSummary (); diff --git a/offapi/com/sun/star/accessibility/XAccessibleText.idl b/offapi/com/sun/star/accessibility/XAccessibleText.idl index c020d518d078..c00da1635e9b 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleText.idl @@ -33,12 +33,12 @@ module com { module sun { module star { module accessibility { /** Implement this interface to give read-only access to a text. - <p>The <type>XAccessibleText</type> interface should be implemented by + <p>The XAccessibleText interface should be implemented by all UNO components that present textual information on the display like buttons, text entry fields, or text portions of the document window. The interface provides access to the text's content, attributes, and spatial location. However, text can not be modified with this - interface. That is the task of the <type>XAccessibleEditableText</type> + interface. That is the task of the XAccessibleEditableText interface.</p> <p>The text length, i.e. the number of characters in the text, is @@ -364,7 +364,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface @param nTextType The type of the text portion to return. See - <type>AccessibleTextType</type> for the complete list. + AccessibleTextType for the complete list. @return Returns the requested text portion. This portion may be empty @@ -403,7 +403,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface @param nTextType The type of the text portion to return. See - <type>AccessibleTextType</type> for the complete list. + AccessibleTextType for the complete list. @return Returns the requested text portion. This portion may be empty @@ -441,7 +441,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface @param nTextType The type of the text portion to return. See - <type>AccessibleTextType</type> for the complete list. + AccessibleTextType for the complete list. @return Returns the requested text portion. This portion may be empty @@ -466,7 +466,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface <p>The other clipboard related methods <member>XAccessibleEditableText::cutText</member> and <member>XAccessibleEditableText::deleteText</member> can be found in - the <type>XAccessibleEditableText</type> because of their + the XAccessibleEditableText because of their destructive nature.</p> @param nStartIndex diff --git a/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl b/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl index 99cb6706c7c3..af571d58c494 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl @@ -33,13 +33,13 @@ module com { module sun { module star { module accessibility { /** Implement this interface to expose the text markups of a text. - <p>The <type>XAccessibleTextMarkup</type> interface is the main interface + <p>The XAccessibleTextMarkup interface is the main interface to expose text markups in a text, typically of a text document, that are used to reference other (parts of) documents. For supporting the <member>XAccessibleTextMarkup::getTextMarkupIndex</member> method of this interface and other character related methods of the - <type>XAccessibleTextMarkup</type> interface, it is necessary to also - support the <type>XAccessibleText</type> interface.</p> + XAccessibleTextMarkup interface, it is necessary to also + support the XAccessibleText interface.</p> @see XAccessibleText @@ -51,12 +51,12 @@ interface XAccessibleTextMarkup /** Returns the number of text markup of the given text markup type of a text. - <p>Throws <type>IllegalArgumentException</type>, if given text + <p>Throws IllegalArgumentException, if given text markup type is out of valid range.</p> @param TextMarkupType This specifies the type of text markups, whose count should - be returned - see <type>TextMarkupType</type>. + be returned - see TextMarkupType. @return The number of text markup of the given text markup type. @@ -68,9 +68,9 @@ interface XAccessibleTextMarkup /** Returns the text segment of the text markup of the given index and of the given text mark type - <p>Throws <type>IndexOutOfBoundsException</type>, if given index + <p>Throws IndexOutOfBoundsException, if given index is out of valid range.</p> - <p>Throws <type>IllegalArgumentException</type>, if given text + <p>Throws IllegalArgumentException, if given text markup type is out of valid range.</p> @param TextMarkupIndex @@ -78,11 +78,11 @@ interface XAccessibleTextMarkup @param TextMarkupType This specifies the type of the text markup to be returned - see - <type>TextMarkupType</type>. + TextMarkupType. @return If the given index is in range [0..getTextMarkupCount(TextMarkupType)-1], - the text segment - see <type>TextSegment</type> - of the text markup + the text segment - see TextSegment - of the text markup of the given text markup type is returned. */ TextSegment getTextMarkup ( [in] long TextMarkupIndex, @@ -93,9 +93,9 @@ interface XAccessibleTextMarkup /** returns a sequence of the text segments of the text markups at the given character index and of the given text markup type. - <p>Throws <type>IndexOutOfBoundsException</type>, if given character + <p>Throws IndexOutOfBoundsException, if given character index is out of range [0..number of characters in the text).</p> - <p>Throws <type>IllegalArgumentException</type>, if given text + <p>Throws IllegalArgumentException, if given text markup type is out of valid range.</p> @param CharIndex @@ -103,11 +103,11 @@ interface XAccessibleTextMarkup @param TextMarkupType This specifies the type of the text markups to be returned - see - <type>TextMarkupType</type>. + TextMarkupType. @return If character index is in range [0..number of characters in the text-1], - a sequence of <type>TextSegment</type>s of the text markups at + a sequence of TextSegments of the text markups at given character index of the given text markup type are returned. The sequence is empty, if no such text markup is found. */ diff --git a/offapi/com/sun/star/accessibility/XAccessibleValue.idl b/offapi/com/sun/star/accessibility/XAccessibleValue.idl index 9d752c88852c..22984f7370a7 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleValue.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleValue.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module accessibility { /** Implement this interface to give access to a single numerical value. - <p>The <type>XAccessibleValue</type> interface represents a single + <p>The XAccessibleValue interface represents a single numerical value and should be implemented by any class that supports numerical value like scroll bars and spin boxes. This interface lets you access the value and its upper and lower bounds.</p> |