Kaydet (Commit) 62484054 authored tarafından Aurimas Fišeras's avatar Aurimas Fišeras Kaydeden (comit) Michael Meeks

Fix some typos in documentation

üst 68d23b48
...@@ -39,7 +39,7 @@ module com { module sun { module star { module accessibility { ...@@ -39,7 +39,7 @@ module com { module sun { module star { module accessibility {
actual information that is needed to make it accessible.</p> actual information that is needed to make it accessible.</p>
<p>Service <code>Accessible</code> is just a wrapper for the interface <p>Service <code>Accessible</code> is just a wrapper for the interface
<code>XAccessible</code>. See the interface's documention for more <code>XAccessible</code>. See the interface's documentation for more
information.</p> information.</p>
@see XAccessible @see XAccessible
......
...@@ -154,7 +154,7 @@ published constants AccessibleEventId ...@@ -154,7 +154,7 @@ published constants AccessibleEventId
*/ */
const short SELECTION_CHANGED = 9; const short SELECTION_CHANGED = 9;
/** A visibile data event indicates the change of the visual appearance /** A visible data event indicates the change of the visual appearance
of an accessible object. This includes for example most of the of an accessible object. This includes for example most of the
attributes available over the <type>XAccessibleComponent</type> and attributes available over the <type>XAccessibleComponent</type> and
<type>XAccessibleExtendedComponent</type> interfaces. The <type>XAccessibleExtendedComponent</type> interfaces. The
...@@ -168,7 +168,7 @@ published constants AccessibleEventId ...@@ -168,7 +168,7 @@ published constants AccessibleEventId
<member>AccessibleEventObject::OldValue</member> and <member>AccessibleEventObject::OldValue</member> and
<member>AccessibleEventObject::NewValue</member> field contain the <member>AccessibleEventObject::NewValue</member> field contain the
old and new value as a number. Its exact type is implementation old and new value as a number. Its exact type is implementation
dependant but has to be the same as is returned by the dependent but has to be the same as is returned by the
<member>XAccessibleValue::getCurrentValue</member> function. <member>XAccessibleValue::getCurrentValue</member> function.
*/ */
...@@ -179,7 +179,7 @@ published constants AccessibleEventId ...@@ -179,7 +179,7 @@ published constants AccessibleEventId
<p>Not used: The <member>AccessibleEventObject::OldValue</member> and <p>Not used: The <member>AccessibleEventObject::OldValue</member> and
<member>AccessibleEventObject::NewValue</member> fields contain <member>AccessibleEventObject::NewValue</member> fields contain
refrences to the old and new predecessor. Note that both references references to the old and new predecessor. Note that both references
my be <NULL/> to indicate that a flow to the sending object has not my be <NULL/> to indicate that a flow to the sending object has not
existed or does not exist anymore.</p> existed or does not exist anymore.</p>
*/ */
...@@ -190,7 +190,7 @@ published constants AccessibleEventId ...@@ -190,7 +190,7 @@ published constants AccessibleEventId
<p>Not used: The <member>AccessibleEventObject::OldValue</member> and <p>Not used: The <member>AccessibleEventObject::OldValue</member> and
<member>AccessibleEventObject::NewValue</member> fields contain <member>AccessibleEventObject::NewValue</member> fields contain
refrences to the old and new successor. Note that both references references to the old and new successor. Note that both references
my be <NULL/> to indicate that a flow from the sending object has not my be <NULL/> to indicate that a flow from the sending object has not
existed or does not exist anymore.</p> existed or does not exist anymore.</p>
*/ */
...@@ -287,14 +287,14 @@ published constants AccessibleEventId ...@@ -287,14 +287,14 @@ published constants AccessibleEventId
fields remain empty. In this case the whole text may have changed fields remain empty. In this case the whole text may have changed
and the listener should refetch the text completely.</li> </ol> and the listener should refetch the text completely.</li> </ol>
<p>When broadcasting an event allways prefer the first three cases <p>When broadcasting an event always prefer the first three cases
to the last one. Use it only as a last resort.</p> to the last one. Use it only as a last resort.</p>
<p> Text ranges should be as small as possible but, of course, <p> Text ranges should be as small as possible but, of course,
include all the text that is involved in a modification. That means include all the text that is involved in a modification. That means
that when two or more discontiguous text ranges are inserted, that when two or more discontinuous text ranges are inserted,
deleted, or otherwise modified the two fields of the event have to deleted, or otherwise modified the two fields of the event have to
cover all the effected text ranges as well as the text in cover all the affected text ranges as well as the text in
between.</p> between.</p>
*/ */
const short TEXT_CHANGED = 22; const short TEXT_CHANGED = 22;
......
...@@ -31,7 +31,7 @@ module com { module sun { module star { module accessibility { ...@@ -31,7 +31,7 @@ module com { module sun { module star { module accessibility {
/** Collection of relation types. /** Collection of relation types.
<p>This list of constants defines the availabe types of relations that <p>This list of constants defines the available types of relations that
are usable by <type>AccessibleRelation</type>.</p> are usable by <type>AccessibleRelation</type>.</p>
<p>We are using constants instead of a more typesafe enum. The reason <p>We are using constants instead of a more typesafe enum. The reason
...@@ -76,7 +76,7 @@ published constants AccessibleRelationType ...@@ -76,7 +76,7 @@ published constants AccessibleRelationType
*/ */
const short CONTROLLER_FOR = 4; const short CONTROLLER_FOR = 4;
/** Lable-for relation type. /** Label-for relation type.
<p>Indicates an object is a label for one or more target <p>Indicates an object is a label for one or more target
objects.</p> objects.</p>
...@@ -107,7 +107,7 @@ published constants AccessibleRelationType ...@@ -107,7 +107,7 @@ published constants AccessibleRelationType
/** Node-Child-of relation type. /** Node-Child-of relation type.
<p>Indicates an object is a cell in a tree or treetable which is <p>Indicates an object is a cell in a tree or tree table which is
displayed because a cell in the same column is expanded and displayed because a cell in the same column is expanded and
identifies that cell.</p> identifies that cell.</p>
......
...@@ -32,9 +32,9 @@ module com { module sun { module star { module accessibility { ...@@ -32,9 +32,9 @@ module com { module sun { module star { module accessibility {
/** Collection of roles. /** Collection of roles.
<p>This collection of constans defines the set of possible roles of <p>This collection of constants defines the set of possible roles of
classes implementing the <type>XAccessible</type> interface according to classes implementing the <type>XAccessible</type> interface according to
the java class javax.accessibility.AccessibleRole. The role of an the Java class javax.accessibility.AccessibleRole. The role of an
object describes its generic function like 'button', 'menu', or 'text'. object describes its generic function like 'button', 'menu', or 'text'.
You can obtain an object's role by calling the You can obtain an object's role by calling the
<member>getAccessibleRole</member> method of the <member>getAccessibleRole</member> method of the
...@@ -46,7 +46,7 @@ module com { module sun { module star { module accessibility { ...@@ -46,7 +46,7 @@ module com { module sun { module star { module accessibility {
here.</p> here.</p>
<p>For some roles there exist two labels with the same value. Please <p>For some roles there exist two labels with the same value. Please
use the one with the underscrores. The other ones are somewhat use the one with the underscores. The other ones are somewhat
deprecated and will be removed in the future. </p> deprecated and will be removed in the future. </p>
@see XAccessibleContext @see XAccessibleContext
...@@ -73,7 +73,7 @@ published constants AccessibleRole ...@@ -73,7 +73,7 @@ published constants AccessibleRole
/** Object that can be drawn into and is used to trap events. /** Object that can be drawn into and is used to trap events.
<p>See alse <const>FRAME</const>, <const>GLASS_PANE</const>, and <p>See also <const>FRAME</const>, <const>GLASS_PANE</const>, and
<const>LAYERED_PANE</const>.</p> <const>LAYERED_PANE</const>.</p>
*/ */
const short CANVAS = 3; const short CANVAS = 3;
...@@ -148,11 +148,11 @@ published constants AccessibleRole ...@@ -148,11 +148,11 @@ published constants AccessibleRole
/** View of a document. /** View of a document.
<p>The view of an actual document. Its content depends on the <p>The view of an actual document. Its content depends on the
documen type.</p> document type.</p>
*/ */
const short DOCUMENT = 13; const short DOCUMENT = 13;
/** Embeded (OLE) object. /** Embedded (OLE) object.
*/ */
const short EMBEDDED_OBJECT = 14; const short EMBEDDED_OBJECT = 14;
...@@ -372,7 +372,7 @@ published constants AccessibleRole ...@@ -372,7 +372,7 @@ published constants AccessibleRole
*/ */
const short PASSWORD_TEXT = 42; const short PASSWORD_TEXT = 42;
/** Popup menu role. /** Pop-up menu role.
<p>A temporary window that is usually used to offer the user a list <p>A temporary window that is usually used to offer the user a list
of choices, and then hides when the user selects one of those of choices, and then hides when the user selects one of those
...@@ -431,7 +431,7 @@ published constants AccessibleRole ...@@ -431,7 +431,7 @@ published constants AccessibleRole
<p>An object usually used to allow a user to incrementally view a <p>An object usually used to allow a user to incrementally view a
large amount of data. Usually used only by a scroll pane.</p> large amount of data. Usually used only by a scroll pane.</p>
<p>Ssee also <const>SCROLL_PANE</const>.</p> <p>See also <const>SCROLL_PANE</const>.</p>
*/ */
const short SCROLL_BAR = 50; const short SCROLL_BAR = 50;
...@@ -539,7 +539,7 @@ published constants AccessibleRole ...@@ -539,7 +539,7 @@ published constants AccessibleRole
/** Tool tip role. /** Tool tip role.
<p>An object that provides information about another object. The <p>An object that provides information about another object. The
accessibleDescription property of the tool tip is often displayed to accessible Description property of the tool tip is often displayed to
the user in a small "help bubble" when the user causes the mouse to the user in a small "help bubble" when the user causes the mouse to
hover over the object associated with the tool tip.</p> hover over the object associated with the tool tip.</p>
*/ */
......
...@@ -123,7 +123,7 @@ published constants AccessibleStateType ...@@ -123,7 +123,7 @@ published constants AccessibleStateType
(given by the event) should be not transient to make it possible (given by the event) should be not transient to make it possible
to add listener to this object and recognize changes in this object. to add listener to this object and recognize changes in this object.
The state is added to make a performance improvment. Now it is no The state is added to make a performance improvement. Now it is no
longer necessary to iterate over all children to find out whether longer necessary to iterate over all children to find out whether
they are transient or not to decide whether to add listener or not. they are transient or not to decide whether to add listener or not.
If there is a object with this state no one should iterate over the If there is a object with this state no one should iterate over the
...@@ -189,7 +189,7 @@ published constants AccessibleStateType ...@@ -189,7 +189,7 @@ published constants AccessibleStateType
all of its parents have set the <const>VISIBLE</const> state and it all of its parents have set the <const>VISIBLE</const> state and it
lies at least partly inside the visible area of its parent. It is, lies at least partly inside the visible area of its parent. It is,
though, not necessarily visible on the screen because it may be though, not necessarily visible on the screen because it may be
ocluded by other objects.</p> occluded by other objects.</p>
*/ */
const short SHOWING = 25; const short SHOWING = 25;
......
...@@ -37,14 +37,14 @@ module com { module sun { module star { module accessibility { ...@@ -37,14 +37,14 @@ module com { module sun { module star { module accessibility {
/** Type of a change made to a table model. /** Type of a change made to a table model.
<p>The value of this constants group are used by the <p>The value of this constants group are used by the
<type>AccessibleTableModelChange</type> structure to specifiy the <type>AccessibleTableModelChange</type> structure to specify the
type of change that has been made to a table model.</p> type of change that has been made to a table model.</p>
<p>Two of the constants, <p>Two of the constants,
<const>AccessibleTableModelChangeType::INSERT</const> and <const>AccessibleTableModelChangeType::INSERT</const> and
<const>AccessibleTableModelChangeType::DELETE</const> describe <const>AccessibleTableModelChangeType::DELETE</const> describe
changes to the table's geometry. One or more rows and/or columns have changes to the table's geometry. One or more rows and/or columns have
been inserted or deleted. In constrast, the remaining constant been inserted or deleted. In contrast, the remaining constant
<const>AccessibleTabelModelChangeType::UPDATE</const> specifies a <const>AccessibleTabelModelChangeType::UPDATE</const> specifies a
change of the table's content.</p> change of the table's content.</p>
......
...@@ -51,7 +51,7 @@ published constants AccessibleTextType ...@@ -51,7 +51,7 @@ published constants AccessibleTextType
<p>Indicates that single words are used. The definition of what a <p>Indicates that single words are used. The definition of what a
word is is implementation and language/locale dependent. While in word is is implementation and language/locale dependent. While in
english a word is ended by a space or a special character like a English a word is ended by a space or a special character like a
comma or a period, this is not necessarily true in other comma or a period, this is not necessarily true in other
languages.</p> languages.</p>
*/ */
...@@ -61,7 +61,7 @@ published constants AccessibleTextType ...@@ -61,7 +61,7 @@ published constants AccessibleTextType
<p>Indicates that single sentences are used. The definition of what <p>Indicates that single sentences are used. The definition of what
a sentence is is implementation and language/locale dependent. a sentence is is implementation and language/locale dependent.
While in english a sentence is ended by a period, this is not While in English a sentence is ended by a period, this is not
necessarily true in other languages.</p> necessarily true in other languages.</p>
*/ */
const short SENTENCE = 3; const short SENTENCE = 3;
......
...@@ -36,7 +36,7 @@ module com { module sun { module star { module accessibility { ...@@ -36,7 +36,7 @@ module com { module sun { module star { module accessibility {
/** Indicates invalid or unavailable state information. /** Indicates invalid or unavailable state information.
<p>This exception is thrown to indicate the an accessibilty component <p>This exception is thrown to indicate the an accessibility component
has been queried for state information that it can not provide. Used by has been queried for state information that it can not provide. Used by
<member>XAccessibleContext::getLocale</member>.</p> <member>XAccessibleContext::getLocale</member>.</p>
......
...@@ -47,10 +47,10 @@ module com { module sun { module star { module accessibility { ...@@ -47,10 +47,10 @@ module com { module sun { module star { module accessibility {
<type>XAccessibleContext</type> makes it possible to split up the <type>XAccessibleContext</type> makes it possible to split up the
implementation of the implementation of the
class that is made accessible and the actual accessibility code into two class that is made accessible and the actual accessibility code into two
(mostly) independant parts. The only necessary dependance is the (mostly) independent parts. The only necessary dependence is the
<member scope="XAccessible">getAccessibleContext()</member> function <member scope="XAccessible">getAccessibleContext()</member> function
that returns the accessible context. This one-way link has to be that returns the accessible context. This one-way link has to be
persistant in some sense: As long as there is at least one reference to persistent in some sense: As long as there is at least one reference to
a specific <type>XAccessibleContext</type> object the a specific <type>XAccessibleContext</type> object the
<type>XAccessible</type> object has to return the same context for every <type>XAccessible</type> object has to return the same context for every
call to <member scope="XAccessible">getAccessibleContext()</member>. call to <member scope="XAccessible">getAccessibleContext()</member>.
...@@ -67,7 +67,7 @@ published interface XAccessible : ::com::sun::star::uno::XInterface ...@@ -67,7 +67,7 @@ published interface XAccessible : ::com::sun::star::uno::XInterface
<p>The idea to let this interface only return an <p>The idea to let this interface only return an
<type>XAccessibleContext</type> instead of directly supporting its <type>XAccessibleContext</type> instead of directly supporting its
functions is to allow the seperation of the implementation of the functions is to allow the separation of the implementation of the
functions that make a class accessible from the implementation of functions that make a class accessible from the implementation of
that class. You may, of course, implement <type>XAccessible</type> that class. You may, of course, implement <type>XAccessible</type>
and <type>XAccessibleContext</type> in one class.</p> and <type>XAccessibleContext</type> in one class.</p>
......
...@@ -72,7 +72,7 @@ module com { module sun { module star { module accessibility { ...@@ -72,7 +72,7 @@ module com { module sun { module star { module accessibility {
<p>Coordinates used by the functions of this interface are specified in <p>Coordinates used by the functions of this interface are specified in
different coordinate systems. Their scale is the same and is equal to different coordinate systems. Their scale is the same and is equal to
that of the screen coordiante system. In other words all coordinates that of the screen coordinate system. In other words all coordinates
are measured in pixel. They differ in their respective origin: are measured in pixel. They differ in their respective origin:
<ul><li>The screen coordinate system has its origin in the upper left <ul><li>The screen coordinate system has its origin in the upper left
corner of the current screen. Used by the corner of the current screen. Used by the
...@@ -113,7 +113,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface ...@@ -113,7 +113,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface
Coordinates of the point to test. The origin of the coordinate Coordinates of the point to test. The origin of the coordinate
system is the upper left corner of the object's bounding box as system is the upper left corner of the object's bounding box as
returned by the <method>getBounds</method>. The scale of the returned by the <method>getBounds</method>. The scale of the
coordinate system is identical to that of the screen coordiante coordinate system is identical to that of the screen coordinate
system. system.
@return @return
...@@ -134,7 +134,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface ...@@ -134,7 +134,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface
child. The origin of the coordinate system is the upper left child. The origin of the coordinate system is the upper left
corner of the object's bounding box as returned by the corner of the object's bounding box as returned by the
<method>getBounds</method>. The scale of the coordinate <method>getBounds</method>. The scale of the coordinate
system is identical to that of the screen coordiante system. system is identical to that of the screen coordinate system.
@return @return
If there is one child which is rendered so that its bounding box If there is one child which is rendered so that its bounding box
...@@ -159,7 +159,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface ...@@ -159,7 +159,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface
The coordinates of the returned rectangle are relative to this The coordinates of the returned rectangle are relative to this
object's parent or relative to the screen on which this object object's parent or relative to the screen on which this object
is rendered if it has no parent. If the object is not on any is rendered if it has no parent. If the object is not on any
screen the returnred rectangle is empty and located at position screen the returned rectangle is empty and located at position
(0,0). (0,0).
*/ */
::com::sun::star::awt::Rectangle getBounds (); ::com::sun::star::awt::Rectangle getBounds ();
...@@ -174,7 +174,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface ...@@ -174,7 +174,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface
The coordinates of the returned position are relative to this The coordinates of the returned position are relative to this
object's parent or relative to the screen on which this object object's parent or relative to the screen on which this object
is rendered if it has no parent. If the object is not on any is rendered if it has no parent. If the object is not on any
screen the returnred position is (0,0). screen the returned position is (0,0).
*/ */
::com::sun::star::awt::Point getLocation (); ::com::sun::star::awt::Point getLocation ();
...@@ -190,7 +190,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface ...@@ -190,7 +190,7 @@ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface
@return @return
The coordinates of the returned position are relative to the The coordinates of the returned position are relative to the
screen on which this object is rendered. If the object is not screen on which this object is rendered. If the object is not
on any screen the returnred position is (0,0). on any screen the returned position is (0,0).
*/ */
::com::sun::star::awt::Point getLocationOnScreen (); ::com::sun::star::awt::Point getLocationOnScreen ();
......
...@@ -79,7 +79,7 @@ published interface XAccessibleContext : ::com::sun::star::uno::XInterface ...@@ -79,7 +79,7 @@ published interface XAccessibleContext : ::com::sun::star::uno::XInterface
/** Returns the i-th child of this object. /** Returns the i-th child of this object.
<p>The order in which the children are enumerated is implementation <p>The order in which the children are enumerated is implementation
dependend.</p> dependent.</p>
@param i @param i
The index may have any value. If it is outside the range from 0 The index may have any value. If it is outside the range from 0
...@@ -162,8 +162,8 @@ published interface XAccessibleContext : ::com::sun::star::uno::XInterface ...@@ -162,8 +162,8 @@ published interface XAccessibleContext : ::com::sun::star::uno::XInterface
/** Returns the set of relations defined for this object. /** Returns the set of relations defined for this object.
<p>The returned set of relations is a copy of this objects relation <p>The returned set of relations is a copy of this object's relation
set: changing the returned object does not change this objects set: changing the returned object does not change this object's
relations.</p> relations.</p>
<p>aThere are two ways to represent an empty list of relations: <p>aThere are two ways to represent an empty list of relations:
...@@ -171,7 +171,7 @@ published interface XAccessibleContext : ::com::sun::star::uno::XInterface ...@@ -171,7 +171,7 @@ published interface XAccessibleContext : ::com::sun::star::uno::XInterface
empty list. empty list.
@return @return
The returned value is either an empty referece or a reference to The returned value is either an empty reference or a reference to
a valid object that represents a copy of the objects list of a valid object that represents a copy of the objects list of
relations. relations.
*/ */
...@@ -181,7 +181,7 @@ published interface XAccessibleContext : ::com::sun::star::uno::XInterface ...@@ -181,7 +181,7 @@ published interface XAccessibleContext : ::com::sun::star::uno::XInterface
object. object.
<p>The returned state set is a copy: Changing the returned state set <p>The returned state set is a copy: Changing the returned state set
will not be refelected by changing the object's set of states. See will not be reflected by changing the object's set of states. See
the documentation of <type>XAccessibleStateSet</type> for a the documentation of <type>XAccessibleStateSet</type> for a
description of the individual states.</p> description of the individual states.</p>
......
...@@ -76,7 +76,7 @@ published interface XAccessibleExtendedComponent : XAccessibleComponent ...@@ -76,7 +76,7 @@ published interface XAccessibleExtendedComponent : XAccessibleComponent
/** Returns the font of this object. /** Returns the font of this object.
@return @return
The returend reference to a font object is empty if a font is not The returned reference to a font object is empty if a font is not
supported by this object. supported by this object.
*/ */
::com::sun::star::awt::XFont getFont (); ::com::sun::star::awt::XFont getFont ();
......
...@@ -50,8 +50,8 @@ module com { module sun { module star { module accessibility { ...@@ -50,8 +50,8 @@ module com { module sun { module star { module accessibility {
<member>XAccessibleHyperlink::getAccessibleActionObject</member> <member>XAccessibleHyperlink::getAccessibleActionObject</member>
methods.</p> methods.</p>
<p>Furhtermore, the object that implements this interface has to be <p>Furthermore, the object that implements this interface has to be
connected implicitely or explicitely with an object that implements the connected implicitly or explicitly with an object that implements the
the <type>XAccessibleText</type> interface. The the <type>XAccessibleText</type> interface. The
<member>XAccessibleHyperlink::getStartIndex</member> and <member>XAccessibleHyperlink::getStartIndex</member> and
<member>XAccessibleHyperlink::getEndIndex</member> methods return <member>XAccessibleHyperlink::getEndIndex</member> methods return
...@@ -71,7 +71,7 @@ published interface XAccessibleHyperlink : ...@@ -71,7 +71,7 @@ published interface XAccessibleHyperlink :
@param nIndex @param nIndex
This index identifies the anchor when, as in the case of an This index identifies the anchor when, as in the case of an
image map, there is more than one link represented by this image map, there is more than one link represented by this
object. The valid maximal index can be determinded by calling object. The valid maximal index can be determined by calling
the <member>XAccessibleAction::getActionCount</member> method. the <member>XAccessibleAction::getActionCount</member> method.
@return @return
...@@ -90,7 +90,7 @@ published interface XAccessibleHyperlink : ...@@ -90,7 +90,7 @@ published interface XAccessibleHyperlink :
@param nIndex @param nIndex
This index identifies the action object when, as in the case of This index identifies the action object when, as in the case of
an image map, there is more than one link represented by this an image map, there is more than one link represented by this
object. The valid maximal index can be determinded by calling object. The valid maximal index can be determined by calling
the <member>XAccessibleAction::getActionCount</member> method. the <member>XAccessibleAction::getActionCount</member> method.
@return @return
...@@ -104,7 +104,7 @@ published interface XAccessibleHyperlink : ...@@ -104,7 +104,7 @@ published interface XAccessibleHyperlink :
hyperlink (group) starts. hyperlink (group) starts.
<p>The returned value relates to the <type>XAccessibleText</type> <p>The returned value relates to the <type>XAccessibleText</type>
interface that ownes this hyperlink.</p> interface that owns this hyperlink.</p>
@return @return
The index relates to the text exposed by the The index relates to the text exposed by the
...@@ -112,11 +112,11 @@ published interface XAccessibleHyperlink : ...@@ -112,11 +112,11 @@ published interface XAccessibleHyperlink :
*/ */
long getStartIndex (); long getStartIndex ();
/** Returns the index at which the textual rerpesentation of the /** Returns the index at which the textual representation of the
hyperlink (group) ends. hyperlink (group) ends.
<p>The returned value relates to the <type>XAccessibleText</type> <p>The returned value relates to the <type>XAccessibleText</type>
interface that ownes this hyperlink.</p> interface that owns this hyperlink.</p>
@return @return
The index relates to the text exposed by the The index relates to the text exposed by the
......
...@@ -79,7 +79,7 @@ published interface XAccessibleHypertext ...@@ -79,7 +79,7 @@ published interface XAccessibleHypertext
This index specifies the hyperlink to return. This index specifies the hyperlink to return.
@return @return
If the given index is valid, i.e. lies in the intervall from 0 If the given index is valid, i.e. lies in the interval from 0
to the number of links minus one, a reference to the specified to the number of links minus one, a reference to the specified
hyperlink object is returned. If the index is invalid then an hyperlink object is returned. If the index is invalid then an
empty reference is returned. empty reference is returned.
...@@ -97,7 +97,7 @@ published interface XAccessibleHypertext ...@@ -97,7 +97,7 @@ published interface XAccessibleHypertext
@param nCharIndex @param nCharIndex
Index of the character for which to return the link index. If Index of the character for which to return the link index. If
the <type>XAccessibleText</type> interface is used to represent the <type>XAccessibleText</type> interface is used to represent
the text containting the link, then the character index is only 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 valid if it is greater than or equal to zero and lower then the
number of characters in the text. See that interface's number of characters in the text. See that interface's
documentation for more details. documentation for more details.
......
...@@ -53,7 +53,7 @@ published interface XAccessibleImage : ::com::sun::star::uno::XInterface ...@@ -53,7 +53,7 @@ published interface XAccessibleImage : ::com::sun::star::uno::XInterface
embedded into a document.)</p> embedded into a document.)</p>
@return @return
Returns a localized string that describes the images's function Returns a localized string that describes the image's function
or content. or content.
*/ */
string getAccessibleImageDescription (); string getAccessibleImageDescription ();
......
...@@ -73,7 +73,7 @@ interface XAccessibleMultiLineText ...@@ -73,7 +73,7 @@ interface XAccessibleMultiLineText
long getLineNumberAtIndex([in] long nIndex) long getLineNumberAtIndex([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException); raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Retuns the text of the specified line. /** Returns the text of the specified line.
<p>Returns the substring of text that makes up the specified line <p>Returns the substring of text that makes up the specified line
number.</p> number.</p>
......
...@@ -51,7 +51,7 @@ module com { module sun { module star { module accessibility { ...@@ -51,7 +51,7 @@ module com { module sun { module star { module accessibility {
clean it up. These methods are <member>add</member>, clean it up. These methods are <member>add</member>,
<member>addAll</member>, <member>clear</member>, and <member>addAll</member>, <member>clear</member>, and
<member>remove</member>. The other methods have been renamed to achieve <member>remove</member>. The other methods have been renamed to achieve
a geater conformance with the other accessibility interfaces.</p> a greater conformance with the other accessibility interfaces.</p>
@since OOo 1.1.2 @since OOo 1.1.2
*/ */
...@@ -68,7 +68,7 @@ published interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface ...@@ -68,7 +68,7 @@ published interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface
the given index. the given index.
@param nIndex @param nIndex
This index specifies the relatio to return. This index specifies the relation to return.
@return @return
For a valid index, i.e. inside the range 0 to the number of For a valid index, i.e. inside the range 0 to the number of
......
...@@ -65,7 +65,7 @@ published interface XAccessibleSelection : ::com::sun::star::uno::XInterface ...@@ -65,7 +65,7 @@ published interface XAccessibleSelection : ::com::sun::star::uno::XInterface
@param nChildIndex @param nChildIndex
Index of the child which is to add to the selection. This index Index of the child which is to add to the selection. This index
referes to all the children of this object. refers to all the children of this object.
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if the given index does not lie in the valid range of 0 up to if the given index does not lie in the valid range of 0 up to
the result of the result of
...@@ -78,7 +78,7 @@ published interface XAccessibleSelection : ::com::sun::star::uno::XInterface ...@@ -78,7 +78,7 @@ published interface XAccessibleSelection : ::com::sun::star::uno::XInterface
@param nChildIndex @param nChildIndex
Index of the child for which to detect whether it is selected. Index of the child for which to detect whether it is selected.
This index referes to all the children of this object. This index refers to all the children of this object.
@return @return
Returns <TRUE/> if the specified child is selected and <FALSE/> Returns <TRUE/> if the specified child is selected and <FALSE/>
......
...@@ -67,7 +67,7 @@ published interface XAccessibleStateSet : ::com::sun::star::uno::XInterface ...@@ -67,7 +67,7 @@ published interface XAccessibleStateSet : ::com::sun::star::uno::XInterface
the constants of <type>AccessibleStateType</type>. the constants of <type>AccessibleStateType</type>.
@return @return
Returns <TRUE/> if the given state is a memeber of this object's Returns <TRUE/> if the given state is a member of this object's
state set and <FALSE/> otherwise. state set and <FALSE/> otherwise.
*/ */
boolean contains ([in] short aState); boolean contains ([in] short aState);
......
...@@ -102,7 +102,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface ...@@ -102,7 +102,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface
returned. returned.
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside if the specified row index is not valid, i.e. lies not inside
the valide range of 0 up to the valid range of 0 up to
<member>XAccessibleTable::getAccessibleRowCount()</member> - 1. <member>XAccessibleTable::getAccessibleRowCount()</member> - 1.
*/ */
...@@ -121,7 +121,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface ...@@ -121,7 +121,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface
returned. returned.
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside if the specified column index is not valid, i.e. lies not inside
the valide range of 0 up to the valid range of 0 up to
<member>XAccessibleTable::getAccessibleColumnCount()</member> - 1. <member>XAccessibleTable::getAccessibleColumnCount()</member> - 1.
*/ */
string getAccessibleColumnDescription ([in] long nColumn) string getAccessibleColumnDescription ([in] long nColumn)
...@@ -146,7 +146,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface ...@@ -146,7 +146,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside if the specified row index is not valid, i.e. lies not inside
the valide range of 0 up to the valid range of 0 up to
<member>XAccessibleTable::getAccessibleRowCount()</member> - 1. <member>XAccessibleTable::getAccessibleRowCount()</member> - 1.
*/ */
long getAccessibleRowExtentAt ([in] long nRow, [in] long nColumn) long getAccessibleRowExtentAt ([in] long nRow, [in] long nColumn)
...@@ -171,7 +171,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface ...@@ -171,7 +171,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside if the specified column index is not valid, i.e. lies not inside
the valide range of 0 up to the valid range of 0 up to
<member>XAccessibleTable::getAccessibleColumnCount()</member> - 1. <member>XAccessibleTable::getAccessibleColumnCount()</member> - 1.
*/ */
long getAccessibleColumnExtentAt ([in] long nRow, [in] long nColumn) long getAccessibleColumnExtentAt ([in] long nRow, [in] long nColumn)
...@@ -233,7 +233,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface ...@@ -233,7 +233,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside if the specified row index is not valid, i.e. lies not inside
the valide range of 0 up to the valid range of 0 up to
<member>XAccessibleTable::getAccessibleRowCount()</member> - 1. <member>XAccessibleTable::getAccessibleRowCount()</member> - 1.
*/ */
boolean isAccessibleRowSelected ([in] long nRow) boolean isAccessibleRowSelected ([in] long nRow)
...@@ -252,7 +252,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface ...@@ -252,7 +252,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside if the specified column index is not valid, i.e. lies not inside
the valide range of 0 up to the valid range of 0 up to
<member>XAccessibleTable::getAccessibleColumnCount()</member> - 1. <member>XAccessibleTable::getAccessibleColumnCount()</member> - 1.
*/ */
boolean isAccessibleColumnSelected ([in] long nColumn) boolean isAccessibleColumnSelected ([in] long nColumn)
...@@ -282,7 +282,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface ...@@ -282,7 +282,7 @@ published interface XAccessibleTable : ::com::sun::star::uno::XInterface
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column and/or row index is not valid, i.e. lies not inside if the specified column and/or row index is not valid, i.e. lies not inside
the valide range of 0 up to the valid range of 0 up to
<member>XAccessibleTable::getAccessibleColumnCount()</member> - 1. <member>XAccessibleTable::getAccessibleColumnCount()</member> - 1.
*/ */
XAccessible getAccessibleCellAt ([in] long nRow, [in] long nColumn) XAccessible getAccessibleCellAt ([in] long nRow, [in] long nColumn)
......
...@@ -169,7 +169,7 @@ published interface XAccessibleText : ::com::sun::star::uno::XInterface ...@@ -169,7 +169,7 @@ published interface XAccessibleText : ::com::sun::star::uno::XInterface
character then they are ignored, too. character then they are ignored, too.
<p>An empty sequence signals the callers interest in all the <p>An empty sequence signals the callers interest in all the
attributes. This is usefull in two cases: a) Simply as a way to attributes. This is useful in two cases: a) Simply as a way to
avoid passing a potentially large array to the called object or avoid passing a potentially large array to the called object or
b) when the caller does not know what attributes the called b) when the caller does not know what attributes the called
objects supports but is interested in all of them objects supports but is interested in all of them
...@@ -204,7 +204,7 @@ published interface XAccessibleText : ::com::sun::star::uno::XInterface ...@@ -204,7 +204,7 @@ published interface XAccessibleText : ::com::sun::star::uno::XInterface
represents the current input position and will therefore typically represents the current input position and will therefore typically
be queried by AT more often than other positions. Because it does be queried by AT more often than other positions. Because it does
not represent an existing character its bounding box is defined in not represent an existing character its bounding box is defined in
relation to preceding characters. It should be rougly equivalent to relation to preceding characters. It should be roughly equivalent to
the bounding box of some character when inserted at the end of the the bounding box of some character when inserted at the end of the
text. Its height typically being the maximal height of all the text. Its height typically being the maximal height of all the
characters in the text or the height of the preceding character, its characters in the text or the height of the preceding character, its
......
...@@ -125,7 +125,7 @@ interface XAccessibleTextMarkup ...@@ -125,7 +125,7 @@ interface XAccessibleTextMarkup
@return @return
If character index is in range [0..number of characters in the text-1], If character index is in range [0..number of characters in the text-1],
a seguence of <type>TextSegment</type>s of the text markups at a sequence of <type>TextSegment</type>s of the text markups at
given character index of the given text markup type are returned. given character index of the given text markup type are returned.
The sequence is empty, if no such text markup is found. The sequence is empty, if no such text markup is found.
*/ */
......
...@@ -59,19 +59,35 @@ constants AnimationFill ...@@ -59,19 +59,35 @@ constants AnimationFill
/** Specifies that the element will not extend past the end of the last instance of the simple duration. */ /** Specifies that the element will not extend past the end of the last instance of the simple duration. */
const short REMOVE = 1; const short REMOVE = 1;
/** Specifies that the element will extend past the end of the last instance of the simple duration by "freezing" the element state at that point. The parent time container of the element determines how long the element is frozen (as described immediately below). */ /** Specifies that the element will extend past the end of the last instance of the simple duration by
"freezing" the element state at that point. The parent time container of the element determines how
long the element is frozen (as described immediately below).
*/
const short FREEZE = 2; const short FREEZE = 2;
/** Setting this to "hold" has the same effect as setting to "freeze", except that the element is always frozen to extend to the end of the simple duration of the parent time container of theelement (independent of the type of time container). For profiles that support a layered layout model (e.g., SMIL 2.0 Language Profile), held elements (elements with fill="hold") will refresh their display area when a layer is added on top then later removed. */ /** Setting this to "hold" has the same effect as setting to "freeze", except that the element is always
frozen to extend to the end of the simple duration of the parent time container of the element
(independent of the type of time container). For profiles that support a layered layout model
(e.g., SMIL 2.0 Language Profile), held elements (elements with fill="hold") will refresh their display
area when a layer is added on top then later removed.
*/
const short HOLD = 3; const short HOLD = 3;
/** Setting this to "transition" has the same effect as setting to "freeze", except that the element is removed at the end of the transition. This value is only allowed on elements with media directly associated with them. If specified on any other element (e.g. a time container element in the SMIL language profile), the attribute is ignored. See the SMIL Transitions module. */ /** Setting this to "transition" has the same effect as setting to "freeze", except that the element is
removed at the end of the transition. This value is only allowed on elements with media directly
associated with them. If specified on any other element (e.g. a time container element in the SMIL
language profile), the attribute is ignored. See the SMIL Transitions module.
*/
const short TRANSITION = 4; const short TRANSITION = 4;
/** The fill behavior for this element depends on whether the element specifies any of the attributes that define the simple or active duration: /** The fill behavior for this element depends on whether the element specifies any of the attributes
that define the simple or active duration:
<ul> <ul>
<li>If none of the attributes duration, end, repeatCount or repeatDuration are specified on the element, then the element will have a fill behavior identical to that if it were specified as <const>AnimationFill::FREEZE</const>.</li> <li>If none of the attributes duration, end, repeatCount or repeatDuration are specified on
<li>Otherwise, the element will have a fill behavior identical to that if it were specified as <const>AnimationFill::REMOVE</const.</li> the element, then the element will have a fill behavior identical to that if it were specified
as <const>AnimationFill::FREEZE</const>.</li>
<li>Otherwise, the element will have a fill behavior identical to that if it were specified as
<const>AnimationFill::REMOVE</const.</li>
</ul> </ul>
*/ */
const short AUTO = 5; const short AUTO = 5;
......
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
/** This constants defines a type for an animation node. /** This constants defines a type for an animation node.
<br> <br>
It can be used to quickly identify semantic blocks inside an animation hierachy. It can be used to quickly identify semantic blocks inside an animation hierarchy.
@see AnimationNode @see AnimationNode
*/ */
......
...@@ -57,7 +57,7 @@ struct Event ...@@ -57,7 +57,7 @@ struct Event
/** an option repeat value. If the <member>Trigger</member> is /** an option repeat value. If the <member>Trigger</member> is
<const>EventTrigger</const>, this is the number of repeats <const>EventTrigger</const>, this is the number of repeats
after wich the event is initially raised. after which the event is initially raised.
*/ */
unsigned short Repeat; unsigned short Repeat;
}; };
......
...@@ -65,7 +65,7 @@ constants EventTrigger ...@@ -65,7 +65,7 @@ constants EventTrigger
const short ON_MOUSE_ENTER = 7; const short ON_MOUSE_ENTER = 7;
const short ON_MOUSE_LEAVE = 8; const short ON_MOUSE_LEAVE = 8;
/** This event is raised when the user wants the presentation to go one step foreward. /** This event is raised when the user wants the presentation to go one step forward.
*/ */
const short ON_NEXT = 9; const short ON_NEXT = 9;
......
...@@ -41,7 +41,7 @@ ...@@ -41,7 +41,7 @@
This interface provides a simple means of just setting the value of an attribute for This interface provides a simple means of just setting the value of an attribute for
a specified duration. a specified duration.
When using XAnimateSet, the following memebers are ignored When using XAnimateSet, the following members are ignored
<ul> <ul>
<li><member>XAnimate::Values</member></li> <li><member>XAnimate::Values</member></li>
<li><member>XAnimate::KeyTimes</member></li> <li><member>XAnimate::KeyTimes</member></li>
......
...@@ -51,7 +51,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -51,7 +51,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild
*/ */
[readonly, attribute] short Type; [readonly, attribute] short Type;
/** a sequnece of values that define the begining of this element /** a sequence of values that define the beginning of this element
<br> <br>
<member>Begin</member> is <member>Begin</member> is
<ul> <ul>
...@@ -65,7 +65,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -65,7 +65,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild
external event to the element.</li> external event to the element.</li>
<li><type>sequence&lt;any&gt;</type> a sequence of values described above if more than <li><type>sequence&lt;any&gt;</type> a sequence of values described above if more than
one begin value is defined for this element.</li> one begin value is defined for this element.</li>
<li><void/> if no begin behaviour is defined for this element.</li> <li><void/> if no begin behavior is defined for this element.</li>
</ul> </ul>
@see http://www.w3.org/TR/smil20/smil-timing.html#adef-begin @see http://www.w3.org/TR/smil20/smil-timing.html#adef-begin
...@@ -86,7 +86,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -86,7 +86,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild
*/ */
[attribute] any Duration; [attribute] any Duration;
/** a sequnece of values that define the ending of this element /** a sequence of values that define the ending of this element
<br> <br>
<member>End</member> is <member>End</member> is
<ul> <ul>
...@@ -100,7 +100,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -100,7 +100,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild
external event to the element.</li> external event to the element.</li>
<li><type>sequence&lt;any&gt;</type> a sequence of values described above if more than <li><type>sequence&lt;any&gt;</type> a sequence of values described above if more than
one begin value is defined for this element.</li> one begin value is defined for this element.</li>
<li><void/> if no end behaviour is defined for this element.</li> <li><void/> if no end behavior is defined for this element.</li>
</ul> </ul>
@see http://www.w3.org/TR/smil20/smil-timing.html#adef-end @see http://www.w3.org/TR/smil20/smil-timing.html#adef-end
...@@ -110,12 +110,12 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -110,12 +110,12 @@ interface XAnimationNode : ::com::sun::star::container::XChild
/** controls the implicit duration of time containers, /** controls the implicit duration of time containers,
as a function of the children. as a function of the children.
<br> <br>
The endsync attribute is only valid for The EndSync attribute is only valid for
par and excl time container elements, and media elements with timed par and excl time container elements, and media elements with timed
children (e.g. animate or area elements). children (e.g. animate or area elements).
<member>EndSync</member> is <member>EndSync</member> is
eiter a <atom>short</atom> constant from <const>EndSync</const>, either a <atom>short</atom> constant from <const>EndSync</const>,
an interface reference to a child <type>XTimeContainer</type> an interface reference to a child <type>XTimeContainer</type>
or <void/>. or <void/>.
...@@ -160,7 +160,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -160,7 +160,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild
*/ */
[attribute] any RepeatDuration; [attribute] any RepeatDuration;
/** the attribute that specify the behaviour how an element /** the attribute that specify the behavior how an element
should be extended beyond the active duration by freezing the final should be extended beyond the active duration by freezing the final
state of the element. state of the element.
<br> <br>
...@@ -173,7 +173,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -173,7 +173,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild
[attribute] short Fill; [attribute] short Fill;
/** the default value for the fill behavior for this element and all /** the default value for the fill behavior for this element and all
descendents. descendants.
<br> <br>
<member>FillDefault</member> is <member>FillDefault</member> is
<ul> <ul>
...@@ -190,7 +190,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -190,7 +190,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild
*/ */
[attribute] short FillDefault; [attribute] short FillDefault;
/** defines the restart behaviour of this element. /** defines the restart behavior of this element.
<br> <br>
<member>Restart</member> is <member>Restart</member> is
a <atom>short</atom> value from <const>AnimationRestart</const>. a <atom>short</atom> value from <const>AnimationRestart</const>.
...@@ -200,7 +200,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild ...@@ -200,7 +200,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild
*/ */
[attribute] short Restart; [attribute] short Restart;
/** defines the default restart behaviour for this element and all descendents. /** defines the default restart behavior for this element and all descendants.
@returns @returns
a value from <const>Restart</const>. a value from <const>Restart</const>.
......
...@@ -45,7 +45,7 @@ ...@@ -45,7 +45,7 @@
*/ */
interface XIterateContainer : XTimeContainer interface XIterateContainer : XTimeContainer
{ {
/** a target that contains iterateable contents, f.e. a paragraph. /** a target that contains iterable contents, f.e. a paragraph.
<br> <br>
See documentation of used animation engine for supported targets. See documentation of used animation engine for supported targets.
*/ */
......
...@@ -35,13 +35,13 @@ ...@@ -35,13 +35,13 @@
module com { module sun { module star { module auth { module com { module sun { module star { module auth {
/** represents a starting point for Single Signon interactions. /** represents a starting point for Single Signon interactions.
<P>The Single Signon ( SSO ) apis provide UNO based access to underlying <P>The Single Signon ( SSO ) APIs provide UNO based access to underlying
SSO implementations ( e.g. Kerberos ). The aim of the SSO apis is to SSO implementations ( e.g. Kerberos ). The aim of the SSO APIs is to
enable authentication ( possibly mutual ) between a client ( source or enable authentication ( possibly mutual ) between a client ( source or
initiator ) and a network service ( target or acceptor ). This is initiator ) and a network service ( target or acceptor ). This is
achieved via. the creation and processing of security tokens sent achieved via. the creation and processing of security tokens sent
between the two parties. The steps which should be followed to between the two parties. The steps which should be followed to
successfully use the SSO apis are as follows: successfully use the SSO APIs are as follows:
<UL> <UL>
<LI>Create an <type>XSSOManagerFactory</type> instance</LI> <LI>Create an <type>XSSOManagerFactory</type> instance</LI>
<LI>Use this factory to create/retrieve an <type>XSSOManager</type> <LI>Use this factory to create/retrieve an <type>XSSOManager</type>
......
...@@ -40,7 +40,7 @@ module com { module sun { module star { module auth { ...@@ -40,7 +40,7 @@ module com { module sun { module star { module auth {
/** represents an acceptor side security context. /** represents an acceptor side security context.
<P>This context may be used to authenticate a Single Signon initiator based <P>This context may be used to authenticate a Single Signon initiator based
on a security token sent by the intiator and to generate a token to be on a security token sent by the initiator and to generate a token to be
sent back to the initiator so that it can authenticate the acceptor. sent back to the initiator so that it can authenticate the acceptor.
@since OOo 1.1.2 @since OOo 1.1.2
......
...@@ -39,14 +39,14 @@ ...@@ -39,14 +39,14 @@
module com { module sun { module star { module auth { module com { module sun { module star { module auth {
/** represents an initiator side security context. /** represents an initiator side security context.
<P>This context may be used to initialise authetication tokens to send to <P>This context may be used to initialize authentication tokens to send to
an acceptor and to authenticate any token sent back in response. an acceptor and to authenticate any token sent back in response.
@since OOo 1.1.2 @since OOo 1.1.2
*/ */
published interface XSSOInitiatorContext : ::com::sun::star::auth::XSSOContext published interface XSSOInitiatorContext : ::com::sun::star::auth::XSSOContext
{ {
/** initialises an SSO Token to send to the acceptor side and /** initializes an SSO Token to send to the acceptor side and
authenticates an SSO Token returned by the acceptor if the authenticates an SSO Token returned by the acceptor if the
context supports mutual authentication. context supports mutual authentication.
<P> <P>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment