diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 23:21:10 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:01 +0200 |
| commit | bb6503dd081ebb4d11929ab1946eea8d60dd817c (patch) | |
| tree | e2197a207d6c5f6ff82a7aa71b2c7266b45cd84f /offapi | |
| parent | 4bb43e1612ea3737fe53bb28ac830810b0a6a028 (diff) | |
*api: convert remaining <member>
sed -i "s,<member>\([^<]\+\)</member>,\1,g"
Change-Id: I74c80f5aa610477fab28faec52e55c3137984aec
Diffstat (limited to 'offapi')
282 files changed, 901 insertions, 901 deletions
diff --git a/offapi/com/sun/star/accessibility/AccessibleEventId.idl b/offapi/com/sun/star/accessibility/AccessibleEventId.idl index 663f525a39fa..79d7f6c3e905 100644 --- a/offapi/com/sun/star/accessibility/AccessibleEventId.idl +++ b/offapi/com/sun/star/accessibility/AccessibleEventId.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module accessibility { /** These constants identify the type of AccessibleEventObject objects. - <p>The <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain, where + <p>The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain, where applicable and not otherwise stated, the old and new value of the property in question.</p> @@ -38,46 +38,46 @@ constants AccessibleEventId { /** Use this event type to indicate a change of the name string of an accessible object. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the name before and after the change. */ const short NAME_CHANGED = 1; /** Use this event type to indicate a change of the description string of an accessible object. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the description before and after the change. */ const short DESCRIPTION_CHANGED = 2; /** The change of the number or attributes of actions of an accessible object is signaled by events of this type. - <p>The <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + <p>The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new number of actions. */ const short ACTION_CHANGED = 3; /** State changes are signaled with this event type. Use one event for every state that is set or reset. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new value respectively. To set a state put the state id - into the <member>AccessibleEventObject::NewValue</member> field and - leave <member>AccessibleEventObject::OldValue</member> empty. To + into the AccessibleEventObject::NewValue field and + leave AccessibleEventObject::OldValue empty. To reset a state put the state id into the - <member>AccessibleEventObject::OldValue</member> field and leave - <member>AccessibleEventObject::NewValue</member> empty. + AccessibleEventObject::OldValue field and leave + AccessibleEventObject::NewValue empty. */ const short STATE_CHANGED = 4; /** Constant used to determine when the active descendant of a component has changed. The active descendant is used in objects with - transient children. The <member>AccessibleEventObject::NewValue</member> + transient children. The AccessibleEventObject::NewValue contains the now active object. The - <member>AccessibleEventObject::OldValue</member> contains the + AccessibleEventObject::OldValue contains the previously active child. Empty references indicate that no child has been respectively is currently active. */ @@ -94,28 +94,28 @@ constants AccessibleEventId much more specific than the later one and reduces the number of calls an AT-Tool has to make to retrieve all affected data.</p> - <p>The <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> remain empty. Use - a call to the <member>XAccessibleComponent::getBounds()</member> + <p>The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue remain empty. Use + a call to the XAccessibleComponent::getBounds() method to determine the new bounding box.</p> */ const short BOUNDRECT_CHANGED = 6; /** A child event indicates the addition of a new or the removal of an existing child. The contents of the - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields determines + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields determines which of both has taken place. <p>If a new child has been added then - the <member>AccessibleEventObject::NewValue</member> contains a + the AccessibleEventObject::NewValue contains a reference to this new object and - <member>AccessibleEventObject::OldValue</member> remains empty.</p> + AccessibleEventObject::OldValue remains empty.</p> <p>If a child has been removed then the - <member>AccessibleEventObject::OldValue</member> contains a + AccessibleEventObject::OldValue contains a reference to this object and - <member>AccessibleEventObject::NewValue</member> remains empty.</p> + AccessibleEventObject::NewValue remains empty.</p> <p>If a child has been added and a another one has been removed don't set both fields at the same. Send separate events @@ -141,8 +141,8 @@ constants AccessibleEventId const short INVALIDATE_ALL_CHILDREN = 8; /** Events of this type indicate changes of the selection. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields remain empty. + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields remain empty. */ const short SELECTION_CHANGED = 9; @@ -150,15 +150,15 @@ constants AccessibleEventId of an accessible object. This includes for example most of the attributes available over the XAccessibleComponent and XAccessibleExtendedComponent interfaces. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields are left empty. + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields are left empty. */ const short VISIBLE_DATA_CHANGED = 10; /** This constant indicates changes of the value of an XAccessibleValue interface. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> field contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue field contain the old and new value as a number. Its exact type is implementation dependent but has to be the same as is returned by the XAccessibleValue::getCurrentValue() function. @@ -169,8 +169,8 @@ constants AccessibleEventId /** Identifies the change of a relation set: The content flow has changed. - <p>Not used: The <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain + <p>Not used: The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain 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 existed or does not exist anymore.</p> @@ -180,8 +180,8 @@ constants AccessibleEventId /** Identifies the change of a relation set: The content flow has changed. - <p>Not used: The <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain + <p>Not used: The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain 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 existed or does not exist anymore.</p> @@ -190,56 +190,56 @@ constants AccessibleEventId /** Identifies the change of a relation set: The target object that is doing the controlling has changed. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new controlling objects. */ const short CONTROLLED_BY_RELATION_CHANGED = 14; /** Identifies the change of a relation set: The controller for the target object has changed. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new number of controlled objects. */ const short CONTROLLER_FOR_RELATION_CHANGED = 15; /** Identifies the change of a relation set: The target group for a label has changed. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new number labeled objects. */ const short LABEL_FOR_RELATION_CHANGED = 16; /** Identifies the change of a relation set: The objects that are doing the labeling have changed. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new accessible label. */ const short LABELED_BY_RELATION_CHANGED = 17; /** Identifies the change of a relation set: The group membership has changed. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new number of members. */ const short MEMBER_OF_RELATION_CHANGED = 18; /** Identifies the change of a relation set: The sub-window-of relation has changed. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new accessible parent window objects. */ const short SUB_WINDOW_OF_RELATION_CHANGED = 19; /** Events of this type are sent when the caret has moved to a new position. The old and new position can be found in the - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields. + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields. */ const short CARET_CHANGED = 20; @@ -247,8 +247,8 @@ constants AccessibleEventId selection is <em>not</em> available through the event object. You 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 + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields is not specified at the moment. This may change in the future. */ const short TEXT_SELECTION_CHANGED = 21; @@ -260,19 +260,19 @@ constants AccessibleEventId <p>The affected text ranges are represented by <type scope="com::sun::star::accessibility">TextSegment</type> structures.<p> - <p>The content of the <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> expresses the type + <p>The content of the AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue expresses the type of text change: <ul> <li>Insertion: the - <member>AccessibleEventObject::NewValue</member> field specifies the + AccessibleEventObject::NewValue field specifies the inserted text after the insertion, the - <member>AccessibleEventObject::OldValue</member> field remains + AccessibleEventObject::OldValue field remains empty.</li> <li>Deletion: the - <member>AccessibleEventObject::OldValue</member> field specifies the + AccessibleEventObject::OldValue field specifies the deleted text before the deletion, the - <member>AccessibleEventObject::NewValue</member> field remains + AccessibleEventObject::NewValue field remains empty.</li> <li>Update/Replace/Modification: the - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields specify the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields specify the modified text before respectively after the modification.</li> <li>Unknown: when the type of text change or the place where it took place can not be determined by the event broadcaster then both @@ -297,77 +297,77 @@ constants AccessibleEventId const short TEXT_ATTRIBUTE_CHANGED = 23; /** Constant used to indicate that a hypertext element has received - focus. The <member>AccessibleEventObject::OldValue</member> field + focus. The AccessibleEventObject::OldValue field contains the start index of previously focused element. The - <member>AccessibleEventObject::NewValue</member> field holds the + AccessibleEventObject::NewValue field holds the start index in the document of the current element that has focus. A value of -1 indicates that an element does not or did not have focus. */ const short HYPERTEXT_CHANGED = 24; /** Constant used to indicate that the table caption has changed. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new accessible objects representing the table caption. */ const short TABLE_CAPTION_CHANGED = 25; /** Constant used to indicate that the column description has changed. - The <member>AccessibleEventObject::NewValue</member> field contains + The AccessibleEventObject::NewValue field contains the column index. The - <member>AccessibleEventObject::OldValue</member> is left empty. + AccessibleEventObject::OldValue is left empty. */ const short TABLE_COLUMN_DESCRIPTION_CHANGED = 26; /** 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 + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an AccessibleTableModelChange representing the header change. */ const short TABLE_COLUMN_HEADER_CHANGED = 27; /** 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 + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an AccessibleTableModelChange representing the data change. */ const short TABLE_MODEL_CHANGED = 28; /** Constant used to indicate that the row description has changed. The - <member>AccessibleEventObject::NewValue</member> field contains the - row index. The <member>AccessibleEventObject::OldValue</member> is + AccessibleEventObject::NewValue field contains the + row index. The AccessibleEventObject::OldValue is left empty. */ const short TABLE_ROW_DESCRIPTION_CHANGED = 29; /** 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 + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an AccessibleTableModelChange representing the header change. */ const short TABLE_ROW_HEADER_CHANGED = 30; /** Constant used to indicate that the table summary has changed. The - <member>AccessibleEventObject::OldValue</member> and - <member>AccessibleEventObject::NewValue</member> fields contain the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the old and new accessible objects representing the table summary. */ const short TABLE_SUMMARY_CHANGED = 31; /** Constant used to indicate that a list box entry has been expanded. - <member>AccessibleEventObject::OldValue</member> is empty. - <member>AccessibleEventObject::NewValue</member> contains the expanded list box entry. + AccessibleEventObject::OldValue is empty. + AccessibleEventObject::NewValue contains the expanded list box entry. @since OOo 3.2 */ const short LISTBOX_ENTRY_EXPANDED = 32; /** Constant used to indicate that a list box entry has been collapsed. - <member>AccessibleEventObject::OldValue</member> is empty. - <member>AccessibleEventObject::NewValue</member> contains the collapsed list box entry. + AccessibleEventObject::OldValue is empty. + AccessibleEventObject::NewValue contains the collapsed list box entry. @since OOo 3.2 */ diff --git a/offapi/com/sun/star/accessibility/TextSegment.idl b/offapi/com/sun/star/accessibility/TextSegment.idl index 125aa404baa8..e75c77851c60 100644 --- a/offapi/com/sun/star/accessibility/TextSegment.idl +++ b/offapi/com/sun/star/accessibility/TextSegment.idl @@ -27,17 +27,17 @@ module com { module sun { module star { module accessibility { 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 - <member>TextSegment::SegmentEnd</member> refer to the enclosing text. - The <member>TextSegment::SegmentText</member> member contains the text + <p>The indices TextSegment::SegmentStart and + TextSegment::SegmentEnd refer to the enclosing text. + The TextSegment::SegmentText 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 XAccessibleText interface that represents the enclosing text.</p> <p>An empty text segment is expressed by - <member>TextSegment::SegmentStart</member> and - <member>TextSegment::SegmentEnd</member> set to the same value. While a + TextSegment::SegmentStart and + TextSegment::SegmentEnd set to the same value. While a value of -1 signals an error (like the request for a word after the last character of a text) all other values define the empty string at that position.</p> @@ -54,8 +54,8 @@ module com { module sun { module star { module accessibility { struct TextSegment { /** A copy of the text segment of the enclosing text delimited by the - text indices <member>TextSegment::SegmentStart</member> and - <member>TextSegment::SegmentEnd</member>. Modifying it does not + text indices TextSegment::SegmentStart and + TextSegment::SegmentEnd. Modifying it does not alter the enclosing text. */ string SegmentText; diff --git a/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl b/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl index 69cc41523dc3..9e03d7ddf335 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl @@ -61,7 +61,7 @@ interface XAccessibleKeyBinding : ::com::sun::star::uno::XInterface @param nIndex The index selects one of alternative key bindings. It has to non-negative and smaller then the number of key bindings as - returned by the <member>getAccessibleKeyBindingCount()</member> + returned by the getAccessibleKeyBindingCount() method. @return The returned sequence of key strokes specifies one way to invoke diff --git a/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl b/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl index 4b7aa2cc845d..caf5b52fb6a9 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl @@ -67,7 +67,7 @@ interface XAccessibleMultiLineText <p>The number of lines can be obtained by calling XAccessibleMultiLineText::getLineNumberAtIndex() with the index of the last character. In a loop, the last line - has been reached when <member>TextSegment::SegmentEnd</member> + has been reached when TextSegment::SegmentEnd of the returned value is equal to the index of the last character of the text.</p> diff --git a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl index 21258973585d..5beff92be394 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl @@ -57,7 +57,7 @@ interface XAccessibleSelection : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to the result of - <member>XAccessibleContext::getAccessibleChildCount()</member>-1. + XAccessibleContext::getAccessibleChildCount()-1. */ void selectAccessibleChild ([in] long nChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException); @@ -74,7 +74,7 @@ interface XAccessibleSelection : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to the result of - <member>XAccessibleContext::getAccessibleChildCount()</member>-1. + XAccessibleContext::getAccessibleChildCount()-1. */ boolean isAccessibleChildSelected ([in] long nChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException); @@ -124,7 +124,7 @@ interface XAccessibleSelection : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to the result of - <member>XAccessibleRelationSet::getAccessibleChildCount()</member>-1. + XAccessibleRelationSet::getAccessibleChildCount()-1. */ XAccessible getSelectedAccessibleChild ([in] long nSelectedChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException); diff --git a/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl b/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl index e08e194587a2..af64d2ea4e20 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl @@ -80,7 +80,7 @@ interface XAccessibleStateSet : ::com::sun::star::uno::XInterface <p>The purpose of this function is to reduce the communication between accessibility objects and AT. Without this function an - AT-Tool had to call <member>contains()</member> for every state + AT-Tool had to call contains() for every state type. Now a single call is sufficient.</p> @return diff --git a/offapi/com/sun/star/accessibility/XAccessibleTable.idl b/offapi/com/sun/star/accessibility/XAccessibleTable.idl index 2e477fa33320..8082f5dbdd52 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTable.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTable.idl @@ -91,7 +91,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified row index is not valid, i.e. lies not inside the valid range of 0 up to - <member>XAccessibleTable::getAccessibleRowCount()</member> - 1. + XAccessibleTable::getAccessibleRowCount() - 1. */ string getAccessibleRowDescription ([in] long nRow) @@ -110,7 +110,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified column index is not valid, i.e. lies not inside the valid range of 0 up to - <member>XAccessibleTable::getAccessibleColumnCount()</member> - 1. + XAccessibleTable::getAccessibleColumnCount() - 1. */ string getAccessibleColumnDescription ([in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); @@ -135,7 +135,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified row index is not valid, i.e. lies not inside the valid range of 0 up to - <member>XAccessibleTable::getAccessibleRowCount()</member> - 1. + XAccessibleTable::getAccessibleRowCount() - 1. */ long getAccessibleRowExtentAt ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); @@ -160,7 +160,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified column index is not valid, i.e. lies not inside the valid range of 0 up to - <member>XAccessibleTable::getAccessibleColumnCount()</member> - 1. + XAccessibleTable::getAccessibleColumnCount() - 1. */ long getAccessibleColumnExtentAt ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); @@ -222,7 +222,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified row index is not valid, i.e. lies not inside the valid range of 0 up to - <member>XAccessibleTable::getAccessibleRowCount()</member> - 1. + XAccessibleTable::getAccessibleRowCount() - 1. */ boolean isAccessibleRowSelected ([in] long nRow) raises (::com::sun::star::lang::IndexOutOfBoundsException); @@ -241,7 +241,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified column index is not valid, i.e. lies not inside the valid range of 0 up to - <member>XAccessibleTable::getAccessibleColumnCount()</member> - 1. + XAccessibleTable::getAccessibleColumnCount() - 1. */ boolean isAccessibleColumnSelected ([in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); @@ -271,7 +271,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified column and/or row index is not valid, i.e. lies not inside the valid range of 0 up to - <member>XAccessibleTable::getAccessibleColumnCount()</member> - 1. + XAccessibleTable::getAccessibleColumnCount() - 1. */ XAccessible getAccessibleCellAt ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); diff --git a/offapi/com/sun/star/animations/AnimationColorSpace.idl b/offapi/com/sun/star/animations/AnimationColorSpace.idl index fbd2a9dbebc5..3e2005b74ddd 100644 --- a/offapi/com/sun/star/animations/AnimationColorSpace.idl +++ b/offapi/com/sun/star/animations/AnimationColorSpace.idl @@ -28,7 +28,7 @@ This does not change how colors are interpreted but how to interpolate from one color to another. - @see <member>XAnimateColor::ColorSpace</member> + @see XAnimateColor::ColorSpace */ constants AnimationColorSpace { diff --git a/offapi/com/sun/star/animations/AnimationFill.idl b/offapi/com/sun/star/animations/AnimationFill.idl index 7ef586d50dc8..ed7c013404f0 100644 --- a/offapi/com/sun/star/animations/AnimationFill.idl +++ b/offapi/com/sun/star/animations/AnimationFill.idl @@ -31,8 +31,8 @@ */ constants AnimationFill { - /** The fill behavior for the element is determined by the value of the <member>XTiming::FillDefault</member> attribute. - This is the default value for the <member>XTiming::Fill</member>.. + /** The fill behavior for the element is determined by the value of the XTiming::FillDefault attribute. + This is the default value for the XTiming::Fill.. If the application of fillDefault to an element would result in the element having a value of fill that is not allowed on that element, the element will instead have a fill value of <const>AnimationFill::AUTO</const>. @@ -40,9 +40,9 @@ constants AnimationFill const short DEFAULT = 0; /** Specifies that the value of this attribute (and of the fill behavior) are - inherited from the <member>XTiming::FillDefault</member> value + inherited from the XTiming::FillDefault value of the parent element. If there is no parent element, the value is <const>AnimationFill::AUTO</const>. - This is the default value for the <member>XTiming::FillDefault</member>. + This is the default value for the XTiming::FillDefault. */ const short INHERIT = 0; diff --git a/offapi/com/sun/star/animations/AnimationRestart.idl b/offapi/com/sun/star/animations/AnimationRestart.idl index a6e260c2c3ea..1cfe4b1113fe 100644 --- a/offapi/com/sun/star/animations/AnimationRestart.idl +++ b/offapi/com/sun/star/animations/AnimationRestart.idl @@ -25,21 +25,21 @@ /** defines the restart behavior - @see <member>XTiming::Restart</member> - @see <member>XTiming::RestartDefault</member> + @see XTiming::Restart + @see XTiming::RestartDefault @see http://www.w3.org/TR/smil20/smil-timing.html#adef-restart */ constants AnimationRestart { - /** The restart behavior for the element is determined by the value of the <member>XTiming::RestartDefault</member> attribute. - This is the default value for the <member>XTiming::Restart</member> attribute. + /** The restart behavior for the element is determined by the value of the XTiming::RestartDefault attribute. + This is the default value for the XTiming::Restart attribute. */ const short DEFAULT = 0; /** Specifies that the value of this attribute (and of the restart behavior) are - inherited from the <member>XTiming::RestartDefault</member> value of the parent element. + inherited from the XTiming::RestartDefault value of the parent element. If there is no parent element, the value is <const>AnimationRestart::ALWAYS</const>. - This is the default value for the <member>XTiming::RestartDefault</member> attribute. + This is the default value for the XTiming::RestartDefault attribute. */ const short INHERIT = 0; diff --git a/offapi/com/sun/star/animations/AnimationValueType.idl b/offapi/com/sun/star/animations/AnimationValueType.idl index df65b3f72c3c..9fc1ab3d3bf2 100644 --- a/offapi/com/sun/star/animations/AnimationValueType.idl +++ b/offapi/com/sun/star/animations/AnimationValueType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module animations { -/** @see <member>XAnimateAttribute::ValueType</member> +/** @see XAnimateAttribute::ValueType */ constants AnimationValueType { diff --git a/offapi/com/sun/star/animations/XAnimateColor.idl b/offapi/com/sun/star/animations/XAnimateColor.idl index dd19842ab126..57ac184b3131 100644 --- a/offapi/com/sun/star/animations/XAnimateColor.idl +++ b/offapi/com/sun/star/animations/XAnimateColor.idl @@ -29,10 +29,10 @@ <br> Only color value will be legal values for the following members <ul> - <li><member>XAnimate::Values</member></li> - <li><member>XAnimate::From</member></li> - <li><member>XAnimate::To</member></li> - <li><member>XAnimate::By</member></li> + <li>XAnimate::Values</li> + <li>XAnimate::From</li> + <li>XAnimate::To</li> + <li>XAnimate::By</li> </ul> @see http://www.w3.org/TR/smil20/animation.html#edef-animateColor */ diff --git a/offapi/com/sun/star/animations/XAnimateSet.idl b/offapi/com/sun/star/animations/XAnimateSet.idl index 89240035c48e..bfd6714c773a 100644 --- a/offapi/com/sun/star/animations/XAnimateSet.idl +++ b/offapi/com/sun/star/animations/XAnimateSet.idl @@ -31,14 +31,14 @@ When using XAnimateSet, the following members are ignored <ul> - <li><member>XAnimate::Values</member></li> - <li><member>XAnimate::KeyTimes</member></li> - <li><member>XAnimate::CalcMode</member></li> - <li><member>XAnimate::Accumulate</member></li> - <li><member>XAnimate::Additive</member></li> - <li><member>XAnimate::From</member></li> - <li><member>XAnimate::By</member></li> - <li><member>XAnimate::TimeFilter</member></li> + <li>XAnimate::Values</li> + <li>XAnimate::KeyTimes</li> + <li>XAnimate::CalcMode</li> + <li>XAnimate::Accumulate</li> + <li>XAnimate::Additive</li> + <li>XAnimate::From</li> + <li>XAnimate::By</li> + <li>XAnimate::TimeFilter</li> </ul> @see http://www.w3.org/TR/smil20/animation.html#edef-set diff --git a/offapi/com/sun/star/animations/XAnimateTransform.idl b/offapi/com/sun/star/animations/XAnimateTransform.idl index cdda0f61a1c8..8dcc1a323005 100644 --- a/offapi/com/sun/star/animations/XAnimateTransform.idl +++ b/offapi/com/sun/star/animations/XAnimateTransform.idl @@ -28,12 +28,12 @@ /** animates a transformation attribute on a target element, thereby allowing animations to control translation, scaling, rotation and/or skewing. - The member <member>XAnimate::Attributes</member> contains a short from + The member XAnimate::Attributes contains a short from <const>AnimationTransformType</const>. - Depending on the value in <member>XAnimate::Attributes</member>, the - members <member>XAnimate::From</member>, <member>XAnimate::To</member>, - <member>XAnimate::By</member> or <member>XAnimate::Values</member> + Depending on the value in XAnimate::Attributes, the + members XAnimate::From, XAnimate::To, + XAnimate::By or XAnimate::Values contain the following <ul> diff --git a/offapi/com/sun/star/animations/XTransitionFilter.idl b/offapi/com/sun/star/animations/XTransitionFilter.idl index d89db2abb1f9..1e4ade3977fe 100644 --- a/offapi/com/sun/star/animations/XTransitionFilter.idl +++ b/offapi/com/sun/star/animations/XTransitionFilter.idl @@ -26,8 +26,8 @@ /** - Base members <member>XAnimate::Values</member>, <member>XAnimate::From</member>, - <member>XAnimate::To</member> and <member>XAnimate::By</member> can be used + Base members XAnimate::Values, XAnimate::From, + XAnimate::To and XAnimate::By can be used with <atom>double</atom> values that set the transition progress the specific amount of time. diff --git a/offapi/com/sun/star/awt/MouseEvent.idl b/offapi/com/sun/star/awt/MouseEvent.idl index 9cc961cbef41..85aa57af0e4b 100644 --- a/offapi/com/sun/star/awt/MouseEvent.idl +++ b/offapi/com/sun/star/awt/MouseEvent.idl @@ -66,7 +66,7 @@ published struct MouseEvent: com::sun::star::awt::InputEvent <p>If this member is <TRUE/>, the event describes a request for a pop-up menu, also known as context menu, on an object.</p> - <p>In this case, <member>X</member> and <member>Y</member> describe the position + <p>In this case, X and Y describe the position where the request was issued. If those members are <code>-1</code>, then the request was issued using the keyboard, by pressing the operating-system dependent key combination for this purpose.</p> diff --git a/offapi/com/sun/star/awt/WindowAttribute.idl b/offapi/com/sun/star/awt/WindowAttribute.idl index 800b6fe1b146..9fff6431cf8d 100644 --- a/offapi/com/sun/star/awt/WindowAttribute.idl +++ b/offapi/com/sun/star/awt/WindowAttribute.idl @@ -97,7 +97,7 @@ published constants WindowAttribute @see com::sun::star::lang::SystemDependent @deprecated - conflicts with <member>VclWindowPeerAttribute::HSCROLL</member> + conflicts with VclWindowPeerAttribute::HSCROLL */ const long SYSTEMDEPENDENT = 256; diff --git a/offapi/com/sun/star/awt/XExtendedToolkit.idl b/offapi/com/sun/star/awt/XExtendedToolkit.idl index 70238d273963..96b238e9027f 100644 --- a/offapi/com/sun/star/awt/XExtendedToolkit.idl +++ b/offapi/com/sun/star/awt/XExtendedToolkit.idl @@ -72,12 +72,12 @@ published interface XExtendedToolkit : ::com::sun::star::uno::XInterface /** Return a reference to the specified top-level window. Note that the number of top-level windows may change between a call to - <member>getTopWindowCount()</member> and successive calls to this + getTopWindowCount() and successive calls to this function. @param nIndex The index should be in the interval from 0 up to but not including the number of top-level windows as returned by - <member>getTopWindowCount()</member>. + getTopWindowCount(). @return The returned value is a valid reference to a top-level window. @throws IndexOutOfBoundsException diff --git a/offapi/com/sun/star/awt/XMouseListener.idl b/offapi/com/sun/star/awt/XMouseListener.idl index 896a274eeaaa..86479238e570 100644 --- a/offapi/com/sun/star/awt/XMouseListener.idl +++ b/offapi/com/sun/star/awt/XMouseListener.idl @@ -41,7 +41,7 @@ published interface XMouseListener: com::sun::star::lang::XEventListener pressing the right mouse button indicates the request for a context menu, then you will receive one call to mousePressed() indicating the mouse click, and another one indicating the context menu request. For - the latter, the <member>MouseEvent::PopupTrigger</member> member of the + the latter, the MouseEvent::PopupTrigger member of the event will be set to <TRUE/>.</p> */ void mousePressed( [in] com::sun::star::awt::MouseEvent e ); diff --git a/offapi/com/sun/star/awt/grid/UnoControlGrid.idl b/offapi/com/sun/star/awt/grid/UnoControlGrid.idl index 44d30e68840c..caa51125646c 100644 --- a/offapi/com/sun/star/awt/grid/UnoControlGrid.idl +++ b/offapi/com/sun/star/awt/grid/UnoControlGrid.idl @@ -35,20 +35,20 @@ <h4>The Column Model</h4> <p>The horizontal structure of the grid is defined by the XGridColumnModel implemented in DefaultGridColumnModel - The XGridColumn implemented in GridColumn describes the properties and behavior of a single column. Use the <member>XGridColumnModel::addColumn()</member> to add a column to the column model. + The XGridColumn implemented in GridColumn describes the properties and behavior of a single column. Use the XGridColumnModel::addColumn() to add a column to the column model. </p> <h4>The Data Model</h4> <p> All row data are stored in the XGridDataModel. - Use the DefaultGridDataModel to add <member>XGridDataModel::addRow()</member> or remove <member>XGridDataModel::removeRow()</member> rows. + Use the DefaultGridDataModel to add XGridDataModel::addRow() or remove XGridDataModel::removeRow() rows. </p> - <p>The column and data model must be set at the <member>UnoControlGridModel::ColumnModel</member> and <member>UnoControlGridModel::GridDataModel</member> properties.</p> + <p>The column and data model must be set at the UnoControlGridModel::ColumnModel and UnoControlGridModel::GridDataModel properties.</p> <h4>Selection</h4> <p>If you are interested in knowing when the selection changes implement a XGridSelectionListener and add the instance with the method - <member>XGridRowSelection::addSelectionListener()</member>. + XGridRowSelection::addSelectionListener(). You than will be notified for any selection change.</p> @since OOo 3.3 diff --git a/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl b/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl index 6cec955f2b2b..be6bea798fab 100644 --- a/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl @@ -114,8 +114,8 @@ published interface XMutableGridDataModel : XGridDataModel /** updates the content of a given row. <p>The change in the data model will be notified to registered listeners via - XGridDataListener::dataChanged(). The <member>GridDataEvent::FirstColumn</member> and - <member>GridDataEvent::LastColumn</member> will denote the smallest respectively largest column + XGridDataListener::dataChanged(). The GridDataEvent::FirstColumn and + GridDataEvent::LastColumn will denote the smallest respectively largest column index from <arg>ColumnIndexes</arg>.</p> @param ColumnIndexes diff --git a/offapi/com/sun/star/awt/tree/TreeControl.idl b/offapi/com/sun/star/awt/tree/TreeControl.idl index 88c61039479f..310a26bb8af7 100644 --- a/offapi/com/sun/star/awt/tree/TreeControl.idl +++ b/offapi/com/sun/star/awt/tree/TreeControl.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { module tree { <p> <h4>The Data Model</h4> <p>A specific node in a tree is identified by a XTreeNode. - A leaf node is a node without any children and that returns <FALSE/> when calling <member>XTreeNode::hasChildrenOnDemand()</member>. + A leaf node is a node without any children and that returns <FALSE/> when calling XTreeNode::hasChildrenOnDemand(). An expanded node is a non-leaf node that will displays its children when all its ancestors are expanded. A collapsed node is one which hides them. A node is visible when all parent nodes are expanded and the node itself is in the display area. @@ -41,7 +41,7 @@ module com { module sun { module star { module awt { module tree { which uses XMutableTreeNode and XMutableTreeDataModel for a simple and mutable data model. - <p>The data model must be set at the <member>TreeControlModel::TreeDataModel</member> property.</p> + <p>The data model must be set at the TreeControlModel::TreeDataModel property.</p> <h4>Selection</h4> <p>If you are interested in knowing when the selection changes implement a @@ -54,21 +54,21 @@ module com { module sun { module star { module awt { module tree { If you are interested in detecting either double-click events or when a user clicks on a node, regardless of whether or not it was selected, you can get the com::sun::star::awt::XWindow and add yourself as a com::sun::star::awt::XMouseClickHandler. You can use the - method <member>XTreeControl::getNodeForLocation()</member> to retrieve the node that was under the + method XTreeControl::getNodeForLocation() to retrieve the node that was under the mouse at the time the event was fired. </p> <h4>Adding child nodes on demand</h4> <p>If you want to add child nodes to your tree on demand you can do the following. <ul> - <li>Make sure the parent node returns <TRUE/> for <member>XTreeNode::hasChildrenOnDemand()</member> either + <li>Make sure the parent node returns <TRUE/> for XTreeNode::hasChildrenOnDemand() either by implementing XTreeNode yourself or if you use the MutableTreeDataModel, - use <member>XMutableTreeNode::setHasChildrenOnDemand()</member>.</li> + use XMutableTreeNode::setHasChildrenOnDemand().</li> <li>Implement a XTreeExpansionListener and add the instance with the method - <member>XTreeControl::addTreeExpansionListener()</member>.</li> + XTreeControl::addTreeExpansionListener().</li> </ul> Now you get called when the node will become expanded or collapsed. - So on <member>XTreeExpansionListener::treeExpanding()</member> you can + So on XTreeExpansionListener::treeExpanding() you can check the TreeExpansionEvent if the parent node with children on demand is going to be expanded and in that case add the missing child nodes. You can also veto the expansion or collapsing of a parent node by using the ExpandVetoException. diff --git a/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl b/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl index ffe24bdb05a4..1db512c96fa9 100644 --- a/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl +++ b/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl @@ -49,7 +49,7 @@ interface XMutableTreeNode : XTreeNode if <var>ChildNode</var> is not a valid node of the corresponding XTreeDataModel. @throws ::com::sun::star::lang::IndexOutOfBoundsException - if <var>Index</var> is less than 0 or greater then <member>XTreeNode::getChildCount()</member>. + if <var>Index</var> is less than 0 or greater then XTreeNode::getChildCount(). */ void insertChildByIndex( [in] long Index, [in] XMutableTreeNode ChildNode ) raises( com::sun::star::lang::IllegalArgumentException, @@ -61,7 +61,7 @@ interface XMutableTreeNode : XTreeNode the index of the node to be removed from this instance. @throws ::com::sun::star::lang::IndexOutOfBoundsException - if <var>Index</var> is less than 0 or greater then <member>XTreeNode::getChildCount()</member>. + if <var>Index</var> is less than 0 or greater then XTreeNode::getChildCount(). */ void removeChildByIndex( [in] long Index ) raises( com::sun::star::lang::IndexOutOfBoundsException ); @@ -88,12 +88,12 @@ interface XMutableTreeNode : XTreeNode void setNodeGraphicURL( [in] string URL ); /** The URL for a graphic that is rendered to visualize expanded non leaf nodes. - <p>If <var>URL</var> is empty, <member>XTreeControl::DefaultExpandedGraphicURL</member> is used. + <p>If <var>URL</var> is empty, XTreeControl::DefaultExpandedGraphicURL is used. */ void setExpandedGraphicURL( [in] string URL ); /** The URL for a graphic that is rendered to visualize collapsed non leaf nodes. - <p>If <var>URL</var> is empty, <member>XTreeControl::DefaultCollapsedGraphicURL</member> is used. + <p>If <var>URL</var> is empty, XTreeControl::DefaultCollapsedGraphicURL is used. */ void setCollapsedGraphicURL( [in] string URL ); }; diff --git a/offapi/com/sun/star/awt/tree/XTreeControl.idl b/offapi/com/sun/star/awt/tree/XTreeControl.idl index 03333cca1f32..b8469f059135 100644 --- a/offapi/com/sun/star/awt/tree/XTreeControl.idl +++ b/offapi/com/sun/star/awt/tree/XTreeControl.idl @@ -156,14 +156,14 @@ interface XTreeControl /** If the given URL points to a loadable graphic, the graphic is rendered before expanded non leaf nodes. - <p>This can be overridden for individual nodes by <member>XTreeNode::getExpandedGraphicURL()</member></p> + <p>This can be overridden for individual nodes by XTreeNode::getExpandedGraphicURL()</p> */ [attribute] string DefaultExpandedGraphicURL; /** If the given URL points to a loadable graphic, the graphic is rendered before collapsed non leaf nodes. - <p>This can be overridden for individual nodes by <member>XTreeNode::getCollapsedGraphicURL()</member></p> + <p>This can be overridden for individual nodes by XTreeNode::getCollapsedGraphicURL()</p> */ [attribute] string DefaultCollapsedGraphicURL; @@ -183,7 +183,7 @@ interface XTreeControl /** Returns the node that is closest to x,y. <p>If no nodes are currently viewable, or there is no model, returns null, otherwise it always returns a valid node. To test if the node is exactly - at x, y, use <member>getNodeForLocation()</member>. + at x, y, use getNodeForLocation(). @param x an integer giving the number of pixels horizontally from the left edge of the controls display area @@ -231,7 +231,7 @@ interface XTreeControl /** Selects <var>Node</var> and initiates editing. - <p>If <member>TreeControlModel::Editable</member> is <FALSE/> or if there are no + <p>If TreeControlModel::Editable is <FALSE/> or if there are no registered XTreeEditListener, this call has no effect.</p> <p>Calling this method also ensures that <var>Node</var> will become visible.</p> diff --git a/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl b/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl index aa9734feef06..85a9cb395f3b 100644 --- a/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl +++ b/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl @@ -44,15 +44,15 @@ interface XTreeDataModelListener: com::sun::star::lang::XEventListener Example: the name of a file has changed, but it is in the same location in the file system. - To indicate the root has changed, <member>TreeDataModelEvent::Nodes</member> will contain - the root node and <member>TreeDataModelEvent::ParentNode</member> will be empty. + To indicate the root has changed, TreeDataModelEvent::Nodes will contain + the root node and TreeDataModelEvent::ParentNode will be empty. */ void treeNodesChanged( [in] TreeDataModelEvent Event ); /** Invoked after nodes have been inserted into the tree. - Use <member>TreeDataModelEvent::ParentNode</member> to get the parent of the new node(s). - <member>TreeDataModelEvent::Nodes</member> contains the new node(s). + Use TreeDataModelEvent::ParentNode to get the parent of the new node(s). + TreeDataModelEvent::Nodes contains the new node(s). */ void treeNodesInserted( [in] TreeDataModelEvent Event ); @@ -61,15 +61,15 @@ interface XTreeDataModelListener: com::sun::star::lang::XEventListener this method may only be invoked once for the root of the removed subtree, not once for each individual set of siblings removed. - Use <member>TreeDataModelEvent::ParentNode</member> to get the former parent of the deleted node(s). - <member>TreeDataModelEvent::Nodes</member> contains the removed node(s). + Use TreeDataModelEvent::ParentNode to get the former parent of the deleted node(s). + TreeDataModelEvent::Nodes contains the removed node(s). */ void treeNodesRemoved( [in] TreeDataModelEvent Event ); /** Invoked after the tree has drastically changed structure from a given node down. - Use <member>TreeDataModelEvent::ParentNode</member> to get the node which - structure has changed. <member>TreeDataModelEvent::Nodes</member> is empty. + Use TreeDataModelEvent::ParentNode to get the node which + structure has changed. TreeDataModelEvent::Nodes is empty. */ void treeStructureChanged( [in] TreeDataModelEvent Event ); }; diff --git a/offapi/com/sun/star/awt/tree/XTreeEditListener.idl b/offapi/com/sun/star/awt/tree/XTreeEditListener.idl index 2a72a6b6f000..5c79f7b8b31c 100644 --- a/offapi/com/sun/star/awt/tree/XTreeEditListener.idl +++ b/offapi/com/sun/star/awt/tree/XTreeEditListener.idl @@ -30,13 +30,13 @@ module com { module sun { module star { module awt { module tree { /** You can implement this interface and register with <method scope="XTreeControl">addTreeEditListener</method> to get notifications when editing of a node starts and ends. - <p>You have to set the <member>TreeControlModel::Editable</member> property to + <p>You have to set the TreeControlModel::Editable property to <TRUE/> before a tree supports editing.</p> */ interface XTreeEditListener : ::com::sun::star::lang::XEventListener { /** This method is called from the TreeControl implementation when editing of - <var>Node</var> is requested by calling <member>XTreeControl::startEditingAtNode()</member>. + <var>Node</var> is requested by calling XTreeControl::startEditingAtNode(). @param Node the XTreeNode for that an edit request was fired by calling diff --git a/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl b/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl index be933ce0ba0b..6c9d4100e730 100644 --- a/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl +++ b/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl @@ -47,7 +47,7 @@ interface XTreeExpansionListener: com::sun::star::lang::XEventListener @throws ExpandVetoException to notify the calling XTreeControl that expanding - <member>TreeExpansionEvent::Node</member> should fail. + TreeExpansionEvent::Node should fail. */ void treeExpanding( [in] TreeExpansionEvent Event ) raises ( ExpandVetoException ); @@ -56,7 +56,7 @@ interface XTreeExpansionListener: com::sun::star::lang::XEventListener @throws ExpandVetoException to notify the calling XTreeControl that collapsing - <member>TreeExpansionEvent::Node</member> should fail. + TreeExpansionEvent::Node should fail. */ void treeCollapsing( [in] TreeExpansionEvent Event ) raises ( ExpandVetoException ); diff --git a/offapi/com/sun/star/awt/tree/XTreeNode.idl b/offapi/com/sun/star/awt/tree/XTreeNode.idl index e2e178cb70f7..7c192c6418df 100644 --- a/offapi/com/sun/star/awt/tree/XTreeNode.idl +++ b/offapi/com/sun/star/awt/tree/XTreeNode.idl @@ -73,12 +73,12 @@ interface XTreeNode string getNodeGraphicURL(); /** The URL for a graphic that is rendered to visualize expanded non leaf nodes. - <p>If <var>URL</var> is empty, <member>XTreeControl::DefaultExpandedGraphicURL</member> is used. + <p>If <var>URL</var> is empty, XTreeControl::DefaultExpandedGraphicURL is used. */ string getExpandedGraphicURL(); /** The URL for a graphic that is rendered to visualize collapsed non leaf nodes. - <p>If <var>URL</var> is empty, <member>XTreeControl::DefaultCollapsedGraphicURL</member> is used. + <p>If <var>URL</var> is empty, XTreeControl::DefaultCollapsedGraphicURL is used. */ string getCollapsedGraphicURL(); }; diff --git a/offapi/com/sun/star/chart/BarDiagram.idl b/offapi/com/sun/star/chart/BarDiagram.idl index e930f03b1d7f..c2f9c3ca2fbf 100644 --- a/offapi/com/sun/star/chart/BarDiagram.idl +++ b/offapi/com/sun/star/chart/BarDiagram.idl @@ -88,7 +88,7 @@ published service BarDiagram bars. <p>If this property differs from zero the last - <member>BarDiagram::NumberOfLines</member> data rows are shown as lines. It is + BarDiagram::NumberOfLines data rows are shown as lines. It is currently supported by two dimensional vertical bar charts only. </p> @deprecated diff --git a/offapi/com/sun/star/chart/ChartDataPointProperties.idl b/offapi/com/sun/star/chart/ChartDataPointProperties.idl index ce66389de470..e89004bd2119 100644 --- a/offapi/com/sun/star/chart/ChartDataPointProperties.idl +++ b/offapi/com/sun/star/chart/ChartDataPointProperties.idl @@ -69,7 +69,7 @@ published service ChartDataPointProperties /** is only available if the chart is of type BarDiagram and Dim3DDiagram and the - property <member>ChartDataPointProperties::Dim3D</member> is + property ChartDataPointProperties::Dim3D is set to <TRUE/>. @see BarDiagram diff --git a/offapi/com/sun/star/chart/ChartErrorCategory.idl b/offapi/com/sun/star/chart/ChartErrorCategory.idl index 1131debec46d..1a6420f6e628 100644 --- a/offapi/com/sun/star/chart/ChartErrorCategory.idl +++ b/offapi/com/sun/star/chart/ChartErrorCategory.idl @@ -47,7 +47,7 @@ published enum ChartErrorCategory /** The length of the error indicators is calculated for each data point by taking the percentage given as - <member>ChartStatistics::PercentageError</member> of its + ChartStatistics::PercentageError of its value. @see ChartStatistics @@ -57,7 +57,7 @@ published enum ChartErrorCategory /** The length of the error indicators for all data points is calculated by taking the percentage given as - <member>ChartStatistics::ErrorMargin</member> of the largest + ChartStatistics::ErrorMargin of the largest data point value. @see ChartStatistics @@ -69,8 +69,8 @@ published enum ChartErrorCategory data points. <p>The values for these are given as absolute numbers in - <member>ChartStatistics::ConstantErrorLow</member> and - <member>ChartStatistics::ConstantErrorHigh</member></p> + ChartStatistics::ConstantErrorLow and + ChartStatistics::ConstantErrorHigh</p> @see ChartStatistics */ diff --git a/offapi/com/sun/star/chart/ChartLegendPosition.idl b/offapi/com/sun/star/chart/ChartLegendPosition.idl index 4cc0b7bde786..73818a731fcf 100644 --- a/offapi/com/sun/star/chart/ChartLegendPosition.idl +++ b/offapi/com/sun/star/chart/ChartLegendPosition.idl @@ -33,7 +33,7 @@ published enum ChartLegendPosition /** no chart legend is displayed. <p>To disable the legend you should set the property - <member>ChartDocument::HasLegend</member> to <FALSE/> instead + ChartDocument::HasLegend to <FALSE/> instead of setting this value.</p> */ NONE, diff --git a/offapi/com/sun/star/chart/ChartStatistics.idl b/offapi/com/sun/star/chart/ChartStatistics.idl index e8c4bce77f13..73c856f70f71 100644 --- a/offapi/com/sun/star/chart/ChartStatistics.idl +++ b/offapi/com/sun/star/chart/ChartStatistics.idl @@ -41,8 +41,8 @@ published service ChartStatistics data row. <p>this setting is effective if the - <member>ChartStatistics::ErrorCategory</member> is set to - <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p> + ChartStatistics::ErrorCategory is set to + ChartErrorCategory::CONSTANT_VALUE.</p> @see ConstantErrorHigh @see ErrorCategory @@ -54,8 +54,8 @@ published service ChartStatistics data row. <p>this setting is effective if the - <member>ChartStatistics::ErrorCategory</member> is set to - <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p> + ChartStatistics::ErrorCategory is set to + ChartErrorCategory::CONSTANT_VALUE.</p> @see ConstantErrorLow @see ErrorCategory @@ -96,8 +96,8 @@ published service ChartStatistics data point by taking the given percentage of its value.</p> <p>this setting is effective if the - <member>ChartStatistics::ErrorCategory</member> is set to - <member>ChartErrorCategory::PERCENT</member>.</p> + ChartStatistics::ErrorCategory is set to + ChartErrorCategory::PERCENT.</p> @see ErrorCategory */ @@ -110,8 +110,8 @@ published service ChartStatistics the percentage given of the largest data point value.</p> <p>this setting is effective if the - <member>ChartStatistics::ErrorCategory</member> is set to - <member>ChartErrorCategory::ERROR_MARGIN</member>.</p> + ChartStatistics::ErrorCategory is set to + ChartErrorCategory::ERROR_MARGIN.</p> @see ErrorCategory */ @@ -135,13 +135,13 @@ published service ChartStatistics /** contains a cell range string for positive error bars. This property is used when the ErrorBarCategory is set - to <member>ErrorBarCategory::FROM_DATA</member>. + to ErrorBarCategory::FROM_DATA. */ [optional, property] string ErrorBarRangePositive; /** contains a cell range string for negative error bars. This property is used when the ErrorBarCategory is set - to <member>ErrorBarCategory::FROM_DATA</member>. + to ErrorBarCategory::FROM_DATA. */ [optional, property] string ErrorBarRangeNegative; }; diff --git a/offapi/com/sun/star/chart/ChartSymbolType.idl b/offapi/com/sun/star/chart/ChartSymbolType.idl index 7228283c48df..233562803609 100644 --- a/offapi/com/sun/star/chart/ChartSymbolType.idl +++ b/offapi/com/sun/star/chart/ChartSymbolType.idl @@ -62,7 +62,7 @@ published constants ChartSymbolType /** Take a Bitmap from a URL and use this as symbol. <p>The bitmap given by the URL set in the property - <member>ChartDataPointProperties::SymbolBitmapURL</member> is + ChartDataPointProperties::SymbolBitmapURL is copied so that the graphic is embedded.</p> @see ChartDataPointProperties diff --git a/offapi/com/sun/star/chart/ErrorBarStyle.idl b/offapi/com/sun/star/chart/ErrorBarStyle.idl index d1ebc638a3ea..adce5e5901d7 100644 --- a/offapi/com/sun/star/chart/ErrorBarStyle.idl +++ b/offapi/com/sun/star/chart/ErrorBarStyle.idl @@ -42,8 +42,8 @@ published constants ErrorBarStyle absolute value as length for either direction. <p>The values for these are given as absolute numbers in - <member>ChartStatistics::ConstantErrorLow</member> and - <member>ChartStatistics::ConstantErrorHigh</member></p> + ChartStatistics::ConstantErrorLow and + ChartStatistics::ConstantErrorHigh</p> @see ChartStatistics */ @@ -51,7 +51,7 @@ published constants ErrorBarStyle /** The length of the error indicators is calculated for each data point by taking the percentage given as - <member>ChartStatistics::PercentageError</member> of its + ChartStatistics::PercentageError of its value. @see ChartStatistics @@ -60,7 +60,7 @@ published constants ErrorBarStyle /** The length of the error indicators for all data points is calculated by taking the percentage given as - <member>ChartStatistics::ErrorMargin</member> of the largest + ChartStatistics::ErrorMargin of the largest data point value. @see ChartStatistics @@ -75,9 +75,9 @@ published constants ErrorBarStyle /** Uses values given by cell ranges of the container document. <p>The values for the cell ranges are given in the properties - <member>ChartStatistics::ErrorBarRangePositive</member> for + ChartStatistics::ErrorBarRangePositive for positive indicators and - <member>ChartStatistics::ErrorBarRangeNegative</member> for + ChartStatistics::ErrorBarRangeNegative for negative indicators.</p> */ const long FROM_DATA = 7; diff --git a/offapi/com/sun/star/chart/LineDiagram.idl b/offapi/com/sun/star/chart/LineDiagram.idl index 7c006b8baf55..4117feff6aac 100644 --- a/offapi/com/sun/star/chart/LineDiagram.idl +++ b/offapi/com/sun/star/chart/LineDiagram.idl @@ -54,12 +54,12 @@ published service LineDiagram /** determines which type of symbols are displayed. <p>In this interface, only the two values - <member>ChartSymbolType::NONE</member> and - <member>ChartSymbolType::AUTO</member> are supported. Later + ChartSymbolType::NONE and + ChartSymbolType::AUTO are supported. Later versions may support the selection of the symbols shape.</p> <p>If you set this property to - <member>ChartSymbolType::AUTO</member>, you can change the + ChartSymbolType::AUTO, you can change the symbol shape for objects supporting the service ChartDataPointProperties or ChartDataRowProperties.</p> diff --git a/offapi/com/sun/star/chart/StockDiagram.idl b/offapi/com/sun/star/chart/StockDiagram.idl index bf291acc9670..96fbbbf2fa63 100644 --- a/offapi/com/sun/star/chart/StockDiagram.idl +++ b/offapi/com/sun/star/chart/StockDiagram.idl @@ -39,12 +39,12 @@ <p>Note that the data must have a specific structure for stock diagrams. Let us assume that data is interpreted, such that series are taken from columns (see property - <member>Diagram::DataRowSource</member>). Then you need tables of + Diagram::DataRowSource). Then you need tables of the following structures for different types:</p> <p><strong> - <member>StockDiagram::Volume</member> is <FALSE/><br> - <member>StockDiagram::UpDown</member> is <FALSE/> + StockDiagram::Volume is <FALSE/><br> + StockDiagram::UpDown is <FALSE/> </strong> <table border> <tr><td>Low</td><td>High</td><td>Close</td></tr> @@ -52,8 +52,8 @@ </table></p> <p><strong> - <member>StockDiagram::Volume</member> is <TRUE/><br> - <member>StockDiagram::UpDown</member> is <FALSE/> + StockDiagram::Volume is <TRUE/><br> + StockDiagram::UpDown is <FALSE/> </strong> <table border> <tr><td><strong>Volume</strong></td><td>Low</td><td>High</td><td>Close</td></tr> @@ -61,8 +61,8 @@ </table></p> <p><strong> - <member>StockDiagram::Volume</member> is <FALSE/><br> - <member>StockDiagram::UpDown</member> is <TRUE/> + StockDiagram::Volume is <FALSE/><br> + StockDiagram::UpDown is <TRUE/> </strong> <table border> <tr><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr> @@ -70,8 +70,8 @@ </table></p> <p><strong> - <member>StockDiagram::Volume</member> is <TRUE/><br> - <member>StockDiagram::UpDown</member> is <TRUE/> + StockDiagram::Volume is <TRUE/><br> + StockDiagram::UpDown is <TRUE/> </strong> <table border> <tr><td><strong>Volume</strong></td><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr> @@ -107,7 +107,7 @@ published service StockDiagram differences between open and closed data.</p> <p>If this property is <FALSE/>, the values of the first - series (or second if <member>StockDiagram::Volume</member> is + series (or second if StockDiagram::Volume is <TRUE/>) of the chart data are interpreted as the day's lowest value. The next series is interpreted as the day's highest value, and the last series is interpreted as the closing diff --git a/offapi/com/sun/star/chart/XStatisticDisplay.idl b/offapi/com/sun/star/chart/XStatisticDisplay.idl index 4bfab0da6b75..ae489d4c05ec 100644 --- a/offapi/com/sun/star/chart/XStatisticDisplay.idl +++ b/offapi/com/sun/star/chart/XStatisticDisplay.idl @@ -41,7 +41,7 @@ published interface XStatisticDisplay: com::sun::star::uno::XInterface /** @returns the properties of the up bars of a stock chart which has - <member>StockDiagram::UpDown</member> set to <TRUE/>. + StockDiagram::UpDown set to <TRUE/>. <p>The <em>UpBar</em> is the box that is drawn between the open and close value of a stock, when the closing value is @@ -54,7 +54,7 @@ published interface XStatisticDisplay: com::sun::star::uno::XInterface /** @returns the properties of the down bars of a stock chart which has - <member>StockDiagram::UpDown</member> set to <TRUE/>. + StockDiagram::UpDown set to <TRUE/>. <p>The <em>DownBar</em> is the box that is drawn between the open and close value of a stock, when the closing value is diff --git a/offapi/com/sun/star/chart2/DataSeries.idl b/offapi/com/sun/star/chart2/DataSeries.idl index 7a51135f68c6..b22287f39a79 100644 --- a/offapi/com/sun/star/chart2/DataSeries.idl +++ b/offapi/com/sun/star/chart2/DataSeries.idl @@ -108,7 +108,7 @@ service DataSeries /** establishes a broadcaster-listener mechanism for the com::sun::star::container::XIndexContainer to keep changes and the property - <member>DataSeries::AttributedDataPoints</member> in sync. + DataSeries::AttributedDataPoints in sync. */ // interface ::com::sun::star::container::XContainer; @@ -123,7 +123,7 @@ service DataSeries are of the same type.</p> <p>The result of the - <member>DataSeries::DataSequenceRoles</member> depends on the + DataSeries::DataSequenceRoles depends on the renderer service set here.</p> */ // stored at the DataSeriesGroup now diff --git a/offapi/com/sun/star/chart2/Legend.idl b/offapi/com/sun/star/chart2/Legend.idl index 5d66484092f8..1969ec68824e 100644 --- a/offapi/com/sun/star/chart2/Legend.idl +++ b/offapi/com/sun/star/chart2/Legend.idl @@ -55,9 +55,9 @@ service Legend /** Determines how the aspect ratio of the legend should roughly be. - <p>Set the Expansion to <member>::com::sun::star::chart::ChartLegendExpansion::HIGH</member> + <p>Set the Expansion to ::com::sun::star::chart::ChartLegendExpansion::HIGH for a legend that is positioned on the right or left hand - side. Use <member>LegendExpansion::WIDE</member> for a legend + side. Use LegendExpansion::WIDE for a legend that is positioned on top or the bottom.</p> */ [property] ::com::sun::star::chart::ChartLegendExpansion Expansion; diff --git a/offapi/com/sun/star/chart2/Symbol.idl b/offapi/com/sun/star/chart2/Symbol.idl index fee291578452..3d9c19f3aeba 100644 --- a/offapi/com/sun/star/chart2/Symbol.idl +++ b/offapi/com/sun/star/chart2/Symbol.idl @@ -42,7 +42,7 @@ struct Symbol com::sun::star::drawing::PolyPolygonBezierCoords PolygonCoords; /** Use the nth standard symbol, if #Style is set - to <member>SymbolStlye::STANDARD</member>. + to SymbolStlye::STANDARD. <p>If n is the number of standard symbols available in an implementation, the symbol number is @@ -84,18 +84,18 @@ struct Symbol /** The color used for drawing the border of symbols. <p>Only effective if #Style is - <member>SymbolStyle::AUTO</member>, - <member>SymbolStyle::STANDARD</member> or - <member>SymbolStyle::POLYGON</member>.</p> + SymbolStyle::AUTO, + SymbolStyle::STANDARD or + SymbolStyle::POLYGON.</p> */ long BorderColor; /** The color used for filling symbols that contain closed polygons. <p>Only effective if #Style is - <member>SymbolStyle::AUTO</member>, - <member>SymbolStyle::STANDARD</member> or - <member>SymbolStyle::POLYGON</member>.</p> + SymbolStyle::AUTO, + SymbolStyle::STANDARD or + SymbolStyle::POLYGON.</p> */ long FillColor; }; diff --git a/offapi/com/sun/star/chart2/SymbolStyle.idl b/offapi/com/sun/star/chart2/SymbolStyle.idl index 938ac772792e..794ce773b15d 100644 --- a/offapi/com/sun/star/chart2/SymbolStyle.idl +++ b/offapi/com/sun/star/chart2/SymbolStyle.idl @@ -39,18 +39,18 @@ enum SymbolStyle AUTO, /** uses one of the standard symbols. Which standard symbol is - given in <member>Symbol::StandardSymbol</member>. + given in Symbol::StandardSymbol. */ STANDARD, /** uses the symbol given in the com::sun::star::drawing::PolyPolygonBezierCoords - given in <member>Symbol::PolygonCoords</member>. + given in Symbol::PolygonCoords. */ POLYGON, /** uses the graphic given in - <member>Symbol::Graphic</member> as symbol. + Symbol::Graphic as symbol. */ GRAPHIC }; diff --git a/offapi/com/sun/star/chart2/XAxis.idl b/offapi/com/sun/star/chart2/XAxis.idl index 9be21e31bdac..bf338a12b7ac 100644 --- a/offapi/com/sun/star/chart2/XAxis.idl +++ b/offapi/com/sun/star/chart2/XAxis.idl @@ -52,7 +52,7 @@ interface XAxis : ::com::sun::star::uno::XInterface <p>If you do not want to render certain a sub-grid, in the corresponding XPropertySet the property - <member>GridProperties::Show</member> must be <FALSE/>.</p> + GridProperties::Show must be <FALSE/>.</p> */ sequence< com::sun::star::beans::XPropertySet > getSubGridProperties(); diff --git a/offapi/com/sun/star/chart2/XChartType.idl b/offapi/com/sun/star/chart2/XChartType.idl index 802fbe48324a..f02b25b16b33 100644 --- a/offapi/com/sun/star/chart2/XChartType.idl +++ b/offapi/com/sun/star/chart2/XChartType.idl @@ -66,7 +66,7 @@ interface XChartType : com::sun::star::uno::XInterface /** Returns a sequence of roles that are understood in addition to the mandatory roles (see - <member>XChartType::getSupportedMandatoryRoles()</member>). + XChartType::getSupportedMandatoryRoles()). <p>An example for an optional role are error-bars.</p> */ diff --git a/offapi/com/sun/star/chart2/data/LabelOrigin.idl b/offapi/com/sun/star/chart2/data/LabelOrigin.idl index 48c2a00d1601..cec70732a566 100644 --- a/offapi/com/sun/star/chart2/data/LabelOrigin.idl +++ b/offapi/com/sun/star/chart2/data/LabelOrigin.idl @@ -53,7 +53,7 @@ enum LabelOrigin SHORT_SIDE has the same effect as ROW, LONG_SIDE will have the same effect as COLUMN and the other way round. - @see <member>LabelOrigin::SHORT_SIDE</member> + @see LabelOrigin::SHORT_SIDE */ LONG_SIDE, diff --git a/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl b/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl index 7f382194223f..ff051eb69546 100644 --- a/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl +++ b/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl @@ -104,7 +104,7 @@ interface XDatabaseDataProvider /** is the command which should be executed, the type of command depends on the CommandType. - <p>In case of a #CommandType of <member>CommandType::COMMAND</member>, + <p>In case of a #CommandType of CommandType::COMMAND, means in case the #Command specifies an SQL statement, the inherited <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member> becomes relevant:<br/> @@ -177,7 +177,7 @@ interface XDatabaseDataProvider <p>This property is usually present together with the #Command and #CommandType properties, and is evaluated if and only if #CommandType - equals <member>CommandType::COMMAND</member>.</p> + equals CommandType::COMMAND.</p> */ [attribute,bound] boolean EscapeProcessing; diff --git a/offapi/com/sun/star/configuration/SetAccess.idl b/offapi/com/sun/star/configuration/SetAccess.idl index 8bce0a42e4be..4039017da3df 100644 --- a/offapi/com/sun/star/configuration/SetAccess.idl +++ b/offapi/com/sun/star/configuration/SetAccess.idl @@ -42,9 +42,9 @@ module com { module sun { module star { module configuration { @see com::sun::star::configuration::SetElement Child objects of this service generally implement SetElement. The template name returned by the child from - <member>XTemplateInstance::getTemplateName()</member> + XTemplateInstance::getTemplateName() corresponds to the name returned by the set from - <member>XTemplateContainer::getElementTemplateName()</member>. + XTemplateContainer::getElementTemplateName(). @see com::sun::star::configuration::GroupAccess A complementary service that provides for static heterogeneous groups of diff --git a/offapi/com/sun/star/configuration/SetUpdate.idl b/offapi/com/sun/star/configuration/SetUpdate.idl index 9b21a89ff36a..2f1e82b6896f 100644 --- a/offapi/com/sun/star/configuration/SetUpdate.idl +++ b/offapi/com/sun/star/configuration/SetUpdate.idl @@ -68,7 +68,7 @@ published service SetUpdate <p>Implementations that support insertion of objects that weren't obtained from within the hierarchy must reject elements that don't have the correct structure as described by the template, even if the object returns the - correct template name from <member>XTemplateInstance::getTemplateName()</member>. + correct template name from XTemplateInstance::getTemplateName(). </p> <p>Other ways in which an element may be moved among or within compatible sets diff --git a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl index 990f7240e893..ae6271d5a554 100644 --- a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl +++ b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl @@ -145,7 +145,7 @@ published service SimpleSetUpdate or <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> names the template to be instantiated or otherwise identifies the structure to be built. The implementation must at least support using the template - name obtained from <member>XTemplateContainer::getElementTemplateName()</member> + name obtained from XTemplateContainer::getElementTemplateName() as a service identifier, in which case the result shall be the same as if the corresponding member of com::sun::star::lang::XSingleServiceFactory had been called. diff --git a/offapi/com/sun/star/configuration/XTemplateContainer.idl b/offapi/com/sun/star/configuration/XTemplateContainer.idl index e7bb96fc3a41..6e8c94bb4c9f 100644 --- a/offapi/com/sun/star/configuration/XTemplateContainer.idl +++ b/offapi/com/sun/star/configuration/XTemplateContainer.idl @@ -35,7 +35,7 @@ <p> If multiple templates are supported, the supported factory interface may be com::sun::star::lang::XMultiServiceFactory, in which case the <atom>string</atom> returned from - <member>XTemplateContainer::getElementTemplateName()</member> can be used as + XTemplateContainer::getElementTemplateName() can be used as the service name argument. </p> diff --git a/offapi/com/sun/star/configuration/backend/DataImporter.idl b/offapi/com/sun/star/configuration/backend/DataImporter.idl index 8466ec6ad3e9..1cfdd6b5ea64 100644 --- a/offapi/com/sun/star/configuration/backend/DataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/DataImporter.idl @@ -82,9 +82,9 @@ published service DataImporter <dt><code>Entity</code> : <atom >string</atom></dt> <dd>An identifier for the entity in the destination backend for which the imported data should apply. The value will be passed - to <member>XLayerImporter::importLayerForEntity()</member>. + to XLayerImporter::importLayerForEntity(). If this parameter is missing, the implementation uses - <member>XLayerImporter::importLayer()</member> instead. + XLayerImporter::importLayer() instead. </dd> <dt><code>Component</code> : <atom >string</atom></dt> <dd>Names the component for which to import data. If this diff --git a/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl b/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl index 84fe80d81470..df9fff0f9264 100644 --- a/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl +++ b/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl @@ -47,7 +47,7 @@ published service UpdatableLayer <p> If the implementation supports com::sun::star::util::XTimeStamped, - then after executing <member>XUpdatableLayer::replaceWith()</member> + then after executing XUpdatableLayer::replaceWith() the timestamp will be the one for the replaced contents and if reading after updates is supported the next read will reproduce the replaced data. @@ -62,7 +62,7 @@ published service UpdatableLayer <p> Depending of the actual type (simple, i.e pure XLayer or composite, i.e XCompositeLayer) of the current layer and the provided replacement layer, the operation performed - by <member>XUpdatableLayer::replaceWith()</member>, will vary. + by XUpdatableLayer::replaceWith(), will vary. </p> <p> For the different current/replacement layer combinations, we have: <dl> diff --git a/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl b/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl index 4f1ec9a926cf..8966258bb513 100644 --- a/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl @@ -64,7 +64,7 @@ published interface XCompositeLayer : XLayer @param aSubLayerId Identifier of the sublayer to be read. <p> Must be one the identifiers returned by - <member>XCompositeLayer::listSubLayerIds()</member> + XCompositeLayer::listSubLayerIds() </p> @throws com::sun::star::lang::NullPointerException diff --git a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl index 25a453928153..c8a73bdaf9ec 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl @@ -41,7 +41,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface for a component. <p> Subsequent calls describe the contents of the layer - until a matching call to <member>XLayerHandler::endLayer()</member> + until a matching call to XLayerHandler::endLayer() is encountered. </p> @@ -57,7 +57,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface /** receives notification that a layer description is complete. - <p> Must match a previous call to <member>XLayerHandler::startLayer()</member>. + <p> Must match a previous call to XLayerHandler::startLayer(). </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -80,7 +80,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <p> Subsequent calls describe overrides to properties and members or items of the node until a matching call to - <member>XLayerHandler::endNode()</member>is encountered. + XLayerHandler::endNode()is encountered. </p> @param aName @@ -133,7 +133,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface </p> <p> Subsequent calls describe the difference from the template of properties and members or items of the node until - a matching call to <member>XLayerHandler::endNode()</member> + a matching call to XLayerHandler::endNode() is encountered. </p> @@ -145,7 +145,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <p> The value is a combination of NodeAttribute flags. Note that - <member>NodeAttribute::FUSE</member> has an impact on the + NodeAttribute::FUSE has an impact on the semantics of this method. </p> @@ -178,7 +178,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface </p> <p> Subsequent calls describe the difference from the template of properties and members or items of the node until - a matching call to <member>XLayerHandler::endNode()</member> + a matching call to XLayerHandler::endNode() is encountered. </p> @@ -193,7 +193,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <p> The value is a combination of NodeAttribute flags. Note that - <member>NodeAttribute::FUSE</member> has an impact on the + NodeAttribute::FUSE has an impact on the semantics of this method. </p> @@ -223,9 +223,9 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface /** receives notification that a node description is complete. <p> Must match the last open call to - <member>XLayerHandler::overrideNode()</member>, - <member>XLayerHandler::addOrReplaceNode()</member> or - <member>XLayerHandler::addOrReplaceNodeFromTemplate()</member>. + XLayerHandler::overrideNode(), + XLayerHandler::addOrReplaceNode() or + XLayerHandler::addOrReplaceNodeFromTemplate(). </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -271,7 +271,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface /** receives notification that an existing property is modified. <p> Subsequent calls describe new value(s) for the property until a - matching call to <member>XLayerHandler::endProperty()</member> + matching call to XLayerHandler::endProperty() is encountered. </p> @@ -410,7 +410,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface /** receives notification that a property description is complete. <p> Must match an open call to - <member>XLayerHandler::overrideProperty()</member>, + XLayerHandler::overrideProperty(), </p> @throws com::sun::star::configuration::backend::MalformedDataException diff --git a/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl b/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl index 48ba982ec3fe..1425b9c468df 100644 --- a/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl @@ -92,7 +92,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface to update data of a component on behalf of an entity. <p> The layer id returned is one of the layer ids obtained from - <member>XMultiLayerStratum::listLayerIds()</member> for the same + XMultiLayerStratum::listLayerIds() for the same component and entity. </p> @@ -137,8 +137,8 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface @param aLayerId identifier of the layers to be accessed. <p>Layer ids can be obtained from - <member>XMultiLayerStratum::listLayerIds()</member> or - <member>XMultiLayerStratum::getUpdateLayerId()</member>. + XMultiLayerStratum::listLayerIds() or + XMultiLayerStratum::getUpdateLayerId(). </p> @param aTimestamp @@ -182,7 +182,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface @param aLayerIds identifiers of the layers to be accessed. <p>Layer ids can be obtained from - <member>XMultiLayerStratum::listLayerIds()</member>. + XMultiLayerStratum::listLayerIds(). </p> @param aTimestamp @@ -232,7 +232,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface @param aLayerIds identifiers of the layers to be accessed. <p>Layer ids can be obtained from - <member>XMultiLayerStratum::listLayerIds()</member>. + XMultiLayerStratum::listLayerIds(). </p> @param aTimestamps @@ -283,7 +283,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface @param aLayerId identifier of the layer to be accessed for writing. <p>A layer id for writing can be obtained from - <member>XMultiLayerStratum::getUpdateLayerId()</member>. + XMultiLayerStratum::getUpdateLayerId(). </p> @return diff --git a/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl b/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl index 0285d9e6dadd..a56482f3efa2 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl @@ -45,7 +45,7 @@ published interface XUpdatableLayer : XLayer <p> After the replacement has been performed, reading the layer will return the new content. Some implementations may not support this, so after an update - <member>XLayer::readData()</member> may fail. + XLayer::readData() may fail. </p> @param aNewLayer diff --git a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl index a0ac6338f07c..4ee26ed0b44c 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl @@ -46,7 +46,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::IllegalAccessException if the target layer is read-only <p><em>Some implementations can only detect this when executing - <member>XUpdateHandler::endUpdate()</member></em> + XUpdateHandler::endUpdate()</em> </p> @throws com::sun::star::lang::WrappedTargetException @@ -59,7 +59,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface /** receives notification that the current update description is complete. - <p> Must match a previous call to <member>XUpdateHandler::startUpdate()</member>. + <p> Must match a previous call to XUpdateHandler::startUpdate(). </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -86,7 +86,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <p> Subsequent calls describe changes to properties and items or members of the node until a matching call to - <member>XUpdateHandler::endNode()</member> is encountered. + XUpdateHandler::endNode() is encountered. </p> @param aName @@ -149,7 +149,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface </p> <p> Subsequent calls describe the difference from the template of properties, items or members of the node until a matching call - to <member>XUpdateHandler::endNode()</member> is encountered. + to XUpdateHandler::endNode() is encountered. </p> @param aName @@ -160,7 +160,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <p> The value is a combination of NodeAttribute flags. Note that - <member>NodeAttribute::FUSE</member> has an impact on the + NodeAttribute::FUSE has an impact on the semantics of this method. </p> @@ -193,7 +193,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface </p> <p> Subsequent calls describe the difference from the template of properties or members of the node until a matching call - to <member>XUpdateHandler::endNode()</member> is encountered. + to XUpdateHandler::endNode() is encountered. </p> @param aName @@ -207,7 +207,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <p> The value is a combination of NodeAttribute flags. Note that - <member>NodeAttribute::FUSE</member> has an impact on the + NodeAttribute::FUSE has an impact on the semantics of this method. </p> @@ -237,9 +237,9 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface /** receives notification that a node modification is complete. <p> Must match the last open call to - <member>XUpdateHandler::modifyNode()</member>, - <member>XUpdateHandler::addOrReplaceNode()</member> or - <member>XUpdateHandler::addOrReplaceNodeFromTemplate()</member>. + XUpdateHandler::modifyNode(), + XUpdateHandler::addOrReplaceNode() or + XUpdateHandler::addOrReplaceNodeFromTemplate(). </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -286,7 +286,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <p> Subsequent calls describe changes to the value(s) of the property until a matching call to - <member>XUpdateHandler::endProperty()</member> is encountered. + XUpdateHandler::endProperty() is encountered. </p> @param aName @@ -453,7 +453,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface /** receives notification that a property modification is complete. <p> Must match the last open call to - <member>XUpdateHandler::modifyProperty()</member>. + XUpdateHandler::modifyProperty(). </p> @throws com::sun::star::configuration::backend::MalformedDataException diff --git a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl index db548afd8bf0..4055de129b79 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragSource; -/** A DragGestureEvent is passed to the method <member>XDragGestureListener::dragGestureRecognized()</member> +/** A DragGestureEvent is passed to the method XDragGestureListener::dragGestureRecognized() when a particular XDragGestureRecognizer detects that a platform dependent drag initiating gesture has occurred on the component that it is tracking. diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl index 75b7cf2958fd..2e65562a0aa1 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module datatransfer { module dnd { DragSourceListener and providing the Transferable state to enable the data transfer. </p> - <p>An instance of this class is created as a result of the method <member>XDragSource::startDrag()</member> + <p>An instance of this class is created as a result of the method XDragSource::startDrag() being successfully invoked. This instance is responsible for tracking the state of the operation on behalf of the drag source and dispatching state changes to the drag source listener. </p> diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl index ad276588d9a4..095254813f41 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl @@ -43,9 +43,9 @@ published interface XDropTargetDragContext: com::sun::star::uno::XInterface <p>This method should be called from the methods of XDropTargetListener <ul> - <li><member>XDropTargetListener::dragEnter()</member></li> - <li><member>XDropTargetListener::dragOver()</member></li> - <li><member>XDropTargetListener::dragActionChanged()</member></li> + <li>XDropTargetListener::dragEnter()</li> + <li>XDropTargetListener::dragOver()</li> + <li>XDropTargetListener::dragActionChanged()</li> </ul> if the implementation wishes to accept the drag operation with the specified action.</p> diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl index 3dfc60d5e7ae..0bf36c49924e 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl @@ -56,7 +56,7 @@ published interface XDropTargetDropContext : com::sun::star::uno::XInterface /** Reject the drop as a result of examining the available com::sun::star::datatransfer::DataFlavor types - received in the <member>XDropTargetListener::dragEnter()</member> method. + received in the XDropTargetListener::dragEnter() method. */ void rejectDrop(); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl index 79857d48c0a8..50323a23a51b 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl @@ -45,7 +45,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener should occur before returning from drop in a normal flow of operation. Also, the implementor of XDropTargetListener should not assume the DropTargetDropEvent to be meaningful after returning - from the <member>XDropTargetListener::drop()</member> method.</p> + from the XDropTargetListener::drop() method.</p> @param dtde The DropTargetDropEvent. diff --git a/offapi/com/sun/star/document/ExportFilter.idl b/offapi/com/sun/star/document/ExportFilter.idl index 5653a0ea5ff7..c8c7de0622e8 100644 --- a/offapi/com/sun/star/document/ExportFilter.idl +++ b/offapi/com/sun/star/document/ExportFilter.idl @@ -80,7 +80,7 @@ published service ExportFilter of service FilterFactory. </li> </ul> - See description of service <member>FilterFactory::XNameContainer</member> for a description of + See description of service FilterFactory::XNameContainer for a description of possible configuration data. </p> */ diff --git a/offapi/com/sun/star/document/ExtendedTypeDetection.idl b/offapi/com/sun/star/document/ExtendedTypeDetection.idl index 9638f2b05dc0..324c6d20e18f 100644 --- a/offapi/com/sun/star/document/ExtendedTypeDetection.idl +++ b/offapi/com/sun/star/document/ExtendedTypeDetection.idl @@ -76,8 +76,8 @@ published service ExtendedTypeDetection <li>or <NULL/> if format is unknown nor supported.</li> </ul> May be that given descriptor already includes the opened document stream as parameter - <member>MediaDescriptor::InputStream</member>. Then this one should be used every time. - If it's not included in descriptor the value of <member>MediaDescriptor::URL</member> + MediaDescriptor::InputStream. Then this one should be used every time. + If it's not included in descriptor the value of MediaDescriptor::URL must be used to open requested resource by this service. <br> Note: The stream should be added to the descriptor if it wasn't a part of them before. diff --git a/offapi/com/sun/star/document/ImportFilter.idl b/offapi/com/sun/star/document/ImportFilter.idl index 7b7dc1602716..c7f61bfd8751 100644 --- a/offapi/com/sun/star/document/ImportFilter.idl +++ b/offapi/com/sun/star/document/ImportFilter.idl @@ -53,7 +53,7 @@ published service ImportFilter <p> It's used to filter a document at loading time. The target document should be already set by using another interface - <member>ImportFilter::XImporter</member> which is supported by this service too. + ImportFilter::XImporter which is supported by this service too. </p> <p> @@ -80,7 +80,7 @@ published service ImportFilter of service FilterFactory. </li> </ul> - See description of service <member>FilterFactory::XNameContainer</member> for a description of + See description of service FilterFactory::XNameContainer for a description of possible configuration data. </p> */ diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl index bdbab9980c6a..fceaede3d0ec 100644 --- a/offapi/com/sun/star/document/MediaDescriptor.idl +++ b/offapi/com/sun/star/document/MediaDescriptor.idl @@ -142,7 +142,7 @@ service MediaDescriptor */ [optional,property] sequence< ::com::sun::star::beans::NamedValue > EncryptionData; - /** same as <member>MediaDescriptor::URL</member> + /** same as MediaDescriptor::URL <p> It will be supported for compatibility reasons only. @@ -164,7 +164,7 @@ service MediaDescriptor */ [optional,property] string FilterName; - /** same as <member>MediaDescriptor::FilterOptions</member> + /** same as MediaDescriptor::FilterOptions <p> It will be supported for compatibility reasons only. @@ -178,9 +178,9 @@ service MediaDescriptor <p> Some filters need additional parameters; use only together with property - <member>MediaDescriptor::FilterName</member>. Details must be documented + MediaDescriptor::FilterName. Details must be documented by the filter. This is an old format for some filters. If a string is not - enough, filters can use the property <member>MediaDescriptor::FilterData</member>. + enough, filters can use the property MediaDescriptor::FilterData. </p> */ [optional,property] string FilterOptions; @@ -190,7 +190,7 @@ service MediaDescriptor <p> This is a parameter that can be used for any properties specific for a special filter type. It should be used if - <member>MediaDescriptor::FilterOptions</member> isn't enough. + MediaDescriptor::FilterOptions isn't enough. </p> */ [optional,property] any FilterData; @@ -280,22 +280,22 @@ service MediaDescriptor <tr> <td><em>ReadOnly</em></td> <td>R</td> - <td><member>MediaDescriptor::ReadOnly</member></td> + <td>MediaDescriptor::ReadOnly</td> </tr> <tr> <td><em>Preview</em></td> <td>B</td> - <td><member>MediaDescriptor::Preview</member></td> + <td>MediaDescriptor::Preview</td> </tr> <tr> <td><em>AsTemplate</em></td> <td>T</td> - <td><member>MediaDescriptor::AsTemplate</member></td> + <td>MediaDescriptor::AsTemplate</td> </tr> <tr> <td><em>Hidden</em></td> <td>H</td> - <td><member>MediaDescriptor::Hidden</member></td> + <td>MediaDescriptor::Hidden</td> </tr> </table> </p> @@ -347,7 +347,7 @@ service MediaDescriptor */ [optional,property] sequence< byte > PostData; - /** use <member>MediaDescriptor::PostData</member> instead of this + /** use MediaDescriptor::PostData instead of this <p> Same as PostData, but the data is transferred as a string @@ -451,9 +451,9 @@ service MediaDescriptor /** name of the template instead of the URL <p> - The logical name of a template to load. Together with the <member>MediaDescriptor::TemplateRegion</member> + The logical name of a template to load. Together with the MediaDescriptor::TemplateRegion property it can be used instead of the URL of the template. Use always in conjunction with - <member>MediaDescriptor::TemplateRegionName</member>. + MediaDescriptor::TemplateRegionName. </p> */ [optional,property] string TemplateName; @@ -461,9 +461,9 @@ service MediaDescriptor /** name of the template instead of the URL <p> - The logical name of a template to load. Together with the <member>MediaDescriptor::TemplateRegion</member> + The logical name of a template to load. Together with the MediaDescriptor::TemplateRegion property it can be used instead of the URL of the template. Use always in conjunction with - <member>MediaDescriptor::TemplateRegionName</member>. + MediaDescriptor::TemplateRegionName. </p> */ [optional,property] string TemplateRegionName; diff --git a/offapi/com/sun/star/document/XTypeDetection.idl b/offapi/com/sun/star/document/XTypeDetection.idl index 64613f5830da..158fe88a580a 100644 --- a/offapi/com/sun/star/document/XTypeDetection.idl +++ b/offapi/com/sun/star/document/XTypeDetection.idl @@ -61,14 +61,14 @@ published interface XTypeDetection: com::sun::star::uno::XInterface MediaDescriptor <p> - Instead of <member>XTypeDetection::queryTypeByURL()</member> this function + Instead of XTypeDetection::queryTypeByURL() this function use a MediaDescriptor to specify the document for detection. Such descriptor hold different information about the document. He will be passed to any part of made detection process and every part can change it to actualize it. - The property <member>MediaDescriptor::URL</member> should be set on + The property MediaDescriptor::URL should be set on this descriptor as minimum. It specifies the location of the document. - If this parameter is missing another one is required: <member>MediaDescriptor::InputStream</member>. + If this parameter is missing another one is required: MediaDescriptor::InputStream. This can be useful to prevent operation against multiple opening of the stream and perform the operation. If this stream isn't already included the detection will open it (if allowed!) and add it to the descriptor so it will be available for @@ -76,7 +76,7 @@ published interface XTypeDetection: com::sun::star::uno::XInterface A combination of both parameters can be useful to perform the operation and make results more stable; but only one of them is required. Of course its possible to specify more document properties (e.g. - <member>MediaDescriptor::ReadOnly</member>). + MediaDescriptor::ReadOnly). <br> As an additional feature it's possible to suppress "deep" detection by using argument <var>AllowDeep</var>. diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl index 3eb77c9c920a..34f394308cd1 100644 --- a/offapi/com/sun/star/document/XUndoManagerListener.idl +++ b/offapi/com/sun/star/document/XUndoManagerListener.idl @@ -36,7 +36,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener /** is called when an undo action is added to the undo stack. <p>Note that the action must not necessarily be the new top element of the stack: In case there's an - open Undo context, <member>UndoManagerEvent::UndoContextDepth</member> will be greater <code>0</code>, + open Undo context, UndoManagerEvent::UndoContextDepth will be greater <code>0</code>, and the newly added action will be subordinate of the context action.</p> @see XUndoManager::addUndoAction @@ -73,8 +73,8 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener /** is called when a new Undo context has been entered. - <p><member>UndoManagerEvent::UndoActionTitle</member> carries the title of the Undo context, and - <member>UndoManagerEvent::UndoContextDepth</member> the number of open Undo contexts, including the + <p>UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and + UndoManagerEvent::UndoContextDepth the number of open Undo contexts, including the one just entered.</p> @see XUndoManager::enterUndoContext @@ -83,8 +83,8 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener /** is called when a new hidden Undo context has been entered. - <p><member>UndoManagerEvent::UndoActionTitle</member> carries the title of the Undo context, and - <member>UndoManagerEvent::UndoContextDepth</member> the number of open Undo contexts, including the + <p>UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and + UndoManagerEvent::UndoContextDepth the number of open Undo contexts, including the one just entered.</p> @see XUndoManager::enterUndoContext @@ -93,8 +93,8 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener /** is called when an Undo context has been left. - <p><member>UndoManagerEvent::UndoActionTitle</member> carries the title of the Undo context, and - <member>UndoManagerEvent::UndoContextDepth</member> the number of open Undo contexts, exluding the + <p>UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and + UndoManagerEvent::UndoContextDepth the number of open Undo contexts, exluding the one just left.</p> @see XUndoManager::leaveUndoContext @@ -105,7 +105,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener /** is calledn when a hidden Undo context has been left. - <p><member>UndoManagerEvent::UndoActionTitle</member> is empty, as hidden Undo contexts don't have + <p>UndoManagerEvent::UndoActionTitle is empty, as hidden Undo contexts don't have a title.</p> @see XUndoManager::leaveHiddenUndoContext @@ -117,7 +117,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener /** is called when an Undo context has been left, but no actions have been added within this context. <p>In such a case, the context which has just been left will not contribute to the undo stack, but instead - be silently removed. Consequently, the <member>UndoManagerEvent::UndoActionTitle</member> is empty.</p> + be silently removed. Consequently, the UndoManagerEvent::UndoActionTitle is empty.</p> @see XUndoManager::leaveUndoContext @see leftContext diff --git a/offapi/com/sun/star/drawing/TextProperties.idl b/offapi/com/sun/star/drawing/TextProperties.idl index e0d712353638..e67110e4d52a 100644 --- a/offapi/com/sun/star/drawing/TextProperties.idl +++ b/offapi/com/sun/star/drawing/TextProperties.idl @@ -140,9 +140,9 @@ published service TextProperties /** This is the distance from the left edge of the Shape to the left edge of the text. - <p>This is only useful if <member>Text::TextHorizontalAdjust</member> is + <p>This is only useful if Text::TextHorizontalAdjust is <const>BLOCK</const> or <const>STRETCH</const> or if - <member>Text::TextFitSize</member> is <TRUE/>.</p> + Text::TextFitSize is <TRUE/>.</p> */ [property] long TextLeftDistance; @@ -150,9 +150,9 @@ published service TextProperties /** This is the distance from the right edge of the Shape to the right edge of the text. - <p>This is only useful if <member>Text::TextHorizontalAdjust</member> is + <p>This is only useful if Text::TextHorizontalAdjust is <const>BLOCK</const> or <const>STRETCH</const> - or if <member>Text::TextFitSize</member> is <TRUE/>.</p> + or if Text::TextFitSize is <TRUE/>.</p> */ [property] long TextRightDistance; @@ -160,8 +160,8 @@ published service TextProperties /** This is the distance from the upper edge of the Shape to the upper edge of the text. - <p>This is only useful if <member>Text::TextVerticalAdjust</member> is - <const>BLOCK</const> or if <member>Text::TextFitSize</member> is + <p>This is only useful if Text::TextVerticalAdjust is + <const>BLOCK</const> or if Text::TextFitSize is <TRUE/>.</p> */ [property] long TextUpperDistance; @@ -172,8 +172,8 @@ published service TextProperties - <p>This is only useful if <member>Text::TextVerticalAdjust</member> is - <const>BLOCK</const> or if <member>Text::TextFitSize</member> is + <p>This is only useful if Text::TextVerticalAdjust is + <const>BLOCK</const> or if Text::TextFitSize is <TRUE/>.</p> */ [property] long TextLowerDistance; diff --git a/offapi/com/sun/star/drawing/XSlideRenderer.idl b/offapi/com/sun/star/drawing/XSlideRenderer.idl index ef3e1d7ecb53..40835ef05654 100644 --- a/offapi/com/sun/star/drawing/XSlideRenderer.idl +++ b/offapi/com/sun/star/drawing/XSlideRenderer.idl @@ -65,7 +65,7 @@ interface XSlideRenderer [in] com::sun::star::awt::Size aMaximumPreviewPixelSize, [in] short nSuperSampleFactor); - /** Exactly the same functionality as <member>createPreview()</member>, + /** Exactly the same functionality as createPreview(), only a different return type: com::sun::star::rendering::XBitmap instead of com::sun::star::awt::XBitmap. diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl index fa371428647d..3f9ec9b42a20 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl @@ -30,7 +30,7 @@ interface XConfiguration; /** A single explicit request for a configuration change. <p>The requested change is committed to a configuration only when the - <member>execute()</member> method is called. Configuration change + execute() method is called. Configuration change requests are executed asynchronously. This is done to avoid reentrance problems with objects that are registered as XConfigurationChangeListener and at the same time make diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationController.idl b/offapi/com/sun/star/drawing/framework/XConfigurationController.idl index 46176fb622b0..83983095e75e 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationController.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationController.idl @@ -41,8 +41,8 @@ interface XResource; resources.</li> <li>The requested configuration describes what the current configuration should be. The requested configuration is changed usually by calling - <member>requestResourceActivation()</member> and - <member>requestResourceDeactivation()</member>.</li> + requestResourceActivation() and + requestResourceDeactivation().</li> </ul></p> <p>When the two configurations differ then the current configuration is @@ -51,7 +51,7 @@ interface XResource; <ol> <li>when the last pending request for configuration changes has been processed,</li> - <li>when the <member>update()</member> method is called.</li> + <li>when the update() method is called.</li> <li>when the configuration manager it is unlocked after formerly being locked.</li> </ol></p> @@ -60,8 +60,8 @@ interface XResource; <ol> <li>First the requested configuration is updated iteratively: Every request that is being made by calling - <member>requestResourceActivation()</member> or - <member>requestResourceDeactivation()</member> results in one or more + requestResourceActivation() or + requestResourceDeactivation() results in one or more function objects, that each implement the XConfigurationChangeRequest interface. These are inserted into a queue. The request objects in the queue are processed @@ -101,7 +101,7 @@ interface XResource; activation of a resource has been requested and the resource is not yet active in the requested configuration. The event is sent when the configuration change request is executed, not when the - <member>requestResourceActivation()</member> call is made.</p> + requestResourceActivation() call is made.</p> <p>The <member scope="ConfigurationChangeEvent">ResourceId</member> member is set to the requested resource. The #ResourceObject member is not set.</p></li> @@ -109,7 +109,7 @@ interface XResource; deactivation of a resource has been requested and the resource is active in the requested configuration. The event is sent when the configuration change request is executed that is created when for - example <member>requestResourceDeactivation()</member> is called.</p> + example requestResourceDeactivation() is called.</p> <p>The #ResourceId member is set to the requested resource. The #ResourceObject member is not set.</p></li> @@ -192,15 +192,15 @@ interface XConfigurationController <p>This is only necessary when more than one change request is being made in a row. It prevents an update being made (with all the visible UI changes) before all change requests are being made.</p> - <p>Recursive <member>lock()</member> calls are recognized: the - configuration controller is locked while <member>lock()</member> was - called more often than <member>unlock()</member>.</p> + <p>Recursive lock() calls are recognized: the + configuration controller is locked while lock() was + called more often than unlock().</p> */ void lock (); /** Unlock the processing of configuration change requests. - <p>When <member>unlock()</member> is called as many times as - <member>lock()</member> and the queue of configuration change + <p>When unlock() is called as many times as + lock() and the queue of configuration change requests is not empty the configuration controller continues the processing of the change requests. An update of the current configuration will eventually being made.</p> @@ -229,8 +229,8 @@ interface XConfigurationController /** Replace the requested configuration with the given configuration and schedule an update of the current configuration. - <p>Together with the <member>getCurrentConfiguration()</member> and - <member>getRequestedConfiguration()</member> methods this + <p>Together with the getCurrentConfiguration() and + getRequestedConfiguration() methods this allows the saving and restoring of configurations. However, the given configuration can have other origins then these methods.</p> <p>The given configuration is transformed into a list of of change @@ -244,7 +244,7 @@ interface XConfigurationController configuration.</p> @param xConfiguration This typically is a configuration that was obtained with an - earlier <member>getRequestedConfiguration()</member> call. + earlier getRequestedConfiguration() call. */ void restoreConfiguration ([in] XConfiguration xConfiguration); }; diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl index 26f59084057b..2ed471ab4f65 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl @@ -48,8 +48,8 @@ interface XConfigurationControllerRequestQueue <p>This method should not be called from outside the drawing framework. Other sub controllers of the drawing framework are typical callers. They can add change requests that can not be made with the - <member>requestResourceActivation()</member> and - <member>requestResourceDeactivation()</member> methods.</p> + requestResourceActivation() and + requestResourceDeactivation() methods.</p> @param xRequest The configuration change represented by this request object must only be commited to the configuration when the diff --git a/offapi/com/sun/star/drawing/framework/XPane.idl b/offapi/com/sun/star/drawing/framework/XPane.idl index b7dfc6baeb53..4c29e3b9bc8d 100644 --- a/offapi/com/sun/star/drawing/framework/XPane.idl +++ b/offapi/com/sun/star/drawing/framework/XPane.idl @@ -46,7 +46,7 @@ interface XPane com::sun::star::rendering::XCanvas object is expected to be associated with the <type scope="com::sun::star::awt">XWindow</type> object returned by - <member>getWindow()</member>. + getWindow(). @return When the com::sun::star::rendering::XCanvas interface is not supported then an empty reference is returned. diff --git a/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl b/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl index a3d99fba5af8..1da726ba138d 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl @@ -52,7 +52,7 @@ interface XResourceFactoryManager /** Remove a resource factory for one type of resource. When the factory has been registered for other URLs as well then it remains registered for them. Use the - <member>removeResourceFactoryForReference()</member> to remove a + removeResourceFactoryForReference() to remove a factory completely. @param sResourceURL The URL for which to remove the resource factory. diff --git a/offapi/com/sun/star/drawing/framework/XResourceId.idl b/offapi/com/sun/star/drawing/framework/XResourceId.idl index 5a9be782fd2e..143893eedd0f 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceId.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceId.idl @@ -117,7 +117,7 @@ interface XResourceId /** Return whether the anchor of the called resource id object represents the same resource as the given anchor URL. This is a - convenience variant of the <member>isBoundTo()</member> function + convenience variant of the isBoundTo() function that can also be seen as an optimization for the case that the anchor consists of exactly one URL. @param xAnchor @@ -125,7 +125,7 @@ interface XResourceId @param eMode This mode specifies how the called resource has to be bound to the given anchor in order to have this function return. See the - description of <member>isBoundTo()</member> for more + description of isBoundTo() for more information. */ boolean isBoundToURL ( diff --git a/offapi/com/sun/star/drawing/framework/XTabBar.idl b/offapi/com/sun/star/drawing/framework/XTabBar.idl index 67f3d2141274..e3b54bfbb302 100644 --- a/offapi/com/sun/star/drawing/framework/XTabBar.idl +++ b/offapi/com/sun/star/drawing/framework/XTabBar.idl @@ -81,7 +81,7 @@ interface XTabBar /** Return a sequence of all the tab bar buttons. <p>Their order reflects the visible order in the tab bar.</p> <p>This method can be used when - <member>addTabBarButtonAfter()</member> does not provide enough + addTabBarButtonAfter() does not provide enough control as to where to insert a new button.</p> */ sequence<TabBarButton> getTabBarButtons (); diff --git a/offapi/com/sun/star/form/FormControlModel.idl b/offapi/com/sun/star/form/FormControlModel.idl index f2ff078b7d9b..edb04ed68660 100644 --- a/offapi/com/sun/star/form/FormControlModel.idl +++ b/offapi/com/sun/star/form/FormControlModel.idl @@ -67,7 +67,7 @@ published service FormControlModel determined automatically.</p> <p>Each component which supports a tabstop must provide a - <member>FormControlModel::TabIndex</member> property.</p> + FormControlModel::TabIndex property.</p> <p>Normally, a FormController instance is evaluating this property.</p> */ diff --git a/offapi/com/sun/star/form/NavigationBarMode.idl b/offapi/com/sun/star/form/NavigationBarMode.idl index c6a7906c4b49..6a241bde05e1 100644 --- a/offapi/com/sun/star/form/NavigationBarMode.idl +++ b/offapi/com/sun/star/form/NavigationBarMode.idl @@ -33,7 +33,7 @@ published enum NavigationBarMode form is only possible with the keyboard (TAB/SHIFT TAB). <p>Note that when this mode is set, a simultaneous TabulatorCycle - value of <member>TabulatorCycle::CURRENT</member> means that you cannot travel + value of TabulatorCycle::CURRENT means that you cannot travel between records anymore.</p> @see TabulatorCycle diff --git a/offapi/com/sun/star/form/binding/BindableControlModel.idl b/offapi/com/sun/star/form/binding/BindableControlModel.idl index e4b6809cadfb..3aa58c75422f 100644 --- a/offapi/com/sun/star/form/binding/BindableControlModel.idl +++ b/offapi/com/sun/star/form/binding/BindableControlModel.idl @@ -48,8 +48,8 @@ service BindableControlModel then every change in the control model's value is <em>immediately</em> reflected in the external binding.</p> - <p>If the binding set via this interface supports the <member>ValueBinding::ReadOnly</member> - and <member>ValueBinding::Relevant</member> properties, they're respected by the control model: + <p>If the binding set via this interface supports the ValueBinding::ReadOnly + and ValueBinding::Relevant properties, they're respected by the control model: <ul><li>The control model's own <code>ReadOnly</code> property (if present) is kept in sync with the binding's <code>ReadOnly</code> property. That is, any control using the value binding is read-only as long as the binding is.</li> @@ -62,11 +62,11 @@ service BindableControlModel <p>In both cases, explicit changes of the model's property are ignored if they would relax the restriction imposed by the binding.<br/> For instance, if the binding declares it's value to - be read-only (indicated by <member>ValueBinding::ReadOnly</member> being <TRUE/>), then + be read-only (indicated by ValueBinding::ReadOnly being <TRUE/>), then any attempt to set the <code>ReadOnly</code> property of the control model to <FALSE/> will fail. However, if the binding's value is not read-only, then the <code>ReadOnly</code> property at the control model can be freely set.<br/> - The very same holds for the binding's <member>ValueBinding::Relevant</member> and the control + The very same holds for the binding's ValueBinding::Relevant and the control model's <code>Enabled</code> properties.</p> */ interface XBindableValue; diff --git a/offapi/com/sun/star/form/binding/XListEntryListener.idl b/offapi/com/sun/star/form/binding/XListEntryListener.idl index f98cd0ab310f..9bc1513f5a16 100644 --- a/offapi/com/sun/star/form/binding/XListEntryListener.idl +++ b/offapi/com/sun/star/form/binding/XListEntryListener.idl @@ -34,18 +34,18 @@ interface XListEntryListener : com::sun::star::lang::XEventListener /** notifies the listener that a single entry in the list has change @param Source - is the event describing the change. The <member>ListEntryEvent::Position</member> + is the event describing the change. The ListEntryEvent::Position member denotes the position of the changed entry, the first (and only) element - of the <member>ListEntryEvent::Entries</member> member denotes the new string + of the ListEntryEvent::Entries member denotes the new string */ void entryChanged( [in] ListEntryEvent Source ); /** notifies the listener that a range of entries has been inserted into the list @param Source - is the event describing the change. The <member>ListEntryEvent::Position</member> + is the event describing the change. The ListEntryEvent::Position member denotes the position of the first inserted entry, the - <member>ListEntryEvent::Entries</member> member contains the strings which have + ListEntryEvent::Entries member contains the strings which have been inserted. */ void entryRangeInserted( [in] ListEntryEvent Source ); @@ -53,9 +53,9 @@ interface XListEntryListener : com::sun::star::lang::XEventListener /** notifies the listener that a range of entries has been removed from the list @param Source - is the event describing the change. The <member>ListEntryEvent::Position</member> + is the event describing the change. The ListEntryEvent::Position member denotes the position of the first removed entry, the - <member>ListEntryEvent::Count</member> member the number of removed entries. + ListEntryEvent::Count member the number of removed entries. */ void entryRangeRemoved( [in] ListEntryEvent Source ); diff --git a/offapi/com/sun/star/form/component/DatabaseListBox.idl b/offapi/com/sun/star/form/component/DatabaseListBox.idl index 54df8a5ef802..acdbc898b81c 100644 --- a/offapi/com/sun/star/form/component/DatabaseListBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseListBox.idl @@ -36,7 +36,7 @@ one possibility to specify the list entries: The display strings in the <member scope="com::sun::star::awt">UnoControlListBoxModel::StringItemList</member> - property and the corresponding values in the <member>ListBox::ListSource</member> + property and the corresponding values in the ListBox::ListSource property.</p> <p>This service here extends this mimic. It allows to fill the list from a data source. @@ -102,36 +102,36 @@ published service DatabaseListBox /** describes the kind of list source used. - <p>Depending on the value of this property, the way the value of <member>ListBox::ListSource</member> + <p>Depending on the value of this property, the way the value of ListBox::ListSource is evaluated varies. <dl> <dt><member scope="com::sun::star::form">ListSourceType::VALUELIST</member></dt> - <dd>The elements in the string sequence in <member>ListBox::ListSource</member> + <dd>The elements in the string sequence in ListBox::ListSource build up the entry list.</dd> <dt><member scope="com::sun::star::form">ListSourceType::TABLE</member></dt> - <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + <dd>The first element of the string sequence in ListBox::ListSource determines the table which the list result set should be based on.</dd> <dt><member scope="com::sun::star::form">ListSourceType::QUERY</member></dt> - <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + <dd>The first element of the string sequence in ListBox::ListSource determines the query which the list result set should be based on.<br/> For retrieving the query, the connection which the data form is working with (<member scope="com::sun::star::sdb">RowSet::ActiveConnection</member>) is queried for the com::sun::star::sdb::XQueriesSupplier interface.</dd> <dt><member scope="com::sun::star::form">ListSourceType::SQL</member></dt> - <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + <dd>The first element of the string sequence in ListBox::ListSource contains the SQL statement which the list result set should be based on.</p> <dt><member scope="com::sun::star::form">ListSourceType::SQLPASSTHROUGH</member></dt> - <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + <dd>The first element of the string sequence in ListBox::ListSource contains the SQL statement which the list result set should be based on.<br/> The statement is not analyzed by the parser. This means that you can use database specific SQL features here, but, on the other hand, loose features like parameter value substitution.</dd> <dt><member scope="com::sun::star::form">ListSourceType::TABLEFIELDS</member></dt> - <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + <dd>The first element of the string sequence in ListBox::ListSource determines the table whose column names should fill the list.</dd> </dl> </p> diff --git a/offapi/com/sun/star/form/component/TextField.idl b/offapi/com/sun/star/form/component/TextField.idl index 6308ba7a2667..a8cd8f9d273d 100644 --- a/offapi/com/sun/star/form/component/TextField.idl +++ b/offapi/com/sun/star/form/component/TextField.idl @@ -40,7 +40,7 @@ published service TextField /** specifies optional capabilities for displaying and inputting formatted text. - <p>If the <member>RichTextControl::RichText</member> property is set to <TRUE/>, + <p>If the RichTextControl::RichText property is set to <TRUE/>, then the TextField component will disable it's reset capabilities. This means that all calls to com::sun::star::form::XReset::reset() will be ignored.</p> */ diff --git a/offapi/com/sun/star/form/runtime/XFilterControllerListener.idl b/offapi/com/sun/star/form/runtime/XFilterControllerListener.idl index db1384a1c7f0..bc688cb137de 100644 --- a/offapi/com/sun/star/form/runtime/XFilterControllerListener.idl +++ b/offapi/com/sun/star/form/runtime/XFilterControllerListener.idl @@ -36,32 +36,32 @@ interface XFilterControllerListener : ::com::sun::star::lang::XEventListener /** is fired when a single <em>predicate expression</em> of the filter represented by the filter controller changed. - <p><member>FilterEvent::DisjunctiveTerm</member> is the index of the <em>disjunctive term</em> in which the - expression changed. This usually equals <member>XFilterController::ActiveTerm</member>.</p> + <p>FilterEvent::DisjunctiveTerm is the index of the <em>disjunctive term</em> in which the + expression changed. This usually equals XFilterController::ActiveTerm.</p> - <p><member>FilterEvent::FilterComponent</member> denotes the index of the filter component whose + <p>FilterEvent::FilterComponent denotes the index of the filter component whose <em>predicate expression</em> changed.</p> - <p><member>FilterEvent::PredicateExpression</member> is the new <em>predicate expressions</em>.</p> + <p>FilterEvent::PredicateExpression is the new <em>predicate expressions</em>.</p> */ void predicateExpressionChanged( [in] FilterEvent _Event ); /** is fired when a <em>disjunctive term</em> was removed from the filter of the filter controller. - <p><member>FilterEvent::DisjunctiveTerm</member> is the index of the <em>disjunctive term</em> which was + <p>FilterEvent::DisjunctiveTerm is the index of the <em>disjunctive term</em> which was removed.</p> - <p><member>FilterEvent::FilterComponent</member> and <member>FilterEvent::PredicateExpression</member> are not + <p>FilterEvent::FilterComponent and FilterEvent::PredicateExpression are not used for this event type.</p> */ void disjunctiveTermRemoved( [in] FilterEvent _Event ); /** is fired when a <em>disjunctive term</em> was added to the filter of the filter controller. - <p><member>FilterEvent::DisjunctiveTerm</member> is the index of the <em>disjunctive term</em> which was + <p>FilterEvent::DisjunctiveTerm is the index of the <em>disjunctive term</em> which was added.</p> - <p><member>FilterEvent::FilterComponent</member> and <member>FilterEvent::PredicateExpression</member> are not + <p>FilterEvent::FilterComponent and FilterEvent::PredicateExpression are not used for this event type.</p> */ void disjunctiveTermAdded( [in] FilterEvent _Event ); diff --git a/offapi/com/sun/star/form/runtime/XFormController.idl b/offapi/com/sun/star/form/runtime/XFormController.idl index 413cf01a3971..e0d21c4a73db 100644 --- a/offapi/com/sun/star/form/runtime/XFormController.idl +++ b/offapi/com/sun/star/form/runtime/XFormController.idl @@ -91,7 +91,7 @@ interface XFormControllerContext; (also named <code>FormsCheckRequiredFields</code>) to <FALSE/>.</p> <p>Alternatively, you can prevent the check on a per-control basis, using the - <member>DataAwareControlModel::InputRequired</member> property of a single control model.</p> + DataAwareControlModel::InputRequired property of a single control model.</p> <p>If a control which the controller is responsible for supports the com::sun::star::frame::XDispatchProviderInterception interface, the controller registers a dispatch interceptor. Then, the control can try to delegate part of its diff --git a/offapi/com/sun/star/form/runtime/XFormOperations.idl b/offapi/com/sun/star/form/runtime/XFormOperations.idl index fda9b9e8b5d9..0571c80dc4d4 100644 --- a/offapi/com/sun/star/form/runtime/XFormOperations.idl +++ b/offapi/com/sun/star/form/runtime/XFormOperations.idl @@ -108,7 +108,7 @@ interface XFormOperations : ::com::sun::star::lang::XComponent /** determines whether a feature is currently enabled. <p>Calling this is equivalent to calling getState(), and evaluating the - <member>FeatureState::Enabled</member> member.</p> + FeatureState::Enabled member.</p> @param Feature the feature whose state is to be determined. Must be one of the FormFeature diff --git a/offapi/com/sun/star/frame/Controller.idl b/offapi/com/sun/star/frame/Controller.idl index 308b1da67ec2..901fe8a2e1a0 100644 --- a/offapi/com/sun/star/frame/Controller.idl +++ b/offapi/com/sun/star/frame/Controller.idl @@ -69,7 +69,7 @@ published service Controller <p> Don't mix it with XDispatchProviderInterception which - intercept calls of <member>XDispatch::dispatch()</member>. + intercept calls of XDispatch::dispatch(). </p> */ [optional] interface com::sun::star::ui::XContextMenuInterception; diff --git a/offapi/com/sun/star/frame/DesktopTask.idl b/offapi/com/sun/star/frame/DesktopTask.idl index 693d7694a99f..92a5f124f1b3 100644 --- a/offapi/com/sun/star/frame/DesktopTask.idl +++ b/offapi/com/sun/star/frame/DesktopTask.idl @@ -51,7 +51,7 @@ published service DesktopTask Frame service */ interface com::sun::star::frame::XFramesSupplier; - /** use property <member>Frame::Title</member> instead of that */ + /** use property Frame::Title instead of that */ [readonly, property] string Title; /** - */ diff --git a/offapi/com/sun/star/frame/DispatchDescriptor.idl b/offapi/com/sun/star/frame/DispatchDescriptor.idl index dcc8b936199f..eae1162276d7 100644 --- a/offapi/com/sun/star/frame/DispatchDescriptor.idl +++ b/offapi/com/sun/star/frame/DispatchDescriptor.idl @@ -30,7 +30,7 @@ <p> For a normal dispatch calls all needed parameters are separated. - For optimized remote functionality <member>XDispatch::queryDispatches()</member> + For optimized remote functionality XDispatch::queryDispatches() it's necessary to pack these parameters in a flat structure which can be used in a simple manner. </p> diff --git a/offapi/com/sun/star/frame/DispatchRecorder.idl b/offapi/com/sun/star/frame/DispatchRecorder.idl index 8377682d16c1..7f119a2db857 100644 --- a/offapi/com/sun/star/frame/DispatchRecorder.idl +++ b/offapi/com/sun/star/frame/DispatchRecorder.idl @@ -24,15 +24,15 @@ module com { module sun { module star { module frame { -/** provides functionality to record <member>XDispatch::dispatch()</member> requests +/** provides functionality to record XDispatch::dispatch() requests <p> - It records all necessary parameters of a call <member>XDispatch::dispatch()</member> + It records all necessary parameters of a call XDispatch::dispatch() and generate code which can be executed at later time to run same operations again. Which code will be generated depends from real implementation. So it's possible to generate e.g. Java/Basic or may Perl code. By using of a DispatchRecorderSupplier, which is available on - a property of a <member>Frame::DispatchRecorderSupplier</member>, it's possible to change such code generation + a property of a Frame::DispatchRecorderSupplier, it's possible to change such code generation for further requests or disable it in general by setting this property to <NULL/>. </p> diff --git a/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl b/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl index dd601e9b6ada..7707364615dd 100644 --- a/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl +++ b/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl @@ -27,7 +27,7 @@ /** provides a DispatchRecorder <p> - This supplier regulate macro recording of <member>XDispatch::dispatch()</member> + This supplier regulate macro recording of XDispatch::dispatch() calls. For that it encapsulates a reference to a DispatchRecorder. Such recorder is used internally and can be used externally too. A supplier will be available on a Frame if recording was enabled, diff --git a/offapi/com/sun/star/frame/DispatchStatement.idl b/offapi/com/sun/star/frame/DispatchStatement.idl index 28a33cf4098a..64421ef468e3 100644 --- a/offapi/com/sun/star/frame/DispatchStatement.idl +++ b/offapi/com/sun/star/frame/DispatchStatement.idl @@ -33,7 +33,7 @@ published struct DispatchStatement /** specifies the dispatch command <p> - That means the <var>URL</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request. + That means the <var>URL</var> parameter of a corresponding XDispatchProvider::queryDispatch() request. </p> */ string aCommand; @@ -42,7 +42,7 @@ published struct DispatchStatement /** specifies the frame target <p> - That means the <var>TargetFrameName</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request. + That means the <var>TargetFrameName</var> parameter of a corresponding XDispatchProvider::queryDispatch() request. </p> */ string aTarget; @@ -50,14 +50,14 @@ published struct DispatchStatement /** specifies the dispatch command arguments <p> - That means the <var>Arguments</var> parameter of a corresponding <member>XDispatch::dispatch()</member> request. + That means the <var>Arguments</var> parameter of a corresponding XDispatch::dispatch() request. </p> */ sequence < com::sun::star::beans::PropertyValue > aArgs; /** specifies the optional search flags <p> - That means the <var>SearchFlags</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request. + That means the <var>SearchFlags</var> parameter of a corresponding XDispatchProvider::queryDispatch() request. </p> */ long nFlags; diff --git a/offapi/com/sun/star/frame/FrameControl.idl b/offapi/com/sun/star/frame/FrameControl.idl index e7b4a6154c47..7a85e6d7f9ec 100644 --- a/offapi/com/sun/star/frame/FrameControl.idl +++ b/offapi/com/sun/star/frame/FrameControl.idl @@ -29,7 +29,7 @@ <p> If the control is visible and has a valid (loadable) component URL, - then the <member>FrameControl::Frame</member> property is set. + then the FrameControl::Frame property is set. Normally this control can be used for preview functionality inside any UI. </p> diff --git a/offapi/com/sun/star/frame/FrameSearchFlag.idl b/offapi/com/sun/star/frame/FrameSearchFlag.idl index 5e59170a4557..ad0a5e188210 100644 --- a/offapi/com/sun/star/frame/FrameSearchFlag.idl +++ b/offapi/com/sun/star/frame/FrameSearchFlag.idl @@ -26,9 +26,9 @@ /** these types describe the algorithm to be used to search a frame <p> - Such flags will be used on methods <member>XFrame::findFrame()</member>, - <member>XDispatchProvider::queryDispatch()</member> or - <member>XComponentLoader::loadComponentFromURL()</member> if no special target + Such flags will be used on methods XFrame::findFrame(), + XDispatchProvider::queryDispatch() or + XComponentLoader::loadComponentFromURL() if no special target frame name (e.g. "_blank", "_self") is used. </p> diff --git a/offapi/com/sun/star/frame/Task.idl b/offapi/com/sun/star/frame/Task.idl index f2f57f47e401..db110e922811 100644 --- a/offapi/com/sun/star/frame/Task.idl +++ b/offapi/com/sun/star/frame/Task.idl @@ -29,7 +29,7 @@ <p> Please use the service Frame instead of this deprecated Task. If it's - method <member>XFrame.isTop()</member> returns <TRUE/>, it's the same + method XFrame.isTop() returns <TRUE/>, it's the same as a check for the Task service. </p> diff --git a/offapi/com/sun/star/frame/XComponentLoader.idl b/offapi/com/sun/star/frame/XComponentLoader.idl index 2a42593281e4..a4135087d7a7 100644 --- a/offapi/com/sun/star/frame/XComponentLoader.idl +++ b/offapi/com/sun/star/frame/XComponentLoader.idl @@ -127,9 +127,9 @@ published interface XComponentLoader: com::sun::star::uno::XInterface Should be used for real editable components which doesn't need a model. It is not allowed to dispose it after use directly, because the frame containing the component is its owner. Here the object can be disposed - by disposing the frame, that the <member>XController::getFrame()</member> + by disposing the frame, that the XController::getFrame() method of the controller returns. But for visible components the controller - should be asked for permission by calling <member>XController::suspend()</member> before. + should be asked for permission by calling XController::suspend() before. </li> <li> XModel for full featured components<br/> diff --git a/offapi/com/sun/star/frame/XConfigManager.idl b/offapi/com/sun/star/frame/XConfigManager.idl index 3fc5b74aeeb5..c0e894aaa44e 100644 --- a/offapi/com/sun/star/frame/XConfigManager.idl +++ b/offapi/com/sun/star/frame/XConfigManager.idl @@ -36,7 +36,7 @@ published interface XConfigManager: com::sun::star::uno::XInterface inside the real implementation <p> - Listener can update his text values by calling <member>XConfigManager::substituteVariables()</member> + Listener can update his text values by calling XConfigManager::substituteVariables() again. If <var>KeyName</var> specifies a group of keys, the listener gets one notify for each subkey. </p> diff --git a/offapi/com/sun/star/frame/XController.idl b/offapi/com/sun/star/frame/XController.idl index 591201587355..fb6e01c5b076 100644 --- a/offapi/com/sun/star/frame/XController.idl +++ b/offapi/com/sun/star/frame/XController.idl @@ -72,12 +72,12 @@ published interface XController: com::sun::star::lang::XComponent @returns set of data that can be used to restore the current view status - at later time by using <member>XController::restoreViewData()</member> + at later time by using XController::restoreViewData() */ any getViewData(); /** restores the view status using the data gotten from a previous call to - <member>XController::getViewData()</member>. + XController::getViewData(). @param Data set of data to restore it diff --git a/offapi/com/sun/star/frame/XDesktop.idl b/offapi/com/sun/star/frame/XDesktop.idl index 127747a3f5ee..cbb8cc3adf25 100644 --- a/offapi/com/sun/star/frame/XDesktop.idl +++ b/offapi/com/sun/star/frame/XDesktop.idl @@ -45,12 +45,12 @@ published interface XDesktop: com::sun::star::uno::XInterface /** tries to terminate the desktop. <p> - First, every terminate listener is called by his <member>XTerminateListener::queryTermination()</member> method. + First, every terminate listener is called by his XTerminateListener::queryTermination() method. Throwing of a TerminationVetoException can break the termination process and the listener how has done that will be the new "controller" of the desktop lifetime. He should try to terminate it by himself after his own processes will be finished. If nobody disagree with the termination request, every listener will be called by his - <member>XTerminateListener::notifyTermination()</member> method. + XTerminateListener::notifyTermination() method. </p> @return diff --git a/offapi/com/sun/star/frame/XDesktop2.idl b/offapi/com/sun/star/frame/XDesktop2.idl index 3b80f042a1b2..6fe69c86232f 100644 --- a/offapi/com/sun/star/frame/XDesktop2.idl +++ b/offapi/com/sun/star/frame/XDesktop2.idl @@ -38,11 +38,11 @@ published interface XDesktop2 /** provides access to dispatchers for the frame. <p> - What kind of URLs a frame accepts in the calls to <member>XDispatchProvider::queryDispatch()</member>, + What kind of URLs a frame accepts in the calls to XDispatchProvider::queryDispatch(), and how the returned dispatcher handles dispatches is completely implementation dependent (though of course the restrictions of XDispatchProvider must be met). Frame implementations may (optionally) support special targets in the call to - <member>XDispatchProvider::queryDispatch()</member>. + XDispatchProvider::queryDispatch(). Such special targets are passed as target frame name. They may, in addition, require special frame search flags (see FrameSearchFlag), or, in opposite, limit the set of allowed flags.<br> diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl index e7113086b81a..84a614c7804e 100644 --- a/offapi/com/sun/star/frame/XDispatch.idl +++ b/offapi/com/sun/star/frame/XDispatch.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module frame { <p> Each state change is to be broadcasted to all registered status listeners. The first notification should be performed - synchronously from <member>XDispatch::addStatusListener()</member>; + synchronously from XDispatch::addStatusListener(); if not, controls may flicker. State listener must be aware of this synchronous notification. </p> diff --git a/offapi/com/sun/star/frame/XDispatchProvider.idl b/offapi/com/sun/star/frame/XDispatchProvider.idl index 502549e7d429..5a41437113da 100644 --- a/offapi/com/sun/star/frame/XDispatchProvider.idl +++ b/offapi/com/sun/star/frame/XDispatchProvider.idl @@ -61,7 +61,7 @@ published interface XDispatchProvider: com::sun::star::uno::XInterface [in] string TargetFrameName, [in] long SearchFlags ); - /** actually this method is redundant to <member>XDispatchProvider::queryDispatch()</member> + /** actually this method is redundant to XDispatchProvider::queryDispatch() to avoid multiple remote calls. @param Requests diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl index 33b58e7390b5..6744d2ecbcd6 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl @@ -45,7 +45,7 @@ published interface XDispatchProviderInterceptor: XDispatchProvider XDispatchProvider getSlaveDispatchProvider(); /** sets the slave XDispatchProvider to which calls to - <member>XDispatchProvider::queryDispatch()</member> can be forwarded + XDispatchProvider::queryDispatch() can be forwarded under control of this dispatch provider. @param xNewDispatchProvider @@ -65,7 +65,7 @@ published interface XDispatchProviderInterceptor: XDispatchProvider XDispatchProvider getMasterDispatchProvider(); /** sets the master XDispatchProvider, which may forward - calls to its <member>XDispatchProvider::queryDispatch()</member> + calls to its XDispatchProvider::queryDispatch() to this dispatch provider. @param NewSupplier diff --git a/offapi/com/sun/star/frame/XDispatchRecorder.idl b/offapi/com/sun/star/frame/XDispatchRecorder.idl index ed6328a66a1b..8b0071fef2af 100644 --- a/offapi/com/sun/star/frame/XDispatchRecorder.idl +++ b/offapi/com/sun/star/frame/XDispatchRecorder.idl @@ -57,7 +57,7 @@ published interface XDispatchRecorder: com::sun::star::uno::XInterface /** stops the recording process <p> - Must be called in pairs with <member>XDispatchRecorder::startRecording()</member>. + Must be called in pairs with XDispatchRecorder::startRecording(). </p> @attention The recorder uses this method to control the lifetime of its internal @@ -106,7 +106,7 @@ published interface XDispatchRecorder: com::sun::star::uno::XInterface /** returns the recorded source code <p> - This method must be used before <member>endRecording()</member> is called! + This method must be used before endRecording() is called! Otherwise the macro will be released. </p> diff --git a/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl b/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl index 5fc10ab3b5cd..83f4d37619ec 100644 --- a/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl +++ b/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl @@ -30,7 +30,7 @@ <p> With a XDispatchRecorder it's possible to record calls - of <member>XDispatch::dispatch()</member>. The recorded data (may a script) + of XDispatch::dispatch(). The recorded data (may a script) can be used to automate recorded dispatch and start it at later time again. This supplier provides access to the recorder and supports some functionality to work with the macro recording mechanism in an easy manner. @@ -61,7 +61,7 @@ published interface XDispatchRecorderSupplier: com::sun::star::uno::XInterface <p> Returned recorder can be used to record dispatches manually or to get recorded data for further using e.g. saving. He is internally used too - due to the method <member>XDispatchRecorderSupplier::dispatchAndRecord()</member>. + due to the method XDispatchRecorderSupplier::dispatchAndRecord(). </p> @returns @@ -75,7 +75,7 @@ published interface XDispatchRecorderSupplier: com::sun::star::uno::XInterface <p> Parameter <var>Dispatcher</var> is used internally to make the dispatch. - If recording isn't enabled it will be a normal <member>XDispatch::dispatch()</member> + If recording isn't enabled it will be a normal XDispatch::dispatch() call. Otherwise follow algorithm is used: <ul> <li>If <var>Dispatcher</var> doesn't support the interface diff --git a/offapi/com/sun/star/frame/XDispatchResultListener.idl b/offapi/com/sun/star/frame/XDispatchResultListener.idl index b0952f61e321..07e0bc334a97 100644 --- a/offapi/com/sun/star/frame/XDispatchResultListener.idl +++ b/offapi/com/sun/star/frame/XDispatchResultListener.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module frame { -/** listener for results of <member>XNotifyingDispatch::dispatchWithNotification()</member> +/** listener for results of XNotifyingDispatch::dispatchWithNotification() @see XNotifyingDispatch */ diff --git a/offapi/com/sun/star/frame/XDocumentTemplates.idl b/offapi/com/sun/star/frame/XDocumentTemplates.idl index 3bd75e84fd3f..2d8555239637 100644 --- a/offapi/com/sun/star/frame/XDocumentTemplates.idl +++ b/offapi/com/sun/star/frame/XDocumentTemplates.idl @@ -30,9 +30,9 @@ module com { module sun { module star { module frame { <p> Template information are saved as links to the original content and organized in groups. This data should be persistent and can be - updated by calling special method <member>XDocumentTemplates::update()</member>. + updated by calling special method XDocumentTemplates::update(). A real implementation of this interface can do that on top of - an ucb content provider. Method <member>XDocumentTemplates::getContent()</member> + an ucb content provider. Method XDocumentTemplates::getContent() force that. </p> */ diff --git a/offapi/com/sun/star/frame/XFrame.idl b/offapi/com/sun/star/frame/XFrame.idl index 4bdd0a94816a..b551342a2f19 100644 --- a/offapi/com/sun/star/frame/XFrame.idl +++ b/offapi/com/sun/star/frame/XFrame.idl @@ -83,7 +83,7 @@ published interface XFrame: com::sun::star::lang::XComponent But creator doesn't mean the implementation which creates this instance ... it means the parent frame of the frame hierarchy. Because; normally a frame should be created by using the API - and is necessary for searches inside the tree (e.g. <member>XFrame::findFrame()</member>) + and is necessary for searches inside the tree (e.g. XFrame::findFrame()) </p> @param Creator @@ -118,9 +118,9 @@ published interface XFrame: com::sun::star::lang::XComponent The name of a frame will be used for identifying it if a frame search was started. These searches can be forced by: <ul> - <li><member>XFrame::findFrame()</member> - <li><member>XDispatchProvider::queryDispatch()</member> - <li><member>XComponentLoader::loadComponentFromURL()</member> + <li>XFrame::findFrame() + <li>XDispatchProvider::queryDispatch() + <li>XComponentLoader::loadComponentFromURL() </ul> Note: Special targets like "_blank", "_self" etc. are not allowed. That's why frame names shouldn't start with a sign "_". @@ -202,7 +202,7 @@ published interface XFrame: com::sun::star::lang::XComponent <p> At first the frame sets itself as the active frame of its - creator by calling <member>XFramesSupplier::setActiveFrame()</member>, + creator by calling XFramesSupplier::setActiveFrame(), then it broadcasts an FrameActionEvent with <const>FrameAction::FRAME_ACTIVATED</const>. The component within this frame may listen to this event to grab the focus on activation; @@ -265,7 +265,7 @@ published interface XFrame: com::sun::star::lang::XComponent <TRUE/>if setting of new component or release of an existing one was successfully <br> <FALSE/> otherwise (especially, if an existing controller disagree within his - <member>XController::suspend()</member> call) + XController::suspend() call) @see XFrame::getComponentWindow() @see XFrame::getContainerWindow() @@ -294,9 +294,9 @@ published interface XFrame: com::sun::star::lang::XComponent <p> Note: Don't dispose it - the frame is the owner of it. - Use <member>XController::getFrame()</member> to dispose + Use XController::getFrame() to dispose the frame after you the controller agreed with a - <member>XController::suspend()</member> call. + XController::suspend() call. </p> @returns diff --git a/offapi/com/sun/star/frame/XFrame2.idl b/offapi/com/sun/star/frame/XFrame2.idl index cb57b3ae09a9..9905bafca9f3 100644 --- a/offapi/com/sun/star/frame/XFrame2.idl +++ b/offapi/com/sun/star/frame/XFrame2.idl @@ -42,11 +42,11 @@ published interface XFrame2 /** provides access to dispatchers for the frame. <p> - What kind of URLs a frame accepts in the calls to <member>XDispatchProvider::queryDispatch()</member>, + What kind of URLs a frame accepts in the calls to XDispatchProvider::queryDispatch(), and how the returned dispatcher handles dispatches is completely implementation dependent (though of course the restrictions of XDispatchProvider must be met). Frame implementations may (optionally) support special targets in the call to - <member>XDispatchProvider::queryDispatch()</member>. + XDispatchProvider::queryDispatch(). Such special targets are passed as target frame name. They may, in addition, require special frame search flags (see FrameSearchFlag), or, in opposite, limit the set of allowed flags.<br> @@ -115,9 +115,9 @@ published interface XFrame2 That means: if someone wishes to enable recoding on a frame he must set a supplier with a recorder object inside of it. Every user of dispatches has to check then if such supplier is available at this frame property. - If value of this property is <NULL/> he must call <member>XDispatch::dispatch()</member> + If value of this property is <NULL/> he must call XDispatch::dispatch() on the original dispatch object. If it's a valid value he must use the supplier - by calling his method <member>XDispatchRecorderSupplier::dispatchAndRecord()</member> + by calling his method XDispatchRecorderSupplier::dispatchAndRecord() with the original dispatch object as argument. </p> diff --git a/offapi/com/sun/star/frame/XFrameLoader.idl b/offapi/com/sun/star/frame/XFrameLoader.idl index ff9241aba5c6..2059ea36cefd 100644 --- a/offapi/com/sun/star/frame/XFrameLoader.idl +++ b/offapi/com/sun/star/frame/XFrameLoader.idl @@ -69,7 +69,7 @@ published interface XFrameLoader: com::sun::star::uno::XInterface <p> After returning from this call, neither the frame nor the - load-event-listener specified in <member>XFrameLoader::load()</member> may be called back. + load-event-listener specified in XFrameLoader::load() may be called back. Because only the owner of this process who called load method before can cancel this process. And he doesn't need any notification about that. On the other hand - nobody then this owner himself can be registered as an diff --git a/offapi/com/sun/star/frame/XFramesSupplier.idl b/offapi/com/sun/star/frame/XFramesSupplier.idl index 1a7e8650e2e2..5c07ff8a6e15 100644 --- a/offapi/com/sun/star/frame/XFramesSupplier.idl +++ b/offapi/com/sun/star/frame/XFramesSupplier.idl @@ -62,20 +62,20 @@ published interface XFramesSupplier: XFrame <p> This method is only allowed to be called by a sub-frame according to - <member>XFrame::activate()</member> or <member>XFramesSupplier::setActiveFrame()</member>. - After this call <member>XFramesSupplier::getActiveFrame()</member> will return the + XFrame::activate() or XFramesSupplier::setActiveFrame(). + After this call XFramesSupplier::getActiveFrame() will return the frame specified by <var>Frame</var>. </p> <p> - In general this method first calls the method <member>XFramesSupplier::setActiveFrame()</member> + In general this method first calls the method XFramesSupplier::setActiveFrame() at the creator frame with <var>this</var> as the current argument. Then it broadcasts the FrameActionEvent <const>FrameAction::FRAME_ACTIVATED</const>. </p> <p> Note: Given parameter <var>Frame</var> must already exist inside the container - (e.g., inserted by using <member>XFrames::append()</member>) + (e.g., inserted by using XFrames::append()) </p> @param Frame diff --git a/offapi/com/sun/star/frame/XModel.idl b/offapi/com/sun/star/frame/XModel.idl index 9ade3d541776..a779f74c6739 100644 --- a/offapi/com/sun/star/frame/XModel.idl +++ b/offapi/com/sun/star/frame/XModel.idl @@ -126,8 +126,8 @@ published interface XModel: com::sun::star::lang::XComponent for display updates. <p> - The calls to <member>XModel::lockControllers()</member> and - <member>XModel::unlockControllers()</member> may be + The calls to XModel::lockControllers() and + XModel::unlockControllers() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, some notifications for display updates are not broadcasted. @@ -136,11 +136,11 @@ published interface XModel: com::sun::star::lang::XComponent void lockControllers(); /** resumes the notifications which were suspended by - <member>XModel::lockControllers()</member>. + XModel::lockControllers(). <p> - The calls to <member>XModel::lockControllers()</member> and - <member>XModel::unlockControllers()</member> may be + The calls to XModel::lockControllers() and + XModel::unlockControllers() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, some notifications for display updates are not broadcasted. diff --git a/offapi/com/sun/star/frame/XNotifyingDispatch.idl b/offapi/com/sun/star/frame/XNotifyingDispatch.idl index 326587c1f9fc..4163170220ff 100644 --- a/offapi/com/sun/star/frame/XNotifyingDispatch.idl +++ b/offapi/com/sun/star/frame/XNotifyingDispatch.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module frame { */ published interface XNotifyingDispatch: XDispatch { - /** Do the same like <member>XDispatch::dispatch()</member> but notifies + /** Do the same like XDispatch::dispatch() but notifies listener in every case. Should be used if result must be known. @param URL diff --git a/offapi/com/sun/star/frame/XRecordableDispatch.idl b/offapi/com/sun/star/frame/XRecordableDispatch.idl index 0210b28d82ca..364f5836a954 100644 --- a/offapi/com/sun/star/frame/XRecordableDispatch.idl +++ b/offapi/com/sun/star/frame/XRecordableDispatch.idl @@ -40,7 +40,7 @@ But normally this interface mustn't be used directly. If a dispatch object is well known and recording was enabled on a XDispatchRecorderSupplier it's possible to use method - <member>XDispatchRecorderSupplier::dispatchAndRecord()</member> of it + XDispatchRecorderSupplier::dispatchAndRecord() of it to make dispatch and recording automatically. The interface XRecordableDispatch is used transparently there. </p> @@ -80,7 +80,7 @@ published interface XRecordableDispatch: com::sun::star::uno::XInterface @param Recorder object which can be used to record the request - (available on <member>XDispatchRecorderSupplier::getDispatchRecorder()</member>) + (available on XDispatchRecorderSupplier::getDispatchRecorder()) */ void dispatchAndRecord( [in] com::sun::star::util::URL URL, diff --git a/offapi/com/sun/star/frame/XSessionManagerListener.idl b/offapi/com/sun/star/frame/XSessionManagerListener.idl index c644c9f68df0..9c8db2f5bd20 100644 --- a/offapi/com/sun/star/frame/XSessionManagerListener.idl +++ b/offapi/com/sun/star/frame/XSessionManagerListener.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module frame { <p>When the save request is processed (with or without user interaction) the listener must call - <member>XSessionManagerClient::saveDone()</member> + XSessionManagerClient::saveDone() on the session manager client service object.</p> @param bShutdown @@ -50,7 +50,7 @@ module com { module sun { module star { module frame { <p>the listener may choose to ignore the saveDone() event in case no real shutdown is in progress. He still has to call - <member>XSessionManagerClient::saveDone()</member> + XSessionManagerClient::saveDone() in that case.</p> @see XSessionManagerClient diff --git a/offapi/com/sun/star/frame/XStorable.idl b/offapi/com/sun/star/frame/XStorable.idl index 5a9b3a07adb6..3ce4d27d5a60 100644 --- a/offapi/com/sun/star/frame/XStorable.idl +++ b/offapi/com/sun/star/frame/XStorable.idl @@ -55,7 +55,7 @@ published interface XStorable: com::sun::star::uno::XInterface */ boolean hasLocation(); - /** After <member>XStorable::storeAsURL()</member> it returns the + /** After XStorable::storeAsURL() it returns the URL the object was stored to. @returns @@ -63,7 +63,7 @@ published interface XStorable: com::sun::star::uno::XInterface */ string getLocation(); - /** It is not possible to call <member>XStorable::store()</member> successfully + /** It is not possible to call XStorable::store() successfully when the data store is read-only. @returns @@ -93,9 +93,9 @@ published interface XStorable: com::sun::star::uno::XInterface <p>The change of the location makes it necessary to store the document in a format that the object can load. For this reason the implementation of - <member>XStorable::storeAsURL()</member> will throw an exception if a pure + XStorable::storeAsURL() will throw an exception if a pure export filter is used, it will accept only combined import/export filters. - For such filters the method <member>XStorable::storeToURL()</member> + For such filters the method XStorable::storeToURL() must be used that does not change the location of the object.</p> @param sURL diff --git a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl index d66890ad3787..b58deeb38b42 100644 --- a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl @@ -60,8 +60,8 @@ published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface No notifications (neither to the frame or the caller) must be notified. Because it's a synchronous process this cancel call can be forced by another thread the loader thread only. Method - <member>XSynchronousFrameLoader::load()</member> must return <FALSE/> - then and caller of this method <member>XSynchronousFrameLoader::cancel()</member> + XSynchronousFrameLoader::load() must return <FALSE/> + then and caller of this method XSynchronousFrameLoader::cancel() already knows the state ... </p> */ diff --git a/offapi/com/sun/star/frame/XTasksSupplier.idl b/offapi/com/sun/star/frame/XTasksSupplier.idl index d47acf2537e0..7e4e95a95781 100644 --- a/offapi/com/sun/star/frame/XTasksSupplier.idl +++ b/offapi/com/sun/star/frame/XTasksSupplier.idl @@ -32,12 +32,12 @@ */ published interface XTasksSupplier: com::sun::star::uno::XInterface { - /** use <member>XFramesSupplier::getFrames()</member> instead of this one + /** use XFramesSupplier::getFrames() instead of this one @deprecated */ com::sun::star::container::XEnumerationAccess getTasks(); - /** use <member>XFramesSupplier::getActiveFrame()</member> instead of this one + /** use XFramesSupplier::getActiveFrame() instead of this one @deprecated */ XTask getActiveTask(); diff --git a/offapi/com/sun/star/frame/XTerminateListener.idl b/offapi/com/sun/star/frame/XTerminateListener.idl index cf07630bb481..d9200b856067 100644 --- a/offapi/com/sun/star/frame/XTerminateListener.idl +++ b/offapi/com/sun/star/frame/XTerminateListener.idl @@ -40,7 +40,7 @@ published interface XTerminateListener: com::sun::star::lang::XEventListener <p> Termination can be intercepted by throwing TerminationVetoException. - Interceptor will be the new owner of desktop and should call <member>XDesktop::terminate()</member> + Interceptor will be the new owner of desktop and should call XDesktop::terminate() after finishing his own operations. </p> diff --git a/offapi/com/sun/star/i18n/AmPmValue.idl b/offapi/com/sun/star/i18n/AmPmValue.idl index 10934b15d687..9e0967bb6f14 100644 --- a/offapi/com/sun/star/i18n/AmPmValue.idl +++ b/offapi/com/sun/star/i18n/AmPmValue.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module i18n { -/** Constants for AM/PM used in calls to <member>XCalendar::getDisplayName()</member>. +/** Constants for AM/PM used in calls to XCalendar::getDisplayName(). */ published constants AmPmValue { diff --git a/offapi/com/sun/star/i18n/CTLScriptType.idl b/offapi/com/sun/star/i18n/CTLScriptType.idl index a2e91b2b7f43..dae5956f3850 100644 --- a/offapi/com/sun/star/i18n/CTLScriptType.idl +++ b/offapi/com/sun/star/i18n/CTLScriptType.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** CTL script type constants for layout engine, returned by - <member>XScriptTypeDetector::getCTLScriptType()</member> + XScriptTypeDetector::getCTLScriptType() @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/i18n/Calendar.idl b/offapi/com/sun/star/i18n/Calendar.idl index 496eea036c2c..ea03af8f75c2 100644 --- a/offapi/com/sun/star/i18n/Calendar.idl +++ b/offapi/com/sun/star/i18n/Calendar.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module i18n { /** A calendar as returned in a sequence by - <member>XLocaleData::getAllCalendars()</member>. + XLocaleData::getAllCalendars(). @see XLocaleData for links to DTD of XML locale data files. diff --git a/offapi/com/sun/star/i18n/Calendar2.idl b/offapi/com/sun/star/i18n/Calendar2.idl index ede2089e570c..16f5984a2f2d 100644 --- a/offapi/com/sun/star/i18n/Calendar2.idl +++ b/offapi/com/sun/star/i18n/Calendar2.idl @@ -18,7 +18,7 @@ module com { module sun { module star { module i18n { /** Calendar items as returned in a sequence by - <member>XLocaleData3::getAllCalendars2()</member>. + XLocaleData3::getAllCalendars2(). <p> Similar to ::com::sun::star::i18n::Calendar this provides @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { partitive case month names for locales that use them, for example Slavic locales. If a locale does not provide the possessive form in #GenitiveMonths, the names are identical to the - nominative case nouns in <member>Calendar::Months</member>. If a + nominative case nouns in Calendar::Months. If a locale does not provide the partitive case in #PartitiveMonths, the names are identical to #GenititiveMonths. </p> diff --git a/offapi/com/sun/star/i18n/CalendarDisplayCode.idl b/offapi/com/sun/star/i18n/CalendarDisplayCode.idl index f83057d87e9a..6202b865bef1 100644 --- a/offapi/com/sun/star/i18n/CalendarDisplayCode.idl +++ b/offapi/com/sun/star/i18n/CalendarDisplayCode.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** - Constants to use with <member>XExtendedCalendar::getDisplayString()</member>. + Constants to use with XExtendedCalendar::getDisplayString(). <p> The examples given are for an English Gregorian calendar, note that other calendars or locales may return completely different diff --git a/offapi/com/sun/star/i18n/CalendarDisplayIndex.idl b/offapi/com/sun/star/i18n/CalendarDisplayIndex.idl index f9b1d8668723..4c9b358a5042 100644 --- a/offapi/com/sun/star/i18n/CalendarDisplayIndex.idl +++ b/offapi/com/sun/star/i18n/CalendarDisplayIndex.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** - Values to be passed to <member>XCalendar::getDisplayName()</member>. + Values to be passed to XCalendar::getDisplayName(). */ published constants CalendarDisplayIndex { diff --git a/offapi/com/sun/star/i18n/CalendarItem.idl b/offapi/com/sun/star/i18n/CalendarItem.idl index d6b129477d4c..4f6159012505 100644 --- a/offapi/com/sun/star/i18n/CalendarItem.idl +++ b/offapi/com/sun/star/i18n/CalendarItem.idl @@ -30,8 +30,8 @@ module com { module sun { module star { module i18n { era. <p> A sequence of CalendarItems is contained in - <member>Calendar::Days</member>, <member>Calendar::Months</member>, - <member>Calendar::Eras</member> </p> + Calendar::Days, Calendar::Months, + Calendar::Eras </p> */ published struct CalendarItem diff --git a/offapi/com/sun/star/i18n/CharType.idl b/offapi/com/sun/star/i18n/CharType.idl index 6d12a5eea642..137b29fc4f23 100644 --- a/offapi/com/sun/star/i18n/CharType.idl +++ b/offapi/com/sun/star/i18n/CharType.idl @@ -27,10 +27,10 @@ module com { module sun { module star { module i18n { Constants to specify the character type that starts a character block. Character type is Unicode type defined in UnicodeType - <p> Used with <member>XBreakIterator::beginOfCharBlock()</member>, - <member>XBreakIterator::endOfCharBlock()</member>, - <member>XBreakIterator::nextCharBlock()</member>, - <member>XBreakIterator::previousCharBlock()</member> </p> + <p> Used with XBreakIterator::beginOfCharBlock(), + XBreakIterator::endOfCharBlock(), + XBreakIterator::nextCharBlock(), + XBreakIterator::previousCharBlock() </p> */ published constants CharType { diff --git a/offapi/com/sun/star/i18n/CharacterIteratorMode.idl b/offapi/com/sun/star/i18n/CharacterIteratorMode.idl index 02ba7fca1937..80d72ef73d87 100644 --- a/offapi/com/sun/star/i18n/CharacterIteratorMode.idl +++ b/offapi/com/sun/star/i18n/CharacterIteratorMode.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** Constants to specify the type of character iteration. - <p> Used with <member>XBreakIterator::nextCharacters()</member> and + <p> Used with XBreakIterator::nextCharacters() and <method>XBreakIterator::previousCharacters</method> </p> */ published constants CharacterIteratorMode diff --git a/offapi/com/sun/star/i18n/Currency.idl b/offapi/com/sun/star/i18n/Currency.idl index 4b7e4da32bd9..8425173fd8ab 100644 --- a/offapi/com/sun/star/i18n/Currency.idl +++ b/offapi/com/sun/star/i18n/Currency.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** Symbols, names, and attributes of a specific currency, returned in a - sequence by <member>XLocaleData::getAllCurrencies()</member>. + sequence by XLocaleData::getAllCurrencies(). @see XLocaleData for links to DTD of XML locale data files. diff --git a/offapi/com/sun/star/i18n/Currency2.idl b/offapi/com/sun/star/i18n/Currency2.idl index ba8500a5ced2..68aba05ca6eb 100644 --- a/offapi/com/sun/star/i18n/Currency2.idl +++ b/offapi/com/sun/star/i18n/Currency2.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module i18n { /** Symbols, names, and attributes of a specific currency, returned in a - sequence by <member>XLocaleData2::getAllCurrencies2()</member>. + sequence by XLocaleData2::getAllCurrencies2(). <p> It is derived from ::com::sun::star::i18n::Currency and provides an diff --git a/offapi/com/sun/star/i18n/FormatElement.idl b/offapi/com/sun/star/i18n/FormatElement.idl index bb0decccee13..b3c28b429994 100644 --- a/offapi/com/sun/star/i18n/FormatElement.idl +++ b/offapi/com/sun/star/i18n/FormatElement.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** One number format code and its attributes, returned in a sequence by - <member>XLocaleData::getAllFormats()</member>. + XLocaleData::getAllFormats(). <p> Contains raw data defined in the XML locale data files. </p> diff --git a/offapi/com/sun/star/i18n/Implementation.idl b/offapi/com/sun/star/i18n/Implementation.idl index a358f983b1a8..f5d8e284be06 100644 --- a/offapi/com/sun/star/i18n/Implementation.idl +++ b/offapi/com/sun/star/i18n/Implementation.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** Implementation name details returned in a sequence by - <member>XLocaleData::getCollatorImplementations()</member>. + XLocaleData::getCollatorImplementations(). @see XLocaleData for links to DTD of XML locale data files. diff --git a/offapi/com/sun/star/i18n/InputSequenceCheckMode.idl b/offapi/com/sun/star/i18n/InputSequenceCheckMode.idl index ca66e7b512cc..09a809bf6f32 100644 --- a/offapi/com/sun/star/i18n/InputSequenceCheckMode.idl +++ b/offapi/com/sun/star/i18n/InputSequenceCheckMode.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** Input check mode constants to use with - <member>XInputSequenceChecker::checkInputSequence()</member> + XInputSequenceChecker::checkInputSequence() @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/i18n/KCharacterType.idl b/offapi/com/sun/star/i18n/KCharacterType.idl index 0b7e10f7ae08..8f3df93f0dbf 100644 --- a/offapi/com/sun/star/i18n/KCharacterType.idl +++ b/offapi/com/sun/star/i18n/KCharacterType.idl @@ -27,8 +27,8 @@ module com { module sun { module star { module i18n { Constants to identify the character type. <p> Returned by - <member>XCharacterClassification::getCharacterType()</member> and - <member>XCharacterClassification::getStringType()</member> </p> + XCharacterClassification::getCharacterType() and + XCharacterClassification::getStringType() </p> */ published constants KCharacterType diff --git a/offapi/com/sun/star/i18n/KParseTokens.idl b/offapi/com/sun/star/i18n/KParseTokens.idl index 58ab6c4283ed..e3b0a8a9185f 100644 --- a/offapi/com/sun/star/i18n/KParseTokens.idl +++ b/offapi/com/sun/star/i18n/KParseTokens.idl @@ -28,10 +28,10 @@ module com { module sun { module star { module i18n { be parsed can have. <p> They are passed to - <member>XCharacterClassification::parseAnyToken()</member> and - <member>XCharacterClassification::parsePredefinedToken()</member>. - They are also set in the <member>ParseResult::StartFlags</member> - and <member>ParseResult::ContFlags</member>. </p> + XCharacterClassification::parseAnyToken() and + XCharacterClassification::parsePredefinedToken(). + They are also set in the ParseResult::StartFlags + and ParseResult::ContFlags. </p> */ published constants KParseTokens @@ -65,8 +65,8 @@ published constants KParseTokens ParseResult. */ const long ASC_ANY_BUT_CONTROL = 0x00000400; - /** Additional flag set in <member>ParseResult::StartFlags</member> - or <member>ParseResult::ContFlags</member>. Set if none of the + /** Additional flag set in ParseResult::StartFlags + or ParseResult::ContFlags. Set if none of the above ASC_... (except ASC_ANY_...) single values match an ASCII character parsed. */ const long ASC_OTHER = 0x00000800; @@ -108,8 +108,8 @@ published constants KParseTokens */ const long TWO_DOUBLE_QUOTES_BREAK_STRING = 0x10000000; - /** Additional flag set in <member>ParseResult::StartFlags</member> - or <member>ParseResult::ContFlags</member>. Set if none of the + /** Additional flag set in ParseResult::StartFlags + or ParseResult::ContFlags. Set if none of the above UNI_... single values match a Unicode character parsed. */ const long UNI_OTHER = 0x20000000; diff --git a/offapi/com/sun/star/i18n/KParseType.idl b/offapi/com/sun/star/i18n/KParseType.idl index cf6865c1525c..c679fb593bda 100644 --- a/offapi/com/sun/star/i18n/KParseType.idl +++ b/offapi/com/sun/star/i18n/KParseType.idl @@ -27,9 +27,9 @@ module com { module sun { module star { module i18n { Constants to specify the type of a parsed token. <p> Set by - <member>XCharacterClassification::parseAnyToken()</member> and - <member>XCharacterClassification::parsePredefinedToken()</member> in - <member>ParseResult::TokenType</member>. </p> + XCharacterClassification::parseAnyToken() and + XCharacterClassification::parsePredefinedToken() in + ParseResult::TokenType. </p> */ published constants KParseType @@ -49,20 +49,20 @@ published constants KParseType // quotation marks, they are needed for the unoidl compiler which otherwise // gets confused about the single quotation marks. /** "A single-quoted name matching the conditions passed ( 'na\'me' )." - "Dequoted name in <member>ParseResult::DequotedNameOrString</member> ( na'me )." */ + "Dequoted name in ParseResult::DequotedNameOrString ( na'me )." */ const long SINGLE_QUOTE_NAME = 0x00000008; /** A double-quoted string ( "str\"i""ng" ). Dequoted string in - <member>ParseResult::DequotedNameOrString</member> ( str"i"ng ). */ + ParseResult::DequotedNameOrString ( str"i"ng ). */ const long DOUBLE_QUOTE_STRING = 0x00000010; /** A number where all digits are ASCII characters. - Numerical value in <member>ParseResult::Value</member>. */ + Numerical value in ParseResult::Value. */ const long ASC_NUMBER = 0x00000020; /** A number where at least some digits are Unicode (and maybe ASCII) characters. Numerical value inKParseType - <member>ParseResult::Value</member>. */ + ParseResult::Value. */ const long UNI_NUMBER = 0x00000040; /** Set (ored) if SINGLE_QUOTE_NAME or DOUBLE_QUOTE_STRING has no diff --git a/offapi/com/sun/star/i18n/LanguageCountryInfo.idl b/offapi/com/sun/star/i18n/LanguageCountryInfo.idl index bbca50a156ae..dd803674dfc7 100644 --- a/offapi/com/sun/star/i18n/LanguageCountryInfo.idl +++ b/offapi/com/sun/star/i18n/LanguageCountryInfo.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module i18n { /** The language and country identifiers and descriptive names of the loaded locale data returned by - <member>XLocaleData::getLanguageCountryInfo()</member>. + XLocaleData::getLanguageCountryInfo(). @see XLocaleData for links to DTD of XML locale data files. diff --git a/offapi/com/sun/star/i18n/LineBreakHyphenationOptions.idl b/offapi/com/sun/star/i18n/LineBreakHyphenationOptions.idl index 06936c75b0a4..2f4f832fa966 100644 --- a/offapi/com/sun/star/i18n/LineBreakHyphenationOptions.idl +++ b/offapi/com/sun/star/i18n/LineBreakHyphenationOptions.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { -/** Hyphenation options passed in calls to <member>XBreakIterator::getLineBreak()</member>. +/** Hyphenation options passed in calls to XBreakIterator::getLineBreak(). */ published struct LineBreakHyphenationOptions { diff --git a/offapi/com/sun/star/i18n/LineBreakResults.idl b/offapi/com/sun/star/i18n/LineBreakResults.idl index 33702bf3f2d0..c904efdee149 100644 --- a/offapi/com/sun/star/i18n/LineBreakResults.idl +++ b/offapi/com/sun/star/i18n/LineBreakResults.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { -/** Results of method <member>XBreakIterator::getLineBreak()</member>. +/** Results of method XBreakIterator::getLineBreak(). */ published struct LineBreakResults { diff --git a/offapi/com/sun/star/i18n/LineBreakUserOptions.idl b/offapi/com/sun/star/i18n/LineBreakUserOptions.idl index 43233e38996b..490baec77400 100644 --- a/offapi/com/sun/star/i18n/LineBreakUserOptions.idl +++ b/offapi/com/sun/star/i18n/LineBreakUserOptions.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module i18n { -/** Line break options passed in calls to <member>XBreakIterator::getLineBreak()</member>. +/** Line break options passed in calls to XBreakIterator::getLineBreak(). */ published struct LineBreakUserOptions { diff --git a/offapi/com/sun/star/i18n/Months.idl b/offapi/com/sun/star/i18n/Months.idl index 48ccdefe7dc6..af6a50243fb5 100644 --- a/offapi/com/sun/star/i18n/Months.idl +++ b/offapi/com/sun/star/i18n/Months.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** - Constants for month names used in calls to <member>XCalendar::getDisplayName()</member>. + Constants for month names used in calls to XCalendar::getDisplayName(). */ published constants Months diff --git a/offapi/com/sun/star/i18n/NativeNumberMode.idl b/offapi/com/sun/star/i18n/NativeNumberMode.idl index c8907de14816..219aaa64b397 100644 --- a/offapi/com/sun/star/i18n/NativeNumberMode.idl +++ b/offapi/com/sun/star/i18n/NativeNumberMode.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** Constants to use with - <member>XExtendedCalendar::getDisplayString()</member> and the + XExtendedCalendar::getDisplayString() and the XNativeNumberSupplier methods. <p> The constants have different meanings if used with different diff --git a/offapi/com/sun/star/i18n/NativeNumberXmlAttributes.idl b/offapi/com/sun/star/i18n/NativeNumberXmlAttributes.idl index e8db851abdb0..9dc28e0ed6aa 100644 --- a/offapi/com/sun/star/i18n/NativeNumberXmlAttributes.idl +++ b/offapi/com/sun/star/i18n/NativeNumberXmlAttributes.idl @@ -31,8 +31,8 @@ module com { module sun { module star { module i18n { stored in XML file format. <p> Used with - <member>XNativeNumberSupplier::convertToXmlAttributes()</member> and - <member>XNativeNumberSupplier::convertFromXmlAttributes()</member> + XNativeNumberSupplier::convertToXmlAttributes() and + XNativeNumberSupplier::convertFromXmlAttributes() </p> @since OOo 1.1.2 diff --git a/offapi/com/sun/star/i18n/NumberFormatIndex.idl b/offapi/com/sun/star/i18n/NumberFormatIndex.idl index a7ec730c691f..22049ed48385 100644 --- a/offapi/com/sun/star/i18n/NumberFormatIndex.idl +++ b/offapi/com/sun/star/i18n/NumberFormatIndex.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module i18n { /** Number format indices to be passed as the index argument to - <member>XNumberFormatCode::getFormatCode()</member> + XNumberFormatCode::getFormatCode() or <member scope="::com::sun::star::util">XNumberFormatTypes::getFormatIndex()</member>. @@ -247,7 +247,7 @@ published constants NumberFormatIndex <b>Not</b> defined in locale data, but generated by the number formatter. If you want to access this format you <b>MUST</b> do it via <member scope="com::sun::star::util">XNumberFormatTypes::getFormatIndex()</member> - instead of <member>XNumberFormatCode::getFormatCode()</member>. + instead of XNumberFormatCode::getFormatCode(). <br/> reserved formatindex="48" */ const short BOOLEAN = DATETIME_END+1; @@ -259,7 +259,7 @@ published constants NumberFormatIndex <b>Not</b> defined in locale data, but generated by the number formatter. If you want to access this format you <b>MUST</b> do it via <member scope="com::sun::star::util">XNumberFormatTypes::getFormatIndex()</member> - instead of <member>XNumberFormatCode::getFormatCode()</member> + instead of XNumberFormatCode::getFormatCode() <br/> reserved formatindex="49" */ const short TEXT = BOOLEAN+1; diff --git a/offapi/com/sun/star/i18n/ParseResult.idl b/offapi/com/sun/star/i18n/ParseResult.idl index c94867ba10e1..c58c7e43c502 100644 --- a/offapi/com/sun/star/i18n/ParseResult.idl +++ b/offapi/com/sun/star/i18n/ParseResult.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module i18n { /** Parser results returned by - <member>XCharacterClassification::parseAnyToken()</member> and - <member>XCharacterClassification::parsePredefinedToken()</member>. + XCharacterClassification::parseAnyToken() and + XCharacterClassification::parsePredefinedToken(). */ published struct ParseResult diff --git a/offapi/com/sun/star/i18n/ScriptType.idl b/offapi/com/sun/star/i18n/ScriptType.idl index caa964527650..6b9bba1d66cd 100644 --- a/offapi/com/sun/star/i18n/ScriptType.idl +++ b/offapi/com/sun/star/i18n/ScriptType.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module i18n { /** Constants to specify the script type. - <p> Used with <member>XBreakIterator::beginOfScript()</member>, - <member>XBreakIterator::endOfScript()</member>, - <member>XBreakIterator::nextScript()</member>, - <member>XBreakIterator::previousScript()</member> </p> + <p> Used with XBreakIterator::beginOfScript(), + XBreakIterator::endOfScript(), + XBreakIterator::nextScript(), + XBreakIterator::previousScript() </p> */ published constants ScriptType { diff --git a/offapi/com/sun/star/i18n/TransliterationModules.idl b/offapi/com/sun/star/i18n/TransliterationModules.idl index 2db2192c5c10..a1535724b4ac 100644 --- a/offapi/com/sun/star/i18n/TransliterationModules.idl +++ b/offapi/com/sun/star/i18n/TransliterationModules.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** Old transliteration module enumeration. - <p> Use with <member>XTransliteration::loadModule()</member> and + <p> Use with XTransliteration::loadModule() and com::sun::star::util::SearchOptions::transliterateFlags() </p> <p> Note that values >=0x100 are logically or'ed with other values! </p> diff --git a/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl b/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl index 7859c2b9cb12..f1e33634267d 100644 --- a/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl +++ b/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module i18n { /** Extra transliteration module enumeration to use with - <member>XTransliteration::loadModule()</member> + XTransliteration::loadModule() The values used in this group need to be different from the ones in TransliterationModules and TransliterationModulesNew! diff --git a/offapi/com/sun/star/i18n/TransliterationModulesNew.idl b/offapi/com/sun/star/i18n/TransliterationModulesNew.idl index e15e762803c9..970eae54b998 100644 --- a/offapi/com/sun/star/i18n/TransliterationModulesNew.idl +++ b/offapi/com/sun/star/i18n/TransliterationModulesNew.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module i18n { /** New transliteration module enumeration to use with - <member>XTransliteration::loadModuleNew()</member> + XTransliteration::loadModuleNew() */ published enum TransliterationModulesNew diff --git a/offapi/com/sun/star/i18n/TransliterationType.idl b/offapi/com/sun/star/i18n/TransliterationType.idl index 6e5e75bdecf9..a6bc47c2e677 100644 --- a/offapi/com/sun/star/i18n/TransliterationType.idl +++ b/offapi/com/sun/star/i18n/TransliterationType.idl @@ -25,14 +25,14 @@ module com { module sun { module star { module i18n { /** Bitmask transliteration types used with - <member>XTransliteration::getType()</member> and - <member>XTransliteration::getAvailableModules()</member> methods. + XTransliteration::getType() and + XTransliteration::getAvailableModules() methods. <p> Non-IGNORE type modules provide - <member>XTransliteration::transliterate()</member>. <br/> + XTransliteration::transliterate(). <br/> IGNORE type modules provide - <member>XTransliteration::equals()</member> and - <member>XTransliteration::transliterateRange()</member>. </p> + XTransliteration::equals() and + XTransliteration::transliterateRange(). </p> */ published constants TransliterationType diff --git a/offapi/com/sun/star/i18n/UnicodeScript.idl b/offapi/com/sun/star/i18n/UnicodeScript.idl index 6969c08b2a5d..af7045c882a3 100644 --- a/offapi/com/sun/star/i18n/UnicodeScript.idl +++ b/offapi/com/sun/star/i18n/UnicodeScript.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** Unicode script types, returned by - <member>XCharacterClassification::getScript()</member> + XCharacterClassification::getScript() */ published enum UnicodeScript diff --git a/offapi/com/sun/star/i18n/UnicodeType.idl b/offapi/com/sun/star/i18n/UnicodeType.idl index b11dd5c38841..7d5d08de22a6 100644 --- a/offapi/com/sun/star/i18n/UnicodeType.idl +++ b/offapi/com/sun/star/i18n/UnicodeType.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** Constants to classify Unicode characters, returned by - <member>XCharacterClassification::getType()</member> + XCharacterClassification::getType() */ published constants UnicodeType diff --git a/offapi/com/sun/star/i18n/Weekdays.idl b/offapi/com/sun/star/i18n/Weekdays.idl index b9802592acbd..3599b71c70de 100644 --- a/offapi/com/sun/star/i18n/Weekdays.idl +++ b/offapi/com/sun/star/i18n/Weekdays.idl @@ -27,9 +27,9 @@ module com { module sun { module star { module i18n { /** Constants for days of a week. - <p> used with <member>XCalendar::getFirstDayOfWeek()</member>, - <member>XCalendar::setFirstDayOfWeek()</member> and - <member>XCalendar::getDisplayName()</member> </p> + <p> used with XCalendar::getFirstDayOfWeek(), + XCalendar::setFirstDayOfWeek() and + XCalendar::getDisplayName() </p> */ published constants Weekdays { diff --git a/offapi/com/sun/star/i18n/WordType.idl b/offapi/com/sun/star/i18n/WordType.idl index 540fd1b9856e..5bba2312d493 100644 --- a/offapi/com/sun/star/i18n/WordType.idl +++ b/offapi/com/sun/star/i18n/WordType.idl @@ -25,12 +25,12 @@ module com { module sun { module star { module i18n { /** Constants to specify the type of words. - <p> Used with <member>XBreakIterator::nextWord()</member>, - <member>XBreakIterator::previousWord()</member>, - <member>XBreakIterator::getWordBoundary()</member>, - <member>XBreakIterator::getWordType()</member>, - <member>XBreakIterator::isBeginWord()</member>, - <member>XBreakIterator::isEndWord()</member> </p> + <p> Used with XBreakIterator::nextWord(), + XBreakIterator::previousWord(), + XBreakIterator::getWordBoundary(), + XBreakIterator::getWordType(), + XBreakIterator::isBeginWord(), + XBreakIterator::isEndWord() </p> */ published constants WordType { diff --git a/offapi/com/sun/star/i18n/XBreakIterator.idl b/offapi/com/sun/star/i18n/XBreakIterator.idl index c46f2aef93a0..37930fcee43a 100644 --- a/offapi/com/sun/star/i18n/XBreakIterator.idl +++ b/offapi/com/sun/star/i18n/XBreakIterator.idl @@ -46,7 +46,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface @param nCount Number of characters to traverse, it should not be less than 0. If you want to traverse in the opposite direction use - <member>XBreakIterator::previousCharacters()</member> instead. + XBreakIterator::previousCharacters() instead. */ long nextCharacters( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, @@ -61,7 +61,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface @param nCount Number of characters to traverse, it should not be less than 0. If you want to traverse in the opposite direction use - <member>XBreakIterator::nextCharacters()</member> instead. + XBreakIterator::nextCharacters() instead. */ long previousCharacters( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, diff --git a/offapi/com/sun/star/i18n/XCalendar.idl b/offapi/com/sun/star/i18n/XCalendar.idl index 584ad96f43f6..2313a396b8ad 100644 --- a/offapi/com/sun/star/i18n/XCalendar.idl +++ b/offapi/com/sun/star/i18n/XCalendar.idl @@ -89,7 +89,7 @@ published interface XCalendar : com::sun::star::uno::XInterface /** Verify if the date fields set by a combination of - <member>XCalendar::setValue()</member> calls is valid. It has a + XCalendar::setValue() calls is valid. It has a side-effect because it will internally calculate the final value for the date fields */ @@ -156,25 +156,25 @@ published interface XCalendar : com::sun::star::uno::XInterface <dt><const>CalendarDisplayIndex::DAY</const></dt> <dd>one of Weekdays or a number used as an offset into the corresponding - <member>Calendar::Days</member> sequence</dd> + Calendar::Days sequence</dd> <dt><const>CalendarDisplayIndex::MONTH</const></dt> <dd>one of Months or a number used as an offset into the corresponding - <member>Calendar::Months</member> sequence</dd> + Calendar::Months sequence</dd> <dt><const>CalendarDisplayIndex::YEAR</const></dt> <dd>not used, empty string returned</dd> <dt><const>CalendarDisplayIndex::ERA</const></dt> <dd>a number used as an offset into the - corresponding <member>Calendar:Eras</member> + corresponding Calendar:Eras sequence</dd> <dt><const>CalendarDisplayIndex::GENITIVE_MONTH</const></dt> <dd>a number used as an offset into the - corresponding <member>Calendar2:GenitiveMonth</member> + corresponding Calendar2:GenitiveMonth sequence</dd> </dl> <p> The value should be obtained by a previous call to - <member>XCalendar::getValue()</member> with an appropriate + XCalendar::getValue() with an appropriate CalendarFieldIndex argument. </p> @param nNameType diff --git a/offapi/com/sun/star/i18n/XCharacterClassification.idl b/offapi/com/sun/star/i18n/XCharacterClassification.idl index 767e55155799..9d3207084bd8 100644 --- a/offapi/com/sun/star/i18n/XCharacterClassification.idl +++ b/offapi/com/sun/star/i18n/XCharacterClassification.idl @@ -132,7 +132,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface @returns A filled ParseResult structure. If no unambiguous token could be parsed, - <member>ParseResult::TokenType</member> will be set to + ParseResult::TokenType will be set to <b>0</b> (zero), other fields will contain the values parsed so far. @@ -141,7 +141,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface <const>KParseType::ASC_NUM</const> (or <const>KParseType::UNI_NUM</const>) and <const>KParseType::IDENTNAME</const> are set in - <member>ParseResult::TokenType</member>. + ParseResult::TokenType. @param aText Text to be parsed. @@ -214,7 +214,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface <p> Other parameters are the same as in parseAnyToken(). If the actual token does not match the passed <em>nTokenType</em> a - <member>ParseResult::TokenType</member> set to <b>0</b> (zero) + ParseResult::TokenType set to <b>0</b> (zero) is returned. </p> @param nTokenType diff --git a/offapi/com/sun/star/i18n/XCollator.idl b/offapi/com/sun/star/i18n/XCollator.idl index 6e9cd30eb315..aa666b3502a3 100644 --- a/offapi/com/sun/star/i18n/XCollator.idl +++ b/offapi/com/sun/star/i18n/XCollator.idl @@ -130,7 +130,7 @@ published interface XCollator: com::sun::star::uno::XInterface @param aCollatorOptions A sequence of end user collator options like those returned - by <member>XCollator::listCollatorOptions()</member>. + by XCollator::listCollatorOptions(). */ void loadCollatorAlgorithmWithEndUserOption( [in] string aAlgorithmName, diff --git a/offapi/com/sun/star/i18n/XTransliteration.idl b/offapi/com/sun/star/i18n/XTransliteration.idl index 12246b8fbba2..0d1824e4d55e 100644 --- a/offapi/com/sun/star/i18n/XTransliteration.idl +++ b/offapi/com/sun/star/i18n/XTransliteration.idl @@ -114,7 +114,7 @@ published interface XTransliteration: com::sun::star::uno::XInterface [in] ::com::sun::star::lang::Locale aLocale ); /** Load a sequence of instances of predefined modules - supersedes - method <member>XTransliteration::loadModule()</member>. + method XTransliteration::loadModule(). */ void loadModuleNew( [in] sequence <TransliterationModulesNew> aModType, [in] ::com::sun::star::lang::Locale aLocale ); diff --git a/offapi/com/sun/star/i18n/reservedWords.idl b/offapi/com/sun/star/i18n/reservedWords.idl index b57cc240ffba..de4f2a3cbfb8 100644 --- a/offapi/com/sun/star/i18n/reservedWords.idl +++ b/offapi/com/sun/star/i18n/reservedWords.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** Offsets into the sequence of strings returned by - <member>XLocaleData::getReservedWord()</member>. + XLocaleData::getReservedWord(). @see XLocaleData for links to DTD of XML locale data files. diff --git a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl index 3737e154855e..e939df39d5df 100644 --- a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl +++ b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl @@ -33,7 +33,7 @@ struct PropertyCategoryDescriptor /** contains the programmatic name of the category. <p>This programmatic name is used internally: XPropertyHandler::describePropertyLine() - sets a programmatic category name at <member>LineDescriptor::Category</member>, + sets a programmatic category name at LineDescriptor::Category, and an object inspector uses this to find the proper PropertyCategoryDescriptor.</p> */ string ProgrammaticName; diff --git a/offapi/com/sun/star/inspection/PropertyControlType.idl b/offapi/com/sun/star/inspection/PropertyControlType.idl index 54c72b2136c9..526b2314829b 100644 --- a/offapi/com/sun/star/inspection/PropertyControlType.idl +++ b/offapi/com/sun/star/inspection/PropertyControlType.idl @@ -89,9 +89,9 @@ constants PropertyControlType <p>Additionally, those controls support the XStringListControl interface. If you use this interface to add additional entries to the list box, which have no color associated with it, then you can also exchange values as <code>string</code>. That is, if you write a string into - <member>XPropertyControl::Value</member>, and if this string has previously been added to the list + XPropertyControl::Value, and if this string has previously been added to the list using the XStringListControl interface, this string is selected. Vice versa, if the user - selects one of those non-color strings in the list, then reading <member>XPropertyControl::Value</member> + selects one of those non-color strings in the list, then reading XPropertyControl::Value will retrieve you this string.</p> */ const short ColorListBox = 7; diff --git a/offapi/com/sun/star/inspection/XHyperlinkControl.idl b/offapi/com/sun/star/inspection/XHyperlinkControl.idl index 4a50adf6a384..05e9c96878de 100644 --- a/offapi/com/sun/star/inspection/XHyperlinkControl.idl +++ b/offapi/com/sun/star/inspection/XHyperlinkControl.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module inspection { /** defines the interface for an XPropertyControl which displays its value in a hyperlink-like way - <p>Hyperlink controls exchange their value (<member>XPropertyControl::Value</member>) as strings.</p> + <p>Hyperlink controls exchange their value (XPropertyControl::Value) as strings.</p> @since OOo 2.0.3 */ diff --git a/offapi/com/sun/star/inspection/XObjectInspector.idl b/offapi/com/sun/star/inspection/XObjectInspector.idl index f776e91dc6c4..bea67d040923 100644 --- a/offapi/com/sun/star/inspection/XObjectInspector.idl +++ b/offapi/com/sun/star/inspection/XObjectInspector.idl @@ -92,7 +92,7 @@ interface XObjectInspector <p>If the sequence contains more than one object, the XObjectInspector will create a complete set of property handlers (as indicated by - <member>XObjectInspectorModel::HandlerFactories</member>) for <em>every</em> of + XObjectInspectorModel::HandlerFactories) for <em>every</em> of the objects, and compose their output.</p> @throws com::sun::star::util::VetoException diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl index 5948773573bb..095bd841cbc1 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl @@ -65,7 +65,7 @@ interface XObjectInspectorModel /** describes the property categories used by the property handlers. - <p>Properties can be sorted into different categories, described by the <member>LineDescriptor::Category</member> + <p>Properties can be sorted into different categories, described by the LineDescriptor::Category attribute, which is filled in XPropertyHandler::describePropertyLine() method of your property handler.<br/> Those names provided by the handlers are programmatic names. All other information diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl index 070d8b80edab..19946c5242bd 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl @@ -67,7 +67,7 @@ interface XObjectInspectorUI @param Elements a combination of PropertyLineElement flags specifying which elements are to be enabled or disabled.<br/> - Note that if you don't set a particular bit here (say, <member>PropertyLineElement::PrimaryButton</member>), + Note that if you don't set a particular bit here (say, PropertyLineElement::PrimaryButton), this does mean that this element's state is not affected by the call - it does <em>not</em> mean that it is disabled. @param Enable @@ -152,7 +152,7 @@ interface XObjectInspectorUI one. @throws NoSupportException - if the <member>XObjectInspectorModel::HasHelpSection</member> property + if the XObjectInspectorModel::HasHelpSection property requires the help section to be unavailable. @since OOo 2.2 diff --git a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl index 955dc6a42748..abb78655744d 100644 --- a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl +++ b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl @@ -46,9 +46,9 @@ interface XPropertyControlFactory <p>If this argument is <TRUE/>, this does not necessarily mean that the property cannot be changed at all in the ObjectInspector. Instead, an XPropertyHandler can still decide that there is a dedicated UI for entering the property value, - which is usually triggered by a <member>LineDescriptor::PrimaryButton</member>.</p> + which is usually triggered by a LineDescriptor::PrimaryButton.</p> - <p>Note that this parameter might be ignored if the <member>XObjectInspectorModel::IsReadOnly</member> + <p>Note that this parameter might be ignored if the XObjectInspectorModel::IsReadOnly attribute is <TRUE/>, in which case all created property controls must be readonly.</p> @returns diff --git a/offapi/com/sun/star/inspection/XPropertyHandler.idl b/offapi/com/sun/star/inspection/XPropertyHandler.idl index 1d516049d1f4..39d295f118a9 100644 --- a/offapi/com/sun/star/inspection/XPropertyHandler.idl +++ b/offapi/com/sun/star/inspection/XPropertyHandler.idl @@ -163,14 +163,14 @@ interface XPropertyHandler <p>This method converts a property value, which has previously been obtained using getPropertyValue(), into a control-compatible value, which can be used - with XPropertyControl's <member>XPropertyControl::Value</member> attribute.</p> + with XPropertyControl's XPropertyControl::Value attribute.</p> <p>A usual application of this method are list boxes: There is a generic list box implementation, which is able to display a simple list of strings. Usually, every string represents one possible property value. To translate between those property values and the displayed strings, convertToControlValue() and convertToPropertyValue() are used.</p> - <p>The method is not invoked if the control's value type (<member>XPropertyControl::ValueType</member> + <p>The method is not invoked if the control's value type (XPropertyControl::ValueType equals the property's value type.</p> @param PropertyName @@ -256,7 +256,7 @@ interface XPropertyHandler <p>There is a precedence in the property handlers used by an ObjectInspector, which also is important for the superseded properties. This precedence is implied by the precedence of factories to create the property handlers, as denoted in the - <member>XObjectInspectorModel::HandlerFactories</member> attribute.</p> + XObjectInspectorModel::HandlerFactories attribute.</p> <p>With this in mind, property handlers can only supersede properties which are supported by a handler preceding them, but not properties of handlers succeeding them.</p> @@ -315,8 +315,8 @@ interface XPropertyHandler <p>Property handlers can raise a dedicated UI for entering or somehow changing a property value. Usually, this will be a modal dialog, but it can also be a non-modal user interface component.</p> - <p>Availability of this feature is indicated by the <member>LineDescriptor::HasPrimaryButton</member> - and <member>LineDescriptor::HasSecondaryButton</member> members of a LineDescriptor, + <p>Availability of this feature is indicated by the LineDescriptor::HasPrimaryButton + and LineDescriptor::HasSecondaryButton members of a LineDescriptor, which the XPropertyHandler fills in its describePropertyLine() method.</p> <p>When this method is called, the property handler should raise the UI needed to enter the @@ -324,10 +324,10 @@ interface XPropertyHandler <p>It is recommended that property handlers do not directly set the property value which has been obtained from the user, but store it in the output-parameter Data, and return - <member>InteractiveSelectionResult::ObtainedValue</member>.</p> + InteractiveSelectionResult::ObtainedValue.</p> <p>If a handler sets the new property value directly, and returns - <member>InteractiveSelectionResult::ObtainedValue</member>, this implies that the property + InteractiveSelectionResult::ObtainedValue, this implies that the property cannot properly be handled in case the object inspector is inspecting an intersection of multiple components, since in this case onInteractivePropertySelection() will be called at one handler only, however the new property would have to be forwarded to @@ -343,14 +343,14 @@ interface XPropertyHandler <TRUE/> if and only if the primary button has been clicked, <FALSE/> otherwise @param out_Data - If the method returns <member>InteractiveSelectionResult::ObtainedValue</member>, + If the method returns InteractiveSelectionResult::ObtainedValue, then <arg>out_Data</arg> contains the value which has been interactively obtained from the user, and which still needs to be set at the inspected component. @param InspectorUI provides access to the object inspector UI. Implementations should use this if the property selection requires non-modal user input. In those cases, - onInteractivePropertySelection() should return <member>InteractiveSelectionResult::Pending</member>, + onInteractivePropertySelection() should return InteractiveSelectionResult::Pending, and the UI for (at least) the property whose input is still pending should be disabled. @return diff --git a/offapi/com/sun/star/logging/ConsoleHandler.idl b/offapi/com/sun/star/logging/ConsoleHandler.idl index 0cb343037373..d811809bc33b 100644 --- a/offapi/com/sun/star/logging/ConsoleHandler.idl +++ b/offapi/com/sun/star/logging/ConsoleHandler.idl @@ -45,10 +45,10 @@ service ConsoleHandler : XConsoleHandler contains the initial settings for the log handler <p>The following settings are recognized and supported: - <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li> - <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li> - <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li> - <li><code>Threshold</code> - denotes the initial value of the <member>XConsoleHandler::Threshold</member></li> + <ul><li><code>Encoding</code> - denotes the initial value of the XLogHandler::Encoding</li> + <li><code>Formatter</code> - denotes the initial value of the XLogHandler::Formatter</li> + <li><code>Level</code> - denotes the initial value of the XLogHandler::Level</li> + <li><code>Threshold</code> - denotes the initial value of the XConsoleHandler::Threshold</li> </ul></p> @throws ::com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/logging/FileHandler.idl b/offapi/com/sun/star/logging/FileHandler.idl index d438cb1cadd1..611a7d0e883a 100644 --- a/offapi/com/sun/star/logging/FileHandler.idl +++ b/offapi/com/sun/star/logging/FileHandler.idl @@ -57,9 +57,9 @@ service FileHandler : XLogHandler contains the initial settings for the log handler <p>The following settings are recognized and supported: - <ul><li><code>Encoding</code> - denotes the initial value of the <member>XLogHandler::Encoding</member></li> - <li><code>Formatter</code> - denotes the initial value of the <member>XLogHandler::Formatter</member></li> - <li><code>Level</code> - denotes the initial value of the <member>XLogHandler::Level</member></li> + <ul><li><code>Encoding</code> - denotes the initial value of the XLogHandler::Encoding</li> + <li><code>Formatter</code> - denotes the initial value of the XLogHandler::Formatter</li> + <li><code>Level</code> - denotes the initial value of the XLogHandler::Level</li> </ul></p> <p>Additionally, a setting name <code>FileURL</code> is recognized. It must be of type diff --git a/offapi/com/sun/star/logging/XConsoleHandler.idl b/offapi/com/sun/star/logging/XConsoleHandler.idl index 39863e202244..5d6ff6cba9db 100644 --- a/offapi/com/sun/star/logging/XConsoleHandler.idl +++ b/offapi/com/sun/star/logging/XConsoleHandler.idl @@ -41,7 +41,7 @@ interface XConsoleHandler : XLogHandler <p>Events with a level greater or equal to <code>Threshold</code> will be logged to <code>stderr</code>, all others to <code>stdout</code>.</p> - <p>The default value for this attribute is <member>LogLevel::SEVERE</member>.</p> + <p>The default value for this attribute is LogLevel::SEVERE.</p> */ [attribute] long Threshold; }; diff --git a/offapi/com/sun/star/logging/XLogger.idl b/offapi/com/sun/star/logging/XLogger.idl index 3762bea08912..fd35b0adea77 100644 --- a/offapi/com/sun/star/logging/XLogger.idl +++ b/offapi/com/sun/star/logging/XLogger.idl @@ -60,7 +60,7 @@ interface XLogger might or might not log those records at their own discretion, and depending on additional restrictions such as filters specified at handler level.</p> - <p>Note: The log level of the given handler (<member>XLogHandler::Level</member>) will + <p>Note: The log level of the given handler (XLogHandler::Level) will not be touched. In particular, it will not be set to the logger's log level. It's the responsibility of the component which knits a logger with one or more log handlers to ensure that all loggers have appropriate levels set.</p> diff --git a/offapi/com/sun/star/mozilla/XMenuProxy.idl b/offapi/com/sun/star/mozilla/XMenuProxy.idl index 999e01084dc5..1219b78e63a3 100644 --- a/offapi/com/sun/star/mozilla/XMenuProxy.idl +++ b/offapi/com/sun/star/mozilla/XMenuProxy.idl @@ -49,7 +49,7 @@ published interface XMenuProxy: com::sun::star::lang::XComponent void addMenuProxyListener([in] XMenuProxyListener xListener ); /** Unregisters an event listener which was registered with - <member>XMenuProxy::addMenuProxyListener()</member>. + XMenuProxy::addMenuProxyListener(). @param xListener [in]: the listener to be removed diff --git a/offapi/com/sun/star/presentation/EffectNodeType.idl b/offapi/com/sun/star/presentation/EffectNodeType.idl index 13e876db6717..e3611ed26724 100644 --- a/offapi/com/sun/star/presentation/EffectNodeType.idl +++ b/offapi/com/sun/star/presentation/EffectNodeType.idl @@ -26,7 +26,7 @@ /** This constants defines a type for an animation effect node. <br> This is stored with the name <i>node-type</i> inside the - <member>::com::sun::star::animations::XAnimationNode::UserData</member> sequence. + ::com::sun::star::animations::XAnimationNode::UserData sequence. <br> This does not manipulate the timing or synchronization. It can be used to quickly identify semantic blocks inside an animation hierarchy. diff --git a/offapi/com/sun/star/presentation/EffectPresetClass.idl b/offapi/com/sun/star/presentation/EffectPresetClass.idl index 3694bed035a7..ebf290fc9f40 100644 --- a/offapi/com/sun/star/presentation/EffectPresetClass.idl +++ b/offapi/com/sun/star/presentation/EffectPresetClass.idl @@ -26,7 +26,7 @@ /** This constants defines a the class for a preset animation effect. <br> This is stored with the name <i>preset-class</i> inside the - <member>::com::sun::star::animations::XAnimationNode::UserData</member> sequence. + ::com::sun::star::animations::XAnimationNode::UserData sequence. <br> This does not manipulate the timing or synchronization. It can be used to quickly identify preset animations inside an animation hierarchy. diff --git a/offapi/com/sun/star/presentation/XSlideShowController.idl b/offapi/com/sun/star/presentation/XSlideShowController.idl index ec99071a0125..d0251c805143 100644 --- a/offapi/com/sun/star/presentation/XSlideShowController.idl +++ b/offapi/com/sun/star/presentation/XSlideShowController.idl @@ -170,16 +170,16 @@ interface XSlideShowController /** activates the user interface of this slide show. - @see <member>deactivate()</member> - @see <member>isActive()</member> + @see deactivate() + @see isActive() */ void activate(); /** can be called to deactivate the user interface of this slide show. <p>A deactivated - @see <member>activate()</member> - @see <member>isActive()</member> + @see activate() + @see isActive() */ void deactivate(); diff --git a/offapi/com/sun/star/rendering/FontRequest.idl b/offapi/com/sun/star/rendering/FontRequest.idl index 689f1efb5a83..360607b0319b 100644 --- a/offapi/com/sun/star/rendering/FontRequest.idl +++ b/offapi/com/sun/star/rendering/FontRequest.idl @@ -28,11 +28,11 @@ module com { module sun { module star { module rendering { font to be queried from XCanvas.<p> Note: Outline fonts are to be requested as a special family, set - <member>FontInfo::FamilyName</member> appropriately. Emboss/relief + FontInfo::FamilyName appropriately. Emboss/relief must be emulated by upper layers.<p> - Leave the <member>FontInfo::FamilyName</member> and - <member>FontInfo::StyleName</member> empty, if font selection + Leave the FontInfo::FamilyName and + FontInfo::StyleName empty, if font selection should only happen via the PANOSE description. @since OOo 2.0 @@ -51,7 +51,7 @@ struct FontRequest This value corresponds to the font height in Western scripts, but is independent of the writing direction (see - <member>FontRequest::IsVertical</member> below). That + FontRequest::IsVertical below). That means, the value specified here is always measured orthogonal to the text advancement (height for horizontal writing, and width for vertical writing).<p> @@ -91,7 +91,7 @@ struct FontRequest /** The locale this font should be able to render.<p> This member supplements the - <member>FontInfo::UnicodeRange0</member> entry with a specific + FontInfo::UnicodeRange0 entry with a specific locale; this is e.g. important when selecting between traditional and simplified Chinese is necessary (since the letters have the same Unicode ranges and character values).<p> diff --git a/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl b/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl index 0deef6e6ab76..f511b907312a 100644 --- a/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl +++ b/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl @@ -87,7 +87,7 @@ struct IntegerBitmapLayout palette, one of the pixel components as returned by the color space referenced from the #ColorSpace is required to be of type - <member>ColorComponentTag::INDEX</member>. That component is + ColorComponentTag::INDEX. That component is then used to index the palette.<p> */ XBitmapPalette Palette; diff --git a/offapi/com/sun/star/rendering/StrokeAttributes.idl b/offapi/com/sun/star/rendering/StrokeAttributes.idl index 441a5eec76a3..36caa6d8d0ff 100644 --- a/offapi/com/sun/star/rendering/StrokeAttributes.idl +++ b/offapi/com/sun/star/rendering/StrokeAttributes.idl @@ -43,13 +43,13 @@ struct StrokeAttributes corners.<p> This attribute is only used when - <member>StrokeAttributes::JoinType</member> is set to - <member>PathJoinType::MITER</member>. Should the length of a + StrokeAttributes::JoinType is set to + PathJoinType::MITER. Should the length of a corner's diagonal exceed this limit, a beveled join is used instead. This value must be positive (or 0.0, which is equivalent to setting - <member>StrokeAttributes::JoinType</member> to - <member>PathJoinType::BEVEL</member>.<p> + StrokeAttributes::JoinType to + PathJoinType::BEVEL.<p> Before performing the actual comparison, implementations will multiply the MiterLimit with the current StrokeWidth, such @@ -77,10 +77,10 @@ struct StrokeAttributes strokes.<p> The entries here are relative to the - <member>StrokeAttributes::StrokeWidth</member> attribute + StrokeAttributes::StrokeWidth attribute above, i.e. the total width of all lines and spacings will always equal - <member>StrokeAttributes::StrokeWidth</member>. The first + StrokeAttributes::StrokeWidth. The first element specifies the width of the rightmost line, when traveling from the start point of the path to the end point. The second element specifies the space between the diff --git a/offapi/com/sun/star/rendering/XAnimatedSprite.idl b/offapi/com/sun/star/rendering/XAnimatedSprite.idl index 1688c4a68357..adf9cf3e119e 100644 --- a/offapi/com/sun/star/rendering/XAnimatedSprite.idl +++ b/offapi/com/sun/star/rendering/XAnimatedSprite.idl @@ -91,7 +91,7 @@ interface XAnimatedSprite : XSprite sprite. Please note that if an animation is not started, the associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via - <member>XSpriteCanvas::updateScreen()</member>.<p> + XSpriteCanvas::updateScreen().<p> */ void updateAnimation(); @@ -100,18 +100,18 @@ interface XAnimatedSprite : XSprite animation.<p> The state given here is used when calling the - <member>XAnimation::render()</member> method, or when drawing + XAnimation::render() method, or when drawing the sprite's bitmaps, respectively. There's no need to call - <member>XSpriteCanvas::updateAnimation()</member> after this + XSpriteCanvas::updateAnimation() after this method, as it automatically rerenders, if necessary. Please note that if an animation is not started, the associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via - <member>XSpriteCanvas::updateScreen()</member>.<p> + XSpriteCanvas::updateScreen().<p> @param aViewState The state given here is used when calling the - <member>XAnimation::render()</member> method, or when drawing + XAnimation::render() method, or when drawing the sprite's bitmaps, respectively. @throws com::sun::star::lang::IllegalArgumentException @@ -130,7 +130,7 @@ interface XAnimatedSprite : XSprite Please note that if an animation is not started, the associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via - <member>XSpriteCanvas::updateScreen()</member>.<p> + XSpriteCanvas::updateScreen().<p> @param aNewPos New left,top output position of the sprite. This position gets diff --git a/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl b/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl index b4b0058352bb..4d841f984989 100644 --- a/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl +++ b/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl @@ -88,7 +88,7 @@ interface XBezierPolyPolygon2D : XPolyPolygon2D specifying 0 here, the given Bezier sequence will precede all existing polygons already within the poly-polygon). To append to a poly-polygon, call setPoints() with - <member>XBezierPolyPolygon2D::getNumberOfPolygons()</member> + XBezierPolyPolygon2D::getNumberOfPolygons() as the polygon index. If nPolygonIndex is -1, the given Bezier sequence <em>replaces</em> the poly-polygon content, such that after this method completes, it contains exactly the @@ -127,9 +127,9 @@ interface XBezierPolyPolygon2D : XPolyPolygon2D The remaining points of the poly-polygon will not be changed by this method. Use - <member>XBezierPolyPolygon2D::getNumberOfPolygons()</member> + XBezierPolyPolygon2D::getNumberOfPolygons() or - <member>XBezierPolyPolygon2D::getNumberOfPolygonPoints()</member> + XBezierPolyPolygon2D::getNumberOfPolygonPoints() to append points or polygons, respectively.<p> @param point diff --git a/offapi/com/sun/star/rendering/XBitmap.idl b/offapi/com/sun/star/rendering/XBitmap.idl index 0f963128894b..1fe3e26ca9b8 100644 --- a/offapi/com/sun/star/rendering/XBitmap.idl +++ b/offapi/com/sun/star/rendering/XBitmap.idl @@ -55,7 +55,7 @@ interface XBitmap : ::com::sun::star::uno::XInterface XColorSpace associated with this bitmap, though much easier to access here (the color space then has a component flagged - <member>ColorComponentTag::ALPHA</member>).<p> + ColorComponentTag::ALPHA).<p> @return <TRUE/>, if the bitmap has alpha data, or <FALSE/> if not. diff --git a/offapi/com/sun/star/rendering/XBitmapPalette.idl b/offapi/com/sun/star/rendering/XBitmapPalette.idl index d0154646867a..365c138877e9 100644 --- a/offapi/com/sun/star/rendering/XBitmapPalette.idl +++ b/offapi/com/sun/star/rendering/XBitmapPalette.idl @@ -58,7 +58,7 @@ interface XBitmapPalette : ::com::sun::star::uno::XInterface @throws com::sun::star::lang::IndexOutOfBoundsException if the index is smaller than zero or larger than - <member>XBitmapPalette::getNumberOfEntries()</member>-1. + XBitmapPalette::getNumberOfEntries()-1. */ boolean getIndex( [out] sequence<ColorComponent> entry, [in] long nIndex ) raises (com::sun::star::lang::IndexOutOfBoundsException); @@ -84,7 +84,7 @@ interface XBitmapPalette : ::com::sun::star::uno::XInterface @throws com::sun::star::lang::IndexOutOfBoundsException if the index is smaller than zero or larger than - <member>XBitmapPalette::getNumberOfEntries()</member>-1. + XBitmapPalette::getNumberOfEntries()-1. @throws com::sun::star::lang::IllegalArgumentException if the given sequence of color components does not match the diff --git a/offapi/com/sun/star/rendering/XCanvas.idl b/offapi/com/sun/star/rendering/XCanvas.idl index 9b9730988e05..74121faa78e6 100644 --- a/offapi/com/sun/star/rendering/XCanvas.idl +++ b/offapi/com/sun/star/rendering/XCanvas.idl @@ -106,7 +106,7 @@ interface XTextLayout; each render call. It is therefore recommended to create such objects via the XGraphicDevice factory (to be retrieved from every canvas object via the - <member>getDevice()</member> call) - they will then internally + getDevice() call) - they will then internally optimize to the underlying graphics subsystem.<p> @since OOo 2.0 @@ -601,7 +601,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface specified by the combined view and render transformations. For fast render speed, the bitmap should be created by the corresponding XGraphicDevice's - <member>XGraphicDevice::createCompatibleBitmap()</member> + XGraphicDevice::createCompatibleBitmap() method.<p> @param xBitmap @@ -633,7 +633,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface specified by the combined view and render transformations. For fast render speed, the bitmap should be created by the corresponding XGraphicDevice's - <member>XGraphicDevice::createCompatibleBitmap()</member> + XGraphicDevice::createCompatibleBitmap() method. The bitmap's color channel values are multiplied with the device color values as specified in the render state.<p> diff --git a/offapi/com/sun/star/rendering/XCanvasFont.idl b/offapi/com/sun/star/rendering/XCanvasFont.idl index fc56c6b66b70..d8b62f424b00 100644 --- a/offapi/com/sun/star/rendering/XCanvasFont.idl +++ b/offapi/com/sun/star/rendering/XCanvasFont.idl @@ -88,7 +88,7 @@ interface XCanvasFont : ::com::sun::star::uno::XInterface meaning that every size is possible. Fonts that <em>do</em> restrict the device size to certain discrete values, setting an overall transformation that scales the - <member>FontRequest::CellSize</member> to something not + FontRequest::CellSize to something not contained in the list returned by this method can lead to visible disturbances.<p> */ diff --git a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl index b0fef8efc4ba..5d0c025c077b 100644 --- a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl +++ b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl @@ -38,9 +38,9 @@ interface XIntegerBitmapColorSpace : XColorSpace This method yields the total number of bits used for a color value. At the associated XIntegerBitmap, the - <member>XIntegerBitmap::setPixel()</member> method will expect + XIntegerBitmap::setPixel() method will expect a sequence of ceil(BitsPerPixel/8) bytes, and the - <member>XIntegerReadOnlyBitmap::getPixel()</member> will + XIntegerReadOnlyBitmap::getPixel() will return that number of bytes. Similarly, the color conversion expect input data in multiples of ceil(BitsPerPixel/8), and also return converted data in chunks of this.<p> @@ -52,7 +52,7 @@ interface XIntegerBitmapColorSpace : XColorSpace This method returns a sequence of integers, each denoting the number of bits occupied by the respective component. The sum of all component bits must be less or equal than the value - returned from <member>getBitsPerPixel()</member>. If the sum is + returned from getBitsPerPixel(). If the sum is less, excess bits are always kept in the most significant bits of a pixel. Color components will appear in the byte sequences returned from the XIntegerBitmap methods in the diff --git a/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl b/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl index 551051c42e66..abd9ed3e7185 100644 --- a/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl +++ b/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl @@ -73,7 +73,7 @@ interface XLinePolyPolygon2D : XPolyPolygon2D specifying 0 here, the given point sequence will precede all existing polygons already within the poly-polygon). To append to a poly-polygon, call setPoints() with - <member>XLinePolyPolygon2D::getNumberOfPolygons()</member> + XLinePolyPolygon2D::getNumberOfPolygons() as the polygon index. If nPolygonIndex is -1, the given sequence of points <em>replaces</em> the poly-polygon content, such that after this method completes, it contains exactly the diff --git a/offapi/com/sun/star/rendering/XSprite.idl b/offapi/com/sun/star/rendering/XSprite.idl index 9e58de209960..81dc07079ffb 100644 --- a/offapi/com/sun/star/rendering/XSprite.idl +++ b/offapi/com/sun/star/rendering/XSprite.idl @@ -43,7 +43,7 @@ interface XSprite : ::com::sun::star::uno::XInterface Please note that if this sprite is not animated, the associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via - <member>XSpriteCanvas::updateScreen()</member>.<p> + XSpriteCanvas::updateScreen().<p> @param nAlpha New global alpha value to composite this sprite with the @@ -66,7 +66,7 @@ interface XSprite : ::com::sun::star::uno::XInterface Please note that if this sprite is not animated, the associated XSpriteCanva does not update changed sprites automatically, but has to be told to do so via - <member>XSpriteCanvas::updateScreen()</member>.<p> + XSpriteCanvas::updateScreen().<p> @param aNewPos The new position, in user coordinate space, to move the sprite to. @@ -104,7 +104,7 @@ interface XSprite : ::com::sun::star::uno::XInterface Please note that if this sprite is not animated, the associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via - <member>XSpriteCanvas::updateScreen()</member>.<p> + XSpriteCanvas::updateScreen().<p> @param aTransformation The transformation to apply to the sprite shape. @@ -135,7 +135,7 @@ interface XSprite : ::com::sun::star::uno::XInterface Please note that if this sprite is not animated, the associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via - <member>XSpriteCanvas::updateScreen()</member>.<p> + XSpriteCanvas::updateScreen().<p> Specifying an empty interface denotes no clipping, i.e. everything contained in the sprite will be visible diff --git a/offapi/com/sun/star/rendering/XTextLayout.idl b/offapi/com/sun/star/rendering/XTextLayout.idl index 212ae5a3b574..602aef021009 100644 --- a/offapi/com/sun/star/rendering/XTextLayout.idl +++ b/offapi/com/sun/star/rendering/XTextLayout.idl @@ -43,8 +43,8 @@ interface XPolyPolygon2D; This is the central interface for text-related tasks more complicated than simple string rendering. Note that all query methods are subject to the current layout state of this - object. That is, calls to <member>XTextLayout::justify()</member> - or <member>XTextLayout::applyLogicalAdvancements()</member> are + object. That is, calls to XTextLayout::justify() + or XTextLayout::applyLogicalAdvancements() are likely to change subsequent output of those query methods.<p> Similar to XCanvasFont, all measurements and @@ -87,7 +87,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface @returns a sequence of rectangles in font coordinate space, specifying the bounds, one for every glyph. - @see <member>XTextLayout::queryMeasures()</member> + @see XTextLayout::queryMeasures() */ sequence<::com::sun::star::geometry::RealRectangle2D > queryInkMeasures(); @@ -98,12 +98,12 @@ interface XTextLayout : ::com::sun::star::uno::XInterface Logical bounding boxes means the space that the font allocates for the given character, which, e.g. for a ".", might be significantly broader than the bounds returned via - <member>XTextLayout::queryInkMeasures()</member>. + XTextLayout::queryInkMeasures(). @returns a sequence of rectangles specifying the bounds in font coordinate space, one for every glyph. - @see <member>XTextLayout::queryInkMeasures()</member> + @see XTextLayout::queryInkMeasures() */ sequence<::com::sun::star::geometry::RealRectangle2D> queryMeasures(); @@ -119,12 +119,12 @@ interface XTextLayout : ::com::sun::star::uno::XInterface this method can be used to query for the layout's default advancements, which can subsequently be changed and applied to the layout via - <member>XTextLayout::applyLogicalAdvancements()</member>.<p> + XTextLayout::applyLogicalAdvancements().<p> @returns a sequence of double specifying the advancements per character in font coordinate space. - @see <member>XTextLayout::applyLogicalAdvancements()</member> + @see XTextLayout::applyLogicalAdvancements() */ sequence<double> queryLogicalAdvancements(); @@ -143,7 +143,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface A sequence of character advancements, in font coordinate space. - @see <member>XTextLayout::queryLogicalAdvancements()</member> + @see XTextLayout::queryLogicalAdvancements() @throws com::sun::star::lang::IllegalArgumentException if the size of aAdvancements does not match the number of @@ -246,7 +246,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface @param nInsertionIndex The insertion index, as e.g. returned by - <member>XTextLayout::getTextHit()</member>. This value must be + XTextLayout::getTextHit(). This value must be in the range 0 up to the number of characters in the string. @param bExcludeLigatures @@ -344,7 +344,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface object, either measured from the top or the left edge, depending on the writing direction (horizontally or vertically). Since rendering this layout via - <member>XCanvas::drawTextLayout()</member> outputs relative to + XCanvas::drawTextLayout() outputs relative to the layout object's baseline, this method can be used to e.g. output relative to the left, top edge.<p> diff --git a/offapi/com/sun/star/report/XReportDefinition.idl b/offapi/com/sun/star/report/XReportDefinition.idl index 3477329c13bd..247d3ee24ad2 100644 --- a/offapi/com/sun/star/report/XReportDefinition.idl +++ b/offapi/com/sun/star/report/XReportDefinition.idl @@ -165,7 +165,7 @@ interface XReportDefinition /** is the command which should be executed, the type of command depends on the CommandType. - <p>In case of a #CommandType of <member>CommandType::COMMAND</member>, + <p>In case of a #CommandType of CommandType::COMMAND, means in case the #Command specifies an SQL statement, the inherited <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member> becomes relevant:<br/> @@ -215,7 +215,7 @@ interface XReportDefinition <p>This property is usually present together with the #Command and #CommandType properties, and is evaluated if and only if #CommandType - equals <member>CommandType::COMMAND</member>.</p> + equals CommandType::COMMAND.</p> */ [attribute,bound] boolean EscapeProcessing; diff --git a/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl b/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl index 2ed5c67d4f17..18cd9a8aa085 100644 --- a/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl +++ b/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl @@ -39,7 +39,7 @@ service DocumentDialogLibraryContainer : XStorageBasedLibraryContainer /** creates an instance of the <code>DocumentDialogLibraryContainer</code>, belonging to a document <p>The current storage of the document will be set as initial root storage - (see <member>XPersistentLibraryContainer::RootStorage</member>) of the container.</p> + (see XPersistentLibraryContainer::RootStorage) of the container.</p> <p>Usually, you will only create a <code>DocumentDialogLibraryContainer</code> within the implementation of the document to which the container should belong.</p> diff --git a/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl b/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl index d4daa2bfd947..9bf4767b3e4b 100644 --- a/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl +++ b/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl @@ -39,7 +39,7 @@ service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer /** creates an instance of the <code>DocumentScriptLibraryContainer</code>, belonging to a document <p>The current storage of the document will be set as initial root storage - (see <member>XPersistentLibraryContainer::RootStorage</member>) of the container.</p> + (see XPersistentLibraryContainer::RootStorage) of the container.</p> <p>Usually, you will only create a <code>DocumentScriptLibraryContainer</code> within the implementation of the document to which the container should belong.</p> diff --git a/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl index acfbecc53a7b..2c0acbd524d4 100644 --- a/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl +++ b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl @@ -44,7 +44,7 @@ interface XStorageBasedLibraryContainer /** denotes the root storage associated with the container. <p>Effectively, this attribute is a typed version of - <member>XPersistentLibraryContainer::RootLocation</member>, it's guaranteed + XPersistentLibraryContainer::RootLocation, it's guaranteed that at every time, <code>XPersistentLibraryContainer::RootLocation</code> and <code>RootStorage</code> have the same value.</p> diff --git a/offapi/com/sun/star/script/vba/VBAScriptEventId.idl b/offapi/com/sun/star/script/vba/VBAScriptEventId.idl index b7347d32e43a..a3a3bcebe7f3 100644 --- a/offapi/com/sun/star/script/vba/VBAScriptEventId.idl +++ b/offapi/com/sun/star/script/vba/VBAScriptEventId.idl @@ -44,7 +44,7 @@ constants VBAScriptEventId XVBACompatibility::RunningVBAScripts</member>. The number returned there will already contain the new script notified with this event.</p> - <p>The member <member>VBAScriptEvent::ModuleName</member> of the event + <p>The member VBAScriptEvent::ModuleName of the event object will contain the name of the code module that contains the started script.</p> */ @@ -61,7 +61,7 @@ constants VBAScriptEventId there will not contain the stopped script notified with this event anymore.</p> - <p>The member <member>VBAScriptEvent::ModuleName</member> of the event + <p>The member VBAScriptEvent::ModuleName of the event object will contain the name of the code module that contains the script that has been stopped.</p> */ @@ -70,7 +70,7 @@ constants VBAScriptEventId /** This event is fired when a VBA script in the current document tries to instanciate a userform. - <p>The member <member>VBAScriptEvent::ModuleName</member> of the event + <p>The member VBAScriptEvent::ModuleName of the event object will contain the name of the userform module.</p> */ const long INITIALIZE_USERFORM = 2; diff --git a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl index a2b693a536bb..90e3feff8733 100644 --- a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl +++ b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl @@ -91,7 +91,7 @@ published service DataAccessDescriptor <p>This object is guaranteed to be a com::sun::star::sdbc::Connection, but usually it will be a Connection from the module com::sun::star::sdb.<br/> Especially in the case where no #DataSourceName is given, but - #CommandType is <member>CommandType::QUERY</member>, the ActiveConnection needs + #CommandType is CommandType::QUERY, the ActiveConnection needs to fully support the Connection service, to actually retrieve the query specified by #Command</p> @@ -168,7 +168,7 @@ published service DataAccessDescriptor <p>This property is usually present together with the #Command and #CommandType properties, and is evaluated if and only if #CommandType - equals <member>CommandType::COMMAND</member>.</p> + equals CommandType::COMMAND.</p> */ [optional, property] boolean EscapeProcessing; diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl index d0dccd3ea78a..c6d2aa312ec5 100644 --- a/offapi/com/sun/star/sdb/DataSourceBrowser.idl +++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl @@ -121,16 +121,16 @@ module com { module sun { module star { module sdb { <p>For all kinds of URLs, the parameters supplied during dispatching build up a DataAccessDescriptor, where the following properties are present: <ul> - <li><member>DataAccessDescriptor::DataSourceName</member></li> - <li><member>DataAccessDescriptor::Command</member></li> - <li><member>DataAccessDescriptor::CommandType</member></li> - <li><em>optional</em> <member>DataAccessDescriptor::Selection</member></li> - <li><em>optional</em> <member>DataAccessDescriptor::BookmarkSelection</member></li> - <li><em>optional</em> <member>DataAccessDescriptor::ResultSet</member></li> + <li>DataAccessDescriptor::DataSourceName</li> + <li>DataAccessDescriptor::Command</li> + <li>DataAccessDescriptor::CommandType</li> + <li><em>optional</em> DataAccessDescriptor::Selection</li> + <li><em>optional</em> DataAccessDescriptor::BookmarkSelection</li> + <li><em>optional</em> DataAccessDescriptor::ResultSet</li> </ul> </p> - <p>The default for <member>DataAccessDescriptor::Selection</member> is to contain bookmarks, if not specified - otherwise by <member>DataAccessDescriptor::BookmarkSelection</member>.</pr> + <p>The default for DataAccessDescriptor::Selection is to contain bookmarks, if not specified + otherwise by DataAccessDescriptor::BookmarkSelection.</pr> </p> @see com::sun::star::sdb::ContentLoader diff --git a/offapi/com/sun/star/sdb/QueryDesign.idl b/offapi/com/sun/star/sdb/QueryDesign.idl index 4b8a3e00a123..d302b382227c 100644 --- a/offapi/com/sun/star/sdb/QueryDesign.idl +++ b/offapi/com/sun/star/sdb/QueryDesign.idl @@ -85,7 +85,7 @@ module com { module sun { module star { module sdb { <li><a name="command"></a><b>Command</b><br/> specifies the name of the query or view to design, or, in case of the <a href="#command_type">CommandType</a> - being <member>CommandType::COMMAND</member>, the initial SQL command.<br/> + being CommandType::COMMAND, the initial SQL command.<br/> If this parameter is not present, a new query/view will be designed, respectively the initial command will be empty. </li> @@ -93,7 +93,7 @@ module com { module sun { module star { module sdb { <li><a name="command_type"></a><b>CommandType</b><br/> specifies the type of object which should be designed. The following options are supported: - <ul><li><member>CommandType::QUERY</member> specifies the designer should operate in + <ul><li>CommandType::QUERY specifies the designer should operate in <a href="#query_mode">query mode</a>, that is, an existing client-side query should be designed, or a new query should be created, depending on the presence of the <a href="#command">Command</a> parameter.<br/> @@ -102,13 +102,13 @@ module com { module sun { module star { module sdb { the data source which the <a href="#active_connection">ActiveConnection</a> belongs to, and looks up the query there.</li> - <li><member>CommandType::COMMAND</member> specifies the designer should operate in + <li>CommandType::COMMAND specifies the designer should operate in <a href="#command_mode">command mode</a>, that is, a standalone SQL command should be designed. When the user attempts to save the designed SQL statement, the #ActiveCommand and #EscapeProcessing properties of the designer are updated.</li> - <li><member>CommandType::TABLE</member> specifies the designer should operate in + <li>CommandType::TABLE specifies the designer should operate in <a href="#view_mode">view mode</a>, that is, an existing or a new server-side view should be designed, depending on the presence of the <a href="#command">Command</a> parameter.<br/> @@ -116,7 +116,7 @@ module com { module sun { module star { module sdb { looked up in a newly created connection for the specified data source. Otherwise, it is looked up in the connection given as <a href="#active_connection">ActiveConnection</a>.</li> </ul> - If not present, this parameter defaults to <member>CommandType::QUERY</member>. + If not present, this parameter defaults to CommandType::QUERY. </li> <li><b>EscapeProcessing</b><br/> @@ -138,17 +138,17 @@ module com { module sun { module star { module sdb { <ul> <li><b>CurrentQuery</b><br/> is the same as Command, and implies a <a href="#command_type">CommandType</a> of - <member>CommandType::QUERY</member></li> + CommandType::QUERY</li> <li><b>QueryDesignView</b><br/> is the same as <a href="#graphical_design">GraphicalDesign</a>.</li> <li><b>IndependentSQLCommand</b><br/> is the same as Command, and implies a <a href="#command_type">CommandType</a> of - <member>CommandType::COMMAND</member></li> + CommandType::COMMAND</li> <li><b>CreateView</b><br/> - implies a <a href="#command_type">CommandType</a> of <member>CommandType::TABLE</member></li> + implies a <a href="#command_type">CommandType</a> of CommandType::TABLE</li> </ul> @see com::sun::star::sdb::ContentLoader diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index c49f84169ca7..72e9a7c8c6ba 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -280,7 +280,7 @@ published service RowSet /** is the command which should be executed, the type of command depends on the CommandType. - <p>In case of a #CommandType of <member>CommandType::COMMAND</member>, + <p>In case of a #CommandType of CommandType::COMMAND, means in case the #Command specifies an SQL statement, the inherited <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member> becomes relevant:<br/> diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl index 500c7138f7d2..95ab9c3de83c 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl @@ -194,7 +194,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface is the command which should be executed, the type of command depends on the CommandType. - <p>In case of a #CommandType of <member>CommandType::COMMAND</member>, + <p>In case of a #CommandType of CommandType::COMMAND, means in case the #Command specifies an SQL statement, the inherited <member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member> becomes relevant:<br/> diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl index 68c602b9ed15..85d136bfe092 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl @@ -208,17 +208,17 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer <p>There are various use cases for this. For instance, you might want to use the statement represented by a QueryDefinition, and extend it with additional filters or sort orders, while not touching the respective parts already present - in <member>QueryDefinition::Command</member>. This can be achieved by setting the - <member>QueryDefinition::Command</member> as #ElementaryQuery of a + in QueryDefinition::Command. This can be achieved by setting the + QueryDefinition::Command as #ElementaryQuery of a SingleSelectQueryComposer.</p> <p>If, in such a scenario, you would be interested in the filter part of the - <member>QueryDefinition::Command</member>, you would set it via + QueryDefinition::Command, you would set it via XSingleSelectQueryAnalyzer::setQuery(), and retrieve the filter part via XSingleSelectQueryAnalyzer::getFilter().</p> <p>If you'd be interested in the composed filter, you would set the - <member>QueryDefinition::Command</member> as #ElementaryQuery, add your + QueryDefinition::Command as #ElementaryQuery, add your filter, and propagate the resulting query (XSingleSelectQueryAnalyzer::getQuery()) to an SingleSelectQueryAnalyzer instance via XSingleSelectQueryAnalyzer::setQuery().</p> diff --git a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl index 3cadfb51d250..00bc0c7a1e53 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl @@ -137,7 +137,7 @@ service CopyTableWizard : XCopyTableWizard must support the com::sun::star::sdb::Connection service. In particular, it is not sufficient to pass an SDBC-level connection.</p> - <p>Note that creating a view (see <member>CopyTableOperation::CreateAsView</member>) is + <p>Note that creating a view (see CopyTableOperation::CreateAsView) is not supported if the target connection is an SDBC-level connection only.</p> @throws ::com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl b/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl index 8087ed519c2e..fd51a3d6696c 100644 --- a/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl +++ b/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl @@ -46,8 +46,8 @@ struct NamedDatabaseObject <p>In case of queries, this is the name of the query.</p> - <p>In case of virtual folders denoted by <member>DatabaseObjectContainer::CATALOG</member> and - <member>DatabaseObjectContainer::SCHEMA</member>, it is + <p>In case of virtual folders denoted by DatabaseObjectContainer::CATALOG and + DatabaseObjectContainer::SCHEMA, it is <ul><li><code><schema></code>, if the database supports schemas only</li> <li><code><catalog></code>, if the database supports catalogs only</li> <li><code><catalog>.<schema></code>, if the database supports both @@ -57,9 +57,9 @@ struct NamedDatabaseObject </ul> </p> - <p>In case of the virtual folders denoted by <member>DatabaseObjectContainer::TABLES</member>, - <member>DatabaseObjectContainer::QUERIES</member>, <member>DatabaseObjectContainer::DATA_SOURCE</member>, - <member>DatabaseObjectContainer::FORMS</member> or <member>DatabaseObjectContainer::REPORTS</member>, + <p>In case of the virtual folders denoted by DatabaseObjectContainer::TABLES, + DatabaseObjectContainer::QUERIES, DatabaseObjectContainer::DATA_SOURCE, + DatabaseObjectContainer::FORMS or DatabaseObjectContainer::REPORTS, this denotes the name of the data source (as denoted by <member scope="com::sun::star::sdb">DataSource::Name</member>)</p> diff --git a/offapi/com/sun/star/sdb/application/XCopyTableListener.idl b/offapi/com/sun/star/sdb/application/XCopyTableListener.idl index c762b463aa88..72613157e54d 100644 --- a/offapi/com/sun/star/sdb/application/XCopyTableListener.idl +++ b/offapi/com/sun/star/sdb/application/XCopyTableListener.idl @@ -42,7 +42,7 @@ interface XCopyTableListener : ::com::sun::star::lang::XEventListener @param Event describes the current state of the copy operation. - <member>CopyTableRowEvent::SourceData</member> is positioned at the row + CopyTableRowEvent::SourceData is positioned at the row which is about to be copied. */ void copyingRow( [in] CopyTableRowEvent Event ); @@ -54,7 +54,7 @@ interface XCopyTableListener : ::com::sun::star::lang::XEventListener @param Event describes the current state of the copy operation. - <member>CopyTableRowEvent::SourceData</member> is positioned at the row + CopyTableRowEvent::SourceData is positioned at the row which was just copied to the target database. */ void copiedRow( [in] CopyTableRowEvent Event ); @@ -63,9 +63,9 @@ interface XCopyTableListener : ::com::sun::star::lang::XEventListener @param Event describes the current state of the copy operation. - <member>CopyTableRowEvent::SourceData</member> is positioned at the row + CopyTableRowEvent::SourceData is positioned at the row which was attempted to be copied to the target database. - <member>CopyTableRowEvent::Error</member> will contain the actual error which + CopyTableRowEvent::Error will contain the actual error which happened. @return diff --git a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl index 6a1968050c53..09a8843e0f7d 100644 --- a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl @@ -61,7 +61,7 @@ interface XCopyTableWizard : ::com::sun::star::ui::dialogs::XExecutableDialog @throws IllegalArgumentException if you attempt to set an invalid operation, or if the given operation is not supported by the target database type, e.g. if you specified - <member>CopyTableOperation::CreateAsView</member> where the database + CopyTableOperation::CreateAsView where the database does not support views. */ [attribute] short Operation @@ -94,7 +94,7 @@ interface XCopyTableWizard : ::com::sun::star::ui::dialogs::XExecutableDialog which cannot be represented in this simple attribute anymore.</p> <p>This attribute is ignored if #Operation is - <member>CopyTableOperation::AppendData</member>.</p> + CopyTableOperation::AppendData.</p> <p>Changing this attribute while the dialog is running is not supported, the result of such an attempt is undefined.</p> diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl index 3e3b88f8e216..6fbda1399984 100644 --- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl +++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl @@ -270,8 +270,8 @@ interface XDatabaseDocumentUI constants. @param DocumentDefinition - Upon successful return, and if and only if <arg>ObjectType</arg> equals <member>DatabaseObject::FORM</member> - or <member>DatabaseObject::REPORT</member>, this will contain the com::sun::star::sdb::DocumentDefinition + Upon successful return, and if and only if <arg>ObjectType</arg> equals DatabaseObject::FORM + or DatabaseObject::REPORT, this will contain the com::sun::star::sdb::DocumentDefinition object which controls the sub component. */ ::com::sun::star::lang::XComponent createComponent( @@ -294,8 +294,8 @@ interface XDatabaseDocumentUI constants. @param DocumentDefinition - Upon successful return, and if and only if <arg>ObjectType</arg> equals <member>DatabaseObject::FORM</member> - or <member>DatabaseObject::REPORT</member>, this will contain the com::sun::star::sdb::DocumentDefinition + Upon successful return, and if and only if <arg>ObjectType</arg> equals DatabaseObject::FORM + or DatabaseObject::REPORT, this will contain the com::sun::star::sdb::DocumentDefinition object which controls the sub component.<br/> You can use this object to control various aspects of the sub component. For instance, you could decide to create the component hidden, by passing a <code>Hidden</code> flag (set to <TRUE/>) in <arg>Arguments</arg>, diff --git a/offapi/com/sun/star/sdbc/BestRowScope.idl b/offapi/com/sun/star/sdbc/BestRowScope.idl index bad4eeb3c4bf..2f19b6446710 100644 --- a/offapi/com/sun/star/sdbc/BestRowScope.idl +++ b/offapi/com/sun/star/sdbc/BestRowScope.idl @@ -35,7 +35,7 @@ published constants BestRowScope com::sun::star::sdbc::XResultSet object returned by the method - <member>XDatabaseMetaData::getBestRowIdentifier()</member> + XDatabaseMetaData::getBestRowIdentifier() . */ const long TEMPORARY = 0; @@ -48,7 +48,7 @@ published constants BestRowScope com::sun::star::sdbc::XResultSet object returned by the method - <member>XDatabaseMetaData::getBestRowIdentifier()</member> + XDatabaseMetaData::getBestRowIdentifier() . */ const long TRANSACTION = 1; @@ -61,7 +61,7 @@ published constants BestRowScope com::sun::star::sdbc::XResultSet object returned by the method - <member>XDatabaseMetaData::getBestRowIdentifier()</member> + XDatabaseMetaData::getBestRowIdentifier() . */ const long SESSION = 2; diff --git a/offapi/com/sun/star/sdbc/BestRowType.idl b/offapi/com/sun/star/sdbc/BestRowType.idl index fe6c3dc5de2d..eba306904586 100644 --- a/offapi/com/sun/star/sdbc/BestRowType.idl +++ b/offapi/com/sun/star/sdbc/BestRowType.idl @@ -34,7 +34,7 @@ published constants BestRowType com::sun::star::sdbc::XResultSet object returned by the method - <member>XDatabaseMetaData::getBestRowIdentifier()</member> + XDatabaseMetaData::getBestRowIdentifier() . */ const long UNKNOWN = 0; @@ -46,7 +46,7 @@ published constants BestRowType com::sun::star::sdbc::XResultSet object returned by the method - <member>XDatabaseMetaData::getBestRowIdentifier()</member> + XDatabaseMetaData::getBestRowIdentifier() . */ const long NOT_PSEUDO = 1; @@ -58,7 +58,7 @@ published constants BestRowType com::sun::star::sdbc::XResultSet object returned by the method - <member>XDatabaseMetaData::getBestRowIdentifier()</member> + XDatabaseMetaData::getBestRowIdentifier() . */ const long PSEUDO = 2; diff --git a/offapi/com/sun/star/sdbc/DataType.idl b/offapi/com/sun/star/sdbc/DataType.idl index d840996a2f02..5e4ecf96dac8 100644 --- a/offapi/com/sun/star/sdbc/DataType.idl +++ b/offapi/com/sun/star/sdbc/DataType.idl @@ -30,7 +30,7 @@ </p> <p> Precise information about the specific types can be got from - <member>XDatabaseMetaData::getTypeInfo()</member> + XDatabaseMetaData::getTypeInfo() .</p> */ published constants DataType diff --git a/offapi/com/sun/star/sheet/AddIn.idl b/offapi/com/sun/star/sheet/AddIn.idl index 73fdcc397163..9385c22b8f21 100644 --- a/offapi/com/sun/star/sheet/AddIn.idl +++ b/offapi/com/sun/star/sheet/AddIn.idl @@ -80,7 +80,7 @@ module com { module sun { module star { module sheet { interface to the SpreadsheetDocument making the function call. Only one parameter of this type is allowed in each function. It can be used to query document settings like - <member>SpreadsheetDocumentSettings::NullDate</member>.</dd> + SpreadsheetDocumentSettings::NullDate.</dd> <dt><atom>any[]</atom></dt> <dd>for varying parameters. Only the last parameter of a function may diff --git a/offapi/com/sun/star/sheet/DDELinkInfo.idl b/offapi/com/sun/star/sheet/DDELinkInfo.idl index 151a1e3d40da..9c24e7ab462f 100644 --- a/offapi/com/sun/star/sheet/DDELinkInfo.idl +++ b/offapi/com/sun/star/sheet/DDELinkInfo.idl @@ -34,8 +34,8 @@ module com { module sun { module star { module sheet { <em>[1]</em> is an external link with DDE service name "excel" and the topic "X:\PATH\[FILE.XLSX]Sheet1", and <em>[2]</em> contains service "soffice" and topic "file:///X:/PATH/FILE.ODS". The service name is stored - in <member>DDELinkInfo::Service</member>, the topic is stored in - <member>DDELinkInfo::Topic</member>. Note that if the DDE item contains + in DDELinkInfo::Service, the topic is stored in + DDELinkInfo::Topic. Note that if the DDE item contains single quotes they are escaped by doubling them, as usual, for example <code>=[2]!'''Sheet name''.A1'</code> in a "soffice" service.</p> diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl index 8c203aedec10..7f0ac23fc0ee 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl @@ -123,7 +123,7 @@ published struct DataPilotFieldGroupInfo </type>. The collection of groups can be modified by inserting, removing, replacing, or renaming single groups or item names in the groups. When writing back this struct containing such a changed - collection of groups to the <member>DataPilotField::GroupInfo</member> + collection of groups to the DataPilotField::GroupInfo property, the modified grouping settings are applied at the DataPilot field.</p> diff --git a/offapi/com/sun/star/sheet/DataPilotFieldReference.idl b/offapi/com/sun/star/sheet/DataPilotFieldReference.idl index 68294be3f75b..a9a153f95a92 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldReference.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldReference.idl @@ -60,7 +60,7 @@ published struct DataPilotFieldReference /** contains the name of the reference item, when the - <member>DataPilotFieldReference::ReferenceItemType</member> is NAMED + DataPilotFieldReference::ReferenceItemType is NAMED otherwise is empty */ diff --git a/offapi/com/sun/star/sheet/DataPilotTableHeaderData.idl b/offapi/com/sun/star/sheet/DataPilotTableHeaderData.idl index 5e29c5de6a8c..5dca9e9156aa 100644 --- a/offapi/com/sun/star/sheet/DataPilotTableHeaderData.idl +++ b/offapi/com/sun/star/sheet/DataPilotTableHeaderData.idl @@ -31,8 +31,8 @@ module com { module sun { module star { module sheet { This struct contains information about a particular cell located within the column or row header area of a DataPilot table. This is the type that is - contained in <member>DataPilotTablePositionData::PositionData</member> when - the value of <member>DataPilotTablePositionData::PositionType</member> is + contained in DataPilotTablePositionData::PositionData when + the value of DataPilotTablePositionData::PositionType is either <const>DataPilotTablePositionType::ROW_HEADER</const> or <const>DataPilotTablePositionType::COLUMN_HEADER</const>. diff --git a/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl index 4cc813d3bf86..5672e18da68f 100644 --- a/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl +++ b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl @@ -56,9 +56,9 @@ struct DataPilotTablePositionData position type specified in #PositionType member.</p> <p>When the value of #PositionType is - <const>DataPilotTablePositionType::RESULT</const>, <member>DataPilotTablePositionData::PositionData</member> + <const>DataPilotTablePositionType::RESULT</const>, DataPilotTablePositionData::PositionData contains an instance of type DataPilotTableResultData, - whereas when the value of <member>DataPilotTablePositionData::PositionType</member> + whereas when the value of DataPilotTablePositionData::PositionType is either <const>DataPilotTablePositionType::ROW_HEADER</const> or <const>DataPilotTablePositionType::COLUMN_HEADER</const>, then the #PositionData member contains an instance of type <type> diff --git a/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl b/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl index 5d281047ca78..40355368a919 100644 --- a/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl +++ b/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl @@ -48,7 +48,7 @@ published service DatabaseImportDescriptor /** specifies the table, query, or statement from which data is imported. <p>The meaning of this is determined by the - <member>DatabaseImportDescriptor::SourceType</member> attribute.</p> + DatabaseImportDescriptor::SourceType attribute.</p> */ [property] string SourceObject; diff --git a/offapi/com/sun/star/sheet/DatabaseRange.idl b/offapi/com/sun/star/sheet/DatabaseRange.idl index 156f28c75d22..57baadaab6dc 100644 --- a/offapi/com/sun/star/sheet/DatabaseRange.idl +++ b/offapi/com/sun/star/sheet/DatabaseRange.idl @@ -78,7 +78,7 @@ published service DatabaseRange /** specifies the range where the filter can find the filter criteria. - <p>This is only used if <member>SheetFilterDescriptor::UseFilterCriteriaSource</member> is <TRUE/>.</p> + <p>This is only used if SheetFilterDescriptor::UseFilterCriteriaSource is <TRUE/>.</p> @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/sheet/ExternalLinkType.idl b/offapi/com/sun/star/sheet/ExternalLinkType.idl index 21fb3b74bb98..295896a0ab8d 100644 --- a/offapi/com/sun/star/sheet/ExternalLinkType.idl +++ b/offapi/com/sun/star/sheet/ExternalLinkType.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module sheet { /** Constants designating the link type in ExternalLinkInfo, used with - <member>FormulaParser::ExternalLinks</member>. + FormulaParser::ExternalLinks. @since OOo 3.1 */ diff --git a/offapi/com/sun/star/sheet/ExternalReference.idl b/offapi/com/sun/star/sheet/ExternalReference.idl index 70f4e1d9fc83..17b7dede7e30 100644 --- a/offapi/com/sun/star/sheet/ExternalReference.idl +++ b/offapi/com/sun/star/sheet/ExternalReference.idl @@ -67,7 +67,7 @@ struct ExternalReference cell reference, ComplexReference for a cell range reference, or simply a string for a defined name.</p> - <p>The <member>SingleReference::Sheet</member> member shall contain + <p>The SingleReference::Sheet member shall contain the index of the external sheet cache containing the values of the externally referenced cells.</p> diff --git a/offapi/com/sun/star/sheet/FilterFieldValue.idl b/offapi/com/sun/star/sheet/FilterFieldValue.idl index 631dc9b0cef4..5d1b40837476 100644 --- a/offapi/com/sun/star/sheet/FilterFieldValue.idl +++ b/offapi/com/sun/star/sheet/FilterFieldValue.idl @@ -17,8 +17,8 @@ module com { module sun { module star { module sheet { */ struct FilterFieldValue { - /** selects whether the <member>TableFilterFieldValue::NumericValue</member> - or the <member>TableFilterFieldValue::StringValue</member> is used. + /** selects whether the TableFilterFieldValue::NumericValue + or the TableFilterFieldValue::StringValue is used. */ boolean IsNumeric; diff --git a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl index f16a0a57fe0f..af56746489f6 100644 --- a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl +++ b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl @@ -37,7 +37,7 @@ constants FormulaMapGroupSpecialOffset describe a formula operand token that will be pushed onto the formula stack while the formula is interpreted. - <p>The <member>FormulaToken::Data</member> member shall contain one of + <p>The FormulaToken::Data member shall contain one of the following values:</p> <ul> @@ -65,7 +65,7 @@ constants FormulaMapGroupSpecialOffset instruct the formula interpreter to immediately stop interpreting the formula. - <p>The <member>FormulaToken::Data</member> member is not used + <p>The FormulaToken::Data member is not used and should be empty.</p> */ const long STOP = 2; @@ -75,7 +75,7 @@ constants FormulaMapGroupSpecialOffset describe the reference to an external function (e.g. add-in function) used in formulas. - <p>The <member>FormulaToken::Data</member> member shall contain a + <p>The FormulaToken::Data member shall contain a <atom>string</atom> with the programmatic name of the function, e.g. "com.sun.star.sheet.addin.Analysis.getEomonth" for the EOMONTH function from the Analysis add-in.</p> @@ -87,10 +87,10 @@ constants FormulaMapGroupSpecialOffset describe the reference to a defined name (also known as named range) used in formulas. - <p>The <member>FormulaToken::Data</member> member shall contain an + <p>The FormulaToken::Data member shall contain an integer value of type <atom>long</atom> specifying the index of the defined name. This index can be obtained from the defined name using - its <member>NamedRange::TokenIndex</member> property.</p> + its NamedRange::TokenIndex property.</p> @see NamedRange */ @@ -100,7 +100,7 @@ constants FormulaMapGroupSpecialOffset /** Formula tokens containing the op-code obtained from this offset describe an invalid name that resolves to the #NAME? error in formulas. - <p>The <member>FormulaToken::Data</member> member is not used + <p>The FormulaToken::Data member is not used and should be empty.</p> */ const long NO_NAME = 5; @@ -113,7 +113,7 @@ constants FormulaMapGroupSpecialOffset parameter is empty and represented by a formula token containing the "missing" op-code.</p> - <p>The <member>FormulaToken::Data</member> member is not used + <p>The FormulaToken::Data member is not used and should be empty.</p> */ const long MISSING = 6; @@ -123,7 +123,7 @@ constants FormulaMapGroupSpecialOffset describe "bad" data in a formula, e.g. data the formula parser was not able to parse. - <p>The <member>FormulaToken::Data</member> member shall contain a + <p>The FormulaToken::Data member shall contain a <atom>string</atom> with the bad data. This string will be displayed literally in the formula.</p> */ @@ -137,7 +137,7 @@ constants FormulaMapGroupSpecialOffset <p>Whitespace characters in formulas are used for readability and do not affect the result of the formula.</p> - <p>The <member>FormulaToken::Data</member> member shall contain a + <p>The FormulaToken::Data member shall contain a positive integer value of type <atom>long</atom> specifying the number of space characters.</p> @@ -154,10 +154,10 @@ constants FormulaMapGroupSpecialOffset /** Formula tokens containing the op-code obtained from this offset describe the reference to a database range used in formulas. - <p>The <member>FormulaToken::Data</member> member shall contain an + <p>The FormulaToken::Data member shall contain an integer value of type <atom>long</atom> specifying the index of the database range. This index can be obtained from the database range - using its <member>DatabaseRange::TokenIndex</member> property.</p> + using its DatabaseRange::TokenIndex property.</p> @see DatabaseRange */ @@ -167,7 +167,7 @@ constants FormulaMapGroupSpecialOffset /** Formula tokens containing the op-code obtained from this offset describe the reference to a macro function called in a formula. - <p>The <member>FormulaToken::Data</member> member shall contain a + <p>The FormulaToken::Data member shall contain a <atom>string</atom> specifying the name of the macro function.</p> */ const long MACRO = 11; diff --git a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl index c491b62471f8..ea27bbc8de8b 100644 --- a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl @@ -72,17 +72,17 @@ published service SheetFilterDescriptor [property] boolean SkipDuplicates; - /** specifies if the <member>TableFilterField::StringValue</member> + /** specifies if the TableFilterField::StringValue strings are interpreted as regular expressions. */ [property] boolean UseRegularExpressions; - /** specifies if the <member>SheetFilterDescriptor::OutputPosition</member> + /** specifies if the SheetFilterDescriptor::OutputPosition position is saved for future calls. <p>This is only used if - <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> + SheetFilterDescriptor::CopyOutputData is <TRUE/>.</p> */ [property] boolean SaveOutputPosition; @@ -107,7 +107,7 @@ published service SheetFilterDescriptor /** specifies the position where filtered data are to be copied. <p>This is only used if - <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> + SheetFilterDescriptor::CopyOutputData is <TRUE/>.</p> */ [property] com::sun::star::table::CellAddress OutputPosition; diff --git a/offapi/com/sun/star/sheet/SheetSortDescriptor.idl b/offapi/com/sun/star/sheet/SheetSortDescriptor.idl index 46bf46d7de8b..44f0e49f7a09 100644 --- a/offapi/com/sun/star/sheet/SheetSortDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetSortDescriptor.idl @@ -53,7 +53,7 @@ published service SheetSortDescriptor /** specifies which user defined sorting list is used. <p>This property is only used, if - <member>SheetSortDescriptor::IsUserListEnabled</member> is <TRUE/>.</p> + SheetSortDescriptor::IsUserListEnabled is <TRUE/>.</p> */ [property] long UserListIndex; @@ -67,7 +67,7 @@ published service SheetSortDescriptor /** specifies the position where sorted data are to be copied. <p>This property is only used, if - <member>SheetSortDescriptor::CopyOutputData</member> is <TRUE/>.</p> + SheetSortDescriptor::CopyOutputData is <TRUE/>.</p> */ [property] com::sun::star::table::CellAddress OutputPosition; diff --git a/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl b/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl index a70d96189cbe..da9979775ffc 100644 --- a/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl +++ b/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl @@ -60,7 +60,7 @@ published service SheetSortDescriptor2 /** specifies which user defined sorting list is used. <p>This property is only used, if - <member>SheetSortDescriptor::IsUserListEnabled</member> is <TRUE/>.</p> + SheetSortDescriptor::IsUserListEnabled is <TRUE/>.</p> */ [property] long UserListIndex; @@ -74,7 +74,7 @@ published service SheetSortDescriptor2 /** specifies the position where sorted data are to be copied. <p>This property is only used, if - <member>SheetSortDescriptor::CopyOutputData</member> is <TRUE/>.</p> + SheetSortDescriptor::CopyOutputData is <TRUE/>.</p> */ [property] com::sun::star::table::CellAddress OutputPosition; diff --git a/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl b/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl index 5ecab2f89334..8267d684bc12 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl @@ -54,7 +54,7 @@ published service SpreadsheetDocumentSettings /** specifies how many iterations are carried out. <p>This setting is only used, if iteration is enabled using - <member>SpreadsheetDocumentSettings::IsIterationEnabled</member>.</p> + SpreadsheetDocumentSettings::IsIterationEnabled.</p> */ [property] long IterationCount; @@ -68,7 +68,7 @@ published service SpreadsheetDocumentSettings is stopped.</p> <p>This setting is only used, if iteration is enabled using - <member>SpreadsheetDocumentSettings::IsIterationEnabled</member>.</p> + SpreadsheetDocumentSettings::IsIterationEnabled.</p> */ [property] double IterationEpsilon; diff --git a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl index 7ef7fcba962c..4bb1d6cd19fd 100644 --- a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl +++ b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl @@ -78,7 +78,7 @@ published service SubTotalDescriptor /** specifies which user defined sorting list is used. <p>This property is only used if - <member>SubTotalDescriptor::EnableUserSortList</member> + SubTotalDescriptor::EnableUserSortList is <TRUE/>.</p> */ [property] long UserSortListIndex; @@ -96,7 +96,7 @@ published service SubTotalDescriptor /** specifies the sorting order if - <member>SubTotalDescriptor::EnableSort</member> is set to <TRUE/>. + SubTotalDescriptor::EnableSort is set to <TRUE/>. */ [property] boolean SortAscending; diff --git a/offapi/com/sun/star/sheet/TableAutoFormatField.idl b/offapi/com/sun/star/sheet/TableAutoFormatField.idl index deda1343606b..29fcd9c22135 100644 --- a/offapi/com/sun/star/sheet/TableAutoFormatField.idl +++ b/offapi/com/sun/star/sheet/TableAutoFormatField.idl @@ -183,7 +183,7 @@ published service TableAutoFormatField /** is <TRUE/> if the cell background is transparent. - <p>In this case the <member>TableAutoFormatField::CellBackColor</member> + <p>In this case the TableAutoFormatField::CellBackColor value is not used.</p> */ [property] boolean IsCellBackgroundTransparent; diff --git a/offapi/com/sun/star/sheet/TableFilterField.idl b/offapi/com/sun/star/sheet/TableFilterField.idl index b644ccf781ca..2f259ccbb20f 100644 --- a/offapi/com/sun/star/sheet/TableFilterField.idl +++ b/offapi/com/sun/star/sheet/TableFilterField.idl @@ -49,8 +49,8 @@ published struct TableFilterField FilterOperator Operator; - /** selects whether the <member>TableFilterField::NumericValue</member> - or the <member>TableFilterField::StringValue</member> is used. + /** selects whether the TableFilterField::NumericValue + or the TableFilterField::StringValue is used. */ boolean IsNumeric; diff --git a/offapi/com/sun/star/sheet/TableFilterField2.idl b/offapi/com/sun/star/sheet/TableFilterField2.idl index 239b1fee5303..7c3fcaba0e6e 100644 --- a/offapi/com/sun/star/sheet/TableFilterField2.idl +++ b/offapi/com/sun/star/sheet/TableFilterField2.idl @@ -55,8 +55,8 @@ published struct TableFilterField2 long Operator; - /** selects whether the <member>TableFilterField2::NumericValue</member> - or the <member>TableFilterField2::StringValue</member> is used. + /** selects whether the TableFilterField2::NumericValue + or the TableFilterField2::StringValue is used. */ boolean IsNumeric; diff --git a/offapi/com/sun/star/sheet/TableValidation.idl b/offapi/com/sun/star/sheet/TableValidation.idl index 2ad848e2cf58..4e3c1b9a4066 100644 --- a/offapi/com/sun/star/sheet/TableValidation.idl +++ b/offapi/com/sun/star/sheet/TableValidation.idl @@ -52,7 +52,7 @@ published service TableValidation /** specifies the title of the window showing the input message. - <p>This is only used if <member>TableValidation::ShowInputMessage</member> + <p>This is only used if TableValidation::ShowInputMessage is set to <TRUE/>.</p> */ [property] string InputTitle; @@ -60,7 +60,7 @@ published service TableValidation /** specifies the text of the input message. - <p>This is only used if <member>TableValidation::ShowInputMessage</member> + <p>This is only used if TableValidation::ShowInputMessage is set to <TRUE/>.</p> */ [property] string InputMessage; @@ -74,7 +74,7 @@ published service TableValidation /** specifies the title of the window showing the error message. - <p>This is only used if <member>TableValidation::ShowErrorMessage</member> + <p>This is only used if TableValidation::ShowErrorMessage is set to <TRUE/>.</p> */ [property] string ErrorTitle; @@ -82,7 +82,7 @@ published service TableValidation /** specifies the text of the error message. - <p>This is only used if <member>TableValidation::ShowErrorMessage</member> + <p>This is only used if TableValidation::ShowErrorMessage is set to <TRUE/>.</p> */ [property] string ErrorMessage; @@ -95,7 +95,7 @@ published service TableValidation /** specifies the style of the error message. - <p>This is used only if <member>TableValidation::ShowErrorMessage</member> + <p>This is used only if TableValidation::ShowErrorMessage is set to <TRUE/>.</p> */ [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle; diff --git a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl index cadfeca1f363..5cf7200c44c5 100644 --- a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl +++ b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl @@ -45,9 +45,9 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface groups.</p> <p>The collection of groups can be accessed via the - <member>DataPilotField::GroupInfo</member> property. The returned + DataPilotField::GroupInfo property. The returned struct contains the sequence of groups in its member - <member>DataPilotFieldGroupInfo::Groups</member>.</p> + DataPilotFieldGroupInfo::Groups.</p> @param aItems a sequence containing the names of the items (members) which will @@ -84,7 +84,7 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface DataPilotFieldGroupInfo::Start</member> must be a floating-point value representing a valid date/time value (if <member> DataPilotFieldGroupInfo::HasAutoStart</member> is set to <TRUE/>, - the value of <member>DataPilotFieldGroupInfo::Start</member> will + the value of DataPilotFieldGroupInfo::Start will be ignored).</li> <li>If the member <member>DataPilotFieldGroupInfo::HasAutoEnd @@ -92,29 +92,29 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface DataPilotFieldGroupInfo::End</member> must be a floating-point value representing a valid date/time value( if <member> DataPilotFieldGroupInfo::HasAutoEnd</member> is set to <TRUE/>, - the value of <member>DataPilotFieldGroupInfo::End</member> will be + the value of DataPilotFieldGroupInfo::End will be ignored).</li> <li>If the members <member>DataPilotFieldGroupInfo::HasAutoStart - </member> and <member>DataPilotFieldGroupInfo::HasAutoEnd</member> + </member> and DataPilotFieldGroupInfo::HasAutoEnd are set to <FALSE/> both, then the value of <member> DataPilotFieldGroupInfo::Start</member> must be less than or equal - to the value of <member>DataPilotFieldGroupInfo::End</member>.</li> + to the value of DataPilotFieldGroupInfo::End.</li> - <li>The member <member>DataPilotFieldGroupInfo::HasDateValues</member> + <li>The member DataPilotFieldGroupInfo::HasDateValues must be set to <TRUE/>.</li> - <li>The member <member>DataPilotFieldGroupInfo::Step</member> must + <li>The member DataPilotFieldGroupInfo::Step must be zero, unless ranges of days have to be grouped (see the description of the member GroupBy below), in that case the value must be greater than or equal to 1 and less than or equal to 32767. The fractional part of the value will be ignored.</li> - <li>The member <member>DataPilotFieldGroupInfo::GroupBy</member> + <li>The member DataPilotFieldGroupInfo::GroupBy must contain exactly one of the flags from DataPilotFieldGroupBy. A combination of several flags will not be accepted. If <const>DataPilotFieldGroupBy::DAYS</const> is specified, the - value of the member <member>DataPilotFieldGroupInfo::Step</member> + value of the member DataPilotFieldGroupInfo::Step will specify the type of day grouping (see above). If that value is zero, grouping is performed on all days of the year (e.g. the members containing the 1st of January of any year are grouped diff --git a/offapi/com/sun/star/sheet/XDatabaseRange.idl b/offapi/com/sun/star/sheet/XDatabaseRange.idl index 882e29387cdf..6a8d753bbaa7 100644 --- a/offapi/com/sun/star/sheet/XDatabaseRange.idl +++ b/offapi/com/sun/star/sheet/XDatabaseRange.idl @@ -58,7 +58,7 @@ published interface XDatabaseRange: com::sun::star::uno::XInterface /** returns the filter descriptor stored with the database range. <p>If the filter descriptor is modified, the new filtering is - carried out when <member>XDatabaseRange::refresh()</member> is + carried out when XDatabaseRange::refresh() is called.</p> @see SheetFilterDescriptor @@ -69,7 +69,7 @@ published interface XDatabaseRange: com::sun::star::uno::XInterface /** returns the subtotal descriptor stored with the database range. <p>If the subtotal descriptor is modified, the new subtotals are - inserted when <member>XDatabaseRange::refresh()</member> is + inserted when XDatabaseRange::refresh() is called.</p> @see SubTotalDescriptor diff --git a/offapi/com/sun/star/sheet/XExternalSheetCache.idl b/offapi/com/sun/star/sheet/XExternalSheetCache.idl index 3f45c6c0a4e9..d386bf4dcba1 100644 --- a/offapi/com/sun/star/sheet/XExternalSheetCache.idl +++ b/offapi/com/sun/star/sheet/XExternalSheetCache.idl @@ -72,7 +72,7 @@ interface XExternalSheetCache usage in formula tokens. <p>This index to the external sheet cache is expected in the - <member>SingleReference::Sheet</member> member if it is part of an + SingleReference::Sheet member if it is part of an external reference token. <p>Each external sheet cache has a unique index value inside the diff --git a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl index cbb00198e746..4d46ed1beee1 100644 --- a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl +++ b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl @@ -71,7 +71,7 @@ interface XFormulaOpCodeMapper <p>Each string element in parameter Names according to the formula language in parameter Language is mapped to a <type>FormulaToken </type> containing the internal OpCode used by the spreadsheet - application in <member>FormulaToken::OpCode</member> and by + application in FormulaToken::OpCode and by contract maybe additional information in <member> FormulaToken::Data</member>.</p> @@ -81,7 +81,7 @@ interface XFormulaOpCodeMapper <p>An unknown Name string gets the OpCode value of <member> OpCodeUnknown</member> assigned.</p> - <p>Additional information in <member>FormulaToken::Data</member> + <p>Additional information in FormulaToken::Data is returned for: <ul> <li>Add-in names: the programmatic name. The OpCode value used @@ -115,7 +115,7 @@ interface XFormulaOpCodeMapper mapped to a FormulaToken containing the internal OpCode used by the spreadsheet application in <member> FormulaToken::OpCode</member> and by contract maybe additional - information in <member>FormulaToken::Data</member>. See <member> + information in FormulaToken::Data. See <member> getMappings</member> for more details.</p> */ sequence< FormulaOpCodeMapEntry > getAvailableMappings( diff --git a/offapi/com/sun/star/sheet/XNamedRanges.idl b/offapi/com/sun/star/sheet/XNamedRanges.idl index e393be77c2e4..42d54e08a4f2 100644 --- a/offapi/com/sun/star/sheet/XNamedRanges.idl +++ b/offapi/com/sun/star/sheet/XNamedRanges.idl @@ -74,7 +74,7 @@ published interface XNamedRanges: com::sun::star::container::XNameAccess part of the original range, excluding the labels.</p> <p>Example: The source range is A1:B3. The named ranges shall be - created using row titles. This requires <member>Border::TOP</member> + created using row titles. This requires Border::TOP for the second parameter. The method creates two named ranges. The name of the first is equal to the content of cell A1 and contains the range $Sheet.$A$2:$A$3 (excluding the title cell). The latter named diff --git a/offapi/com/sun/star/sheet/XViewFreezable.idl b/offapi/com/sun/star/sheet/XViewFreezable.idl index a63d47dcfd1b..897ae915a46c 100644 --- a/offapi/com/sun/star/sheet/XViewFreezable.idl +++ b/offapi/com/sun/star/sheet/XViewFreezable.idl @@ -35,8 +35,8 @@ published interface XViewFreezable: com::sun::star::uno::XInterface /** returns <TRUE/> if the view has frozen panes. <p>Only one of - <member>XViewSplitable::getIsWindowSplit()</member> and - <member>XViewFreezable::hasFrozenPanes()</member> + XViewSplitable::getIsWindowSplit() and + XViewFreezable::hasFrozenPanes() can be <TRUE/>.</p> */ boolean hasFrozenPanes(); diff --git a/offapi/com/sun/star/sheet/XViewSplitable.idl b/offapi/com/sun/star/sheet/XViewSplitable.idl index 33a778edc54a..bc833c015bc6 100644 --- a/offapi/com/sun/star/sheet/XViewSplitable.idl +++ b/offapi/com/sun/star/sheet/XViewSplitable.idl @@ -37,8 +37,8 @@ published interface XViewSplitable: com::sun::star::uno::XInterface into individual panes. <p>Only one of - <member>XViewSplitable::getIsWindowSplit()</member> and - <member>XViewFreezable::hasFrozenPanes()</member> + XViewSplitable::getIsWindowSplit() and + XViewFreezable::hasFrozenPanes() can be <TRUE/>.</p> */ boolean getIsWindowSplit(); diff --git a/offapi/com/sun/star/style/PageProperties.idl b/offapi/com/sun/star/style/PageProperties.idl index 2bb5d1faaad7..8847d3ca54a4 100644 --- a/offapi/com/sun/star/style/PageProperties.idl +++ b/offapi/com/sun/star/style/PageProperties.idl @@ -56,7 +56,7 @@ published service PageProperties /** determines if the background color is transparent. <p>If this property is set to <TRUE/>, - <member>PageStyle::BackColor</member> will not be used.</p> + PageStyle::BackColor will not be used.</p> */ [property] boolean BackTransparent; /** determines the left margin of the page. @@ -160,7 +160,7 @@ published service PageProperties /** determines if the background color of the header is transparent. <p>If this property is set to <TRUE/>, - <member>PageStyle::HeaderBackColor</member> will not be used.</p> + PageStyle::HeaderBackColor will not be used.</p> */ [property, maybevoid] boolean HeaderBackTransparent; /** determines the style of the left border line of the header. diff --git a/offapi/com/sun/star/style/ParagraphProperties.idl b/offapi/com/sun/star/style/ParagraphProperties.idl index a44a6ca24c30..2ddc7e4f68b7 100644 --- a/offapi/com/sun/star/style/ParagraphProperties.idl +++ b/offapi/com/sun/star/style/ParagraphProperties.idl @@ -79,7 +79,7 @@ published service ParagraphProperties /** determines the adjustment of the last line. - <p>It is only valid if <member>ParagraphProperties::ParaAdjust</member> + <p>It is only valid if ParagraphProperties::ParaAdjust is set to <const>ParagraphAdjust::BLOCK</const>.</p> */ [property] short ParaLastLineAdjust; @@ -87,8 +87,8 @@ published service ParagraphProperties /** determines if single words are stretched. - <p>It is only valid if <member>ParagraphProperties::ParaAdjust</member> and - <member>ParagraphProperties::ParaLastLineAdjust</member> are also valid.</p> + <p>It is only valid if ParagraphProperties::ParaAdjust and + ParagraphProperties::ParaLastLineAdjust are also valid.</p> */ [optional, property] boolean ParaExpandSingleWord; diff --git a/offapi/com/sun/star/table/CellProperties.idl b/offapi/com/sun/star/table/CellProperties.idl index 5a8b7fd5db6b..ce79775d028d 100644 --- a/offapi/com/sun/star/table/CellProperties.idl +++ b/offapi/com/sun/star/table/CellProperties.idl @@ -63,7 +63,7 @@ published service CellProperties /** is <TRUE/>, if the cell background is transparent. - <p>In this case the <member>CellProperties::CellBackColor</member> + <p>In this case the CellProperties::CellBackColor value is not used.</p> */ [property] boolean IsCellBackgroundTransparent; @@ -96,7 +96,7 @@ published service CellProperties /** contains the orientation of the cell contents. - <p>If the <member>CellProperties::RotateAngle</member> property + <p>If the CellProperties::RotateAngle property is non-zero, this value is not used.</p> */ [property] com::sun::star::table::CellOrientation Orientation; @@ -118,11 +118,11 @@ published service CellProperties /** selects Asian character orientation in vertical orientation. - <p>If the <member>CellProperties::Orientation</member> property is + <p>If the CellProperties::Orientation property is <const>CellOrientation::STACKED</const>, in Asian mode only Asian characters are printed in horizontal orientation instead of all characters. - For other values of <member>CellProperties::Orientation</member>, + For other values of CellProperties::Orientation, this value is not used.</p> */ [optional, property] boolean AsianVerticalMode; diff --git a/offapi/com/sun/star/table/TableBorder.idl b/offapi/com/sun/star/table/TableBorder.idl index be6f65deefb4..be994d401e01 100644 --- a/offapi/com/sun/star/table/TableBorder.idl +++ b/offapi/com/sun/star/table/TableBorder.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module table { range. <p>In a queried structure, the flags in - <member>TableBorder::Is...LineValid</member> indicate that not all + TableBorder::Is...LineValid indicate that not all lines of the boxes have the same values.</p> <p>In a structure which is used for setting, these flags determine @@ -45,7 +45,7 @@ published struct TableBorder com::sun::star::table::BorderLine TopLine; - /** specifies whether the value of <member>TableBorder::TopLine</member> + /** specifies whether the value of TableBorder::TopLine is used. */ boolean IsTopLineValid; @@ -57,7 +57,7 @@ published struct TableBorder /** specifies whether the value of - <member>TableBorder::BottomLine</member> is used. + TableBorder::BottomLine is used. */ boolean IsBottomLineValid; @@ -67,7 +67,7 @@ published struct TableBorder com::sun::star::table::BorderLine LeftLine; - /** specifies whether the value of <member>TableBorder::LeftLine</member> + /** specifies whether the value of TableBorder::LeftLine is used. */ boolean IsLeftLineValid; @@ -78,7 +78,7 @@ published struct TableBorder com::sun::star::table::BorderLine RightLine; - /** specifies whether the value of <member>TableBorder::RightLine</member> + /** specifies whether the value of TableBorder::RightLine is used. */ boolean IsRightLineValid; @@ -91,7 +91,7 @@ published struct TableBorder /** specifies whether the value of - <member>TableBorder::HorizontalLine</member> is used. + TableBorder::HorizontalLine is used. */ boolean IsHorizontalLineValid; @@ -103,7 +103,7 @@ published struct TableBorder /** specifies whether the value of - <member>TableBorder::VerticalLine</member> is used. + TableBorder::VerticalLine is used. */ boolean IsVerticalLineValid; @@ -113,7 +113,7 @@ published struct TableBorder short Distance; - /** specifies whether the value of <member>TableBorder::Distance</member> + /** specifies whether the value of TableBorder::Distance is used. */ boolean IsDistanceValid; diff --git a/offapi/com/sun/star/table/TableBorder2.idl b/offapi/com/sun/star/table/TableBorder2.idl index 554f5f7f9cb0..611569018f6a 100644 --- a/offapi/com/sun/star/table/TableBorder2.idl +++ b/offapi/com/sun/star/table/TableBorder2.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module table { BorderLine. <p>In a queried structure, the flags in - <member>TableBorder2::Is...LineValid</member> indicate that not all + TableBorder2::Is...LineValid indicate that not all lines of the boxes have the same values.</p> <p>In a structure which is used for setting, these flags determine @@ -42,7 +42,7 @@ published struct TableBorder2 /** specifies whether the value of - <member>TableBorder2::TopLine</member> is used. + TableBorder2::TopLine is used. */ boolean IsTopLineValid; @@ -53,7 +53,7 @@ published struct TableBorder2 /** specifies whether the value of - <member>TableBorder2::BottomLine</member> is used. + TableBorder2::BottomLine is used. */ boolean IsBottomLineValid; @@ -64,7 +64,7 @@ published struct TableBorder2 /** specifies whether the value of - <member>TableBorder2::LeftLine</member> is used. + TableBorder2::LeftLine is used. */ boolean IsLeftLineValid; @@ -75,7 +75,7 @@ published struct TableBorder2 /** specifies whether the value of - <member>TableBorder2::RightLine</member> is used. + TableBorder2::RightLine is used. */ boolean IsRightLineValid; @@ -87,7 +87,7 @@ published struct TableBorder2 /** specifies whether the value of - <member>TableBorder2::HorizontalLine</member> is used. + TableBorder2::HorizontalLine is used. */ boolean IsHorizontalLineValid; @@ -99,7 +99,7 @@ published struct TableBorder2 /** specifies whether the value of - <member>TableBorder2::VerticalLine</member> is used. + TableBorder2::VerticalLine is used. */ boolean IsVerticalLineValid; @@ -110,7 +110,7 @@ published struct TableBorder2 /** specifies whether the value of - <member>TableBorder2::Distance</member> is used. + TableBorder2::Distance is used. */ boolean IsDistanceValid; diff --git a/offapi/com/sun/star/table/TableBorderDistances.idl b/offapi/com/sun/star/table/TableBorderDistances.idl index ef0ac952708f..9c959b8e3eef 100644 --- a/offapi/com/sun/star/table/TableBorderDistances.idl +++ b/offapi/com/sun/star/table/TableBorderDistances.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module table { range. <p>In a queried structure, the flags in - <member>TableBorderDistances::Is...DistanceValid</member> indicate that not all + TableBorderDistances::Is...DistanceValid indicate that not all lines of the boxes have the same values.</p> <p>In a structure which is used for setting, these flags determine @@ -45,7 +45,7 @@ published struct TableBorderDistances short TopDistance; - /** specifies whether the value of <member>TableBorder::TopDistance</member> + /** specifies whether the value of TableBorder::TopDistance is used. */ boolean IsTopDistanceValid; @@ -55,7 +55,7 @@ published struct TableBorderDistances short BottomDistance; - /** specifies whether the value of <member>TableBorder::BottomDistance</member> + /** specifies whether the value of TableBorder::BottomDistance is used. */ boolean IsBottomDistanceValid; @@ -65,7 +65,7 @@ published struct TableBorderDistances short LeftDistance; - /** specifies whether the value of <member>TableBorder::LeftDistance</member> + /** specifies whether the value of TableBorder::LeftDistance is used. */ boolean IsLeftDistanceValid; @@ -75,7 +75,7 @@ published struct TableBorderDistances short RightDistance; - /** specifies whether the value of <member>TableBorder::RightDistance</member> + /** specifies whether the value of TableBorder::RightDistance is used. */ boolean IsRightDistanceValid; diff --git a/offapi/com/sun/star/table/XCell.idl b/offapi/com/sun/star/table/XCell.idl index 46c47494145d..d236022f6a4e 100644 --- a/offapi/com/sun/star/table/XCell.idl +++ b/offapi/com/sun/star/table/XCell.idl @@ -68,7 +68,7 @@ published interface XCell: com::sun::star::uno::XInterface /** sets a floating point value into the cell. <p>After a call to this method the type of the cell is - <member>CellContentType::VALUE</member>.</p> + CellContentType::VALUE.</p> */ void setValue( [in] double nValue ); diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl index 5f00ce4e9dd8..cd5a16ea8d24 100644 --- a/offapi/com/sun/star/task/XAsyncJob.idl +++ b/offapi/com/sun/star/task/XAsyncJob.idl @@ -52,7 +52,7 @@ published interface XAsyncJob : com::sun::star::uno::XInterface a concrete implementation of a job specifies in its service descriptions which parameters are allowed (or expected). This values are persistent by the configuration of the JobExecutor which use this asynchronous job. It's possible to write it back by called listener - function <member>XJobListener::jobFinished()</member>. + function XJobListener::jobFinished(). @param Listener specifies a listener which should be notified on events. May be <NULL/>. diff --git a/offapi/com/sun/star/task/XJobListener.idl b/offapi/com/sun/star/task/XJobListener.idl index 151b729c7f01..0bdbf4db4f6c 100644 --- a/offapi/com/sun/star/task/XJobListener.idl +++ b/offapi/com/sun/star/task/XJobListener.idl @@ -38,7 +38,7 @@ published interface XJobListener : com::sun::star::lang::XEventListener can differ between more then ones. @param Result - should be the same like for the synchronous mode on <member>XJob::execute()</member>. + should be the same like for the synchronous mode on XJob::execute(). It provides information about success or failure of job execution. It's possible too, to use special protocol (which depends from real implementation) between JobExecutor and a real job. So it can be possible to: diff --git a/offapi/com/sun/star/task/XStatusIndicator.idl b/offapi/com/sun/star/task/XStatusIndicator.idl index a5e471de864a..2ab62347636e 100644 --- a/offapi/com/sun/star/task/XStatusIndicator.idl +++ b/offapi/com/sun/star/task/XStatusIndicator.idl @@ -39,7 +39,7 @@ published interface XStatusIndicator: com::sun::star::uno::XInterface <p> It activates a new created or reactivate an already used indicator - (must be finished by calling <member>XStatusIndicator::end()</member> + (must be finished by calling XStatusIndicator::end() before!). By the way it's possible to set first progress description and the possible range of progress value. That means that a progress can runs from 0 to <var>Range</var>. @@ -47,11 +47,11 @@ published interface XStatusIndicator: com::sun::star::uno::XInterface @param Text initial value for progress description for showing - Value can be updated by calling <member>XStatusIndicator::setText()</member>. + Value can be updated by calling XStatusIndicator::setText(). @param Range means the maximum value of the progress which can be set by - calling <member>XStatusIndicator::setValue()</member>. + calling XStatusIndicator::setValue(). */ void start( [in] string Text, @@ -60,10 +60,10 @@ published interface XStatusIndicator: com::sun::star::uno::XInterface /** stop the progress <p> - Further calls of <member>XStatusIndicator::setText()</member>, - <member>XStatusIndicator::setValue()</member> or - <member>XStatusIndicator::reset()</member> must be ignored. - Only <member>XStatusIndicator::start()</member> can reactivate this + Further calls of XStatusIndicator::setText(), + XStatusIndicator::setValue() or + XStatusIndicator::reset() must be ignored. + Only XStatusIndicator::start() can reactivate this indicator. It's not allowed to destruct the indicator inside this method. The instance must be gone by using ref count or disposing. @@ -75,7 +75,7 @@ published interface XStatusIndicator: com::sun::star::uno::XInterface <p> Initial value can be set during starting of the progress by calling - <member>XStatusIndicator::start()</member>. + XStatusIndicator::start(). Stopped indicators must ignore this call. </p> @@ -94,7 +94,7 @@ published interface XStatusIndicator: com::sun::star::uno::XInterface @param Value new value for progress which should be shown now Must fit the range [0..Range] which was set during - <member>XStatusIndicator::start()</member>. + XStatusIndicator::start(). */ void setValue( [in] long Value ); diff --git a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl index 7d6e050d35c1..6162744f02b1 100644 --- a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl +++ b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl @@ -32,7 +32,7 @@ */ published interface XStatusIndicatorSupplier: com::sun::star::uno::XInterface { - /** use <member>XStatusIndicatorFactory::createStatusIndicator()</member> + /** use XStatusIndicatorFactory::createStatusIndicator() instead of this @deprecated diff --git a/offapi/com/sun/star/text/BaseFrame.idl b/offapi/com/sun/star/text/BaseFrame.idl index c840d081e8ba..e989abbc425a 100644 --- a/offapi/com/sun/star/text/BaseFrame.idl +++ b/offapi/com/sun/star/text/BaseFrame.idl @@ -47,7 +47,7 @@ published service BaseFrame (e.g., due to a revised layout of the surrounding text). <p>The position is relative to the position of the anchor - [see <member>XTextFrame::getAnchor()</member>]. Size and position are + [see XTextFrame::getAnchor()]. Size and position are both measured in 100th mm. The size is not valid if the size is relative and no layout exists or if the layout is invalid. diff --git a/offapi/com/sun/star/text/BaseFrameProperties.idl b/offapi/com/sun/star/text/BaseFrameProperties.idl index 53de2bdae3bb..c6c9985d5e36 100644 --- a/offapi/com/sun/star/text/BaseFrameProperties.idl +++ b/offapi/com/sun/star/text/BaseFrameProperties.idl @@ -140,12 +140,12 @@ published service BaseFrameProperties [property] long BottomMargin; /** contains the height of the object (1/100 mm). - <p>It is only valid if <member>TextEmbeddedObject::RelativeHeight</member> is zero.</p> + <p>It is only valid if TextEmbeddedObject::RelativeHeight is zero.</p> */ [property] long Height; /** contains the width of the object (1/100 mm). - <p>It is only valid if <member>TextEmbeddedObject::RelativeWidth</member> is zero.</p> + <p>It is only valid if TextEmbeddedObject::RelativeWidth is zero.</p> */ [property] long Width; /** contains the relative height of the object. @@ -188,7 +188,7 @@ published service BaseFrameProperties /** contains the vertical position of the object (1/100 mm). - It is only valid if <member>TextEmbeddedObject::VertOrient</member> is + It is only valid if TextEmbeddedObject::VertOrient is <const>VertOrientation::NONE</const>. */ [property] long VertOrientPosition; diff --git a/offapi/com/sun/star/text/DocumentSettings.idl b/offapi/com/sun/star/text/DocumentSettings.idl index 5bf7ca35eb2c..5eadbd26c2b5 100644 --- a/offapi/com/sun/star/text/DocumentSettings.idl +++ b/offapi/com/sun/star/text/DocumentSettings.idl @@ -154,7 +154,7 @@ published service DocumentSettings fly frames and drawing objects) are positioned. If <TRUE/>, the object positioning algorithm will consider the text wrap style, set at the floating screen object. - The attribute <member>BaseFrameProperties::WrapInfluenceOnPosition</member> + The attribute BaseFrameProperties::WrapInfluenceOnPosition specifies how the text wrap is considered. If <FALSE/> (default value), the former object positioning algorithm (known from OpenOffice.org 1.1) is applied.</p> diff --git a/offapi/com/sun/star/text/SectionFileLink.idl b/offapi/com/sun/star/text/SectionFileLink.idl index 4744ea1d5cc2..aad3e2b5ac62 100644 --- a/offapi/com/sun/star/text/SectionFileLink.idl +++ b/offapi/com/sun/star/text/SectionFileLink.idl @@ -36,9 +36,9 @@ into the given text section. </p> <p> - <member>SectionFileLink::FilterName</member> is the internal name of + SectionFileLink::FilterName is the internal name of the document filter. To use this struct, it is not necessary to set - <member>SectionFileLink::FilterName</member>. It will be automatically + SectionFileLink::FilterName. It will be automatically assigned.</p> */ published struct SectionFileLink diff --git a/offapi/com/sun/star/text/Shape.idl b/offapi/com/sun/star/text/Shape.idl index ce134226c532..9ae89d198ea2 100644 --- a/offapi/com/sun/star/text/Shape.idl +++ b/offapi/com/sun/star/text/Shape.idl @@ -75,7 +75,7 @@ published service Shape /** contains the vertical position of the object (1/100 mm). - It is only valid if <member>TextEmbeddedObject::VertOrient</member> is + It is only valid if TextEmbeddedObject::VertOrient is <const>VertOrientation::NONE</const>. */ [property] long VertOrientPosition; diff --git a/offapi/com/sun/star/text/TableColumnSeparator.idl b/offapi/com/sun/star/text/TableColumnSeparator.idl index e10e58bc96af..7cf308091fc5 100644 --- a/offapi/com/sun/star/text/TableColumnSeparator.idl +++ b/offapi/com/sun/star/text/TableColumnSeparator.idl @@ -40,14 +40,14 @@ number of text columns at the table's position, alignment, and left and right margins). For that reason, the table column separator does not contain metric values for the column widths. The values are relative - to the value of the property <member>TextTable::TableColumnRelativeSum</member>. + to the value of the property TextTable::TableColumnRelativeSum. </p> <p>A table provides this property only if all rows have the same structure. If the table does not provide the property, then it cannot be set using. </p> - <p>The state of <member>TableColumnSeparator::IsVisible</member> and the + <p>The state of TableColumnSeparator::IsVisible and the count of the sequence must be the same in as it was in. Hidden separators cannot be moved and they cannot be overtaken by visible separators.</p> diff --git a/offapi/com/sun/star/text/TextSection.idl b/offapi/com/sun/star/text/TextSection.idl index 33cd1b68b316..51ea83e94bd5 100644 --- a/offapi/com/sun/star/text/TextSection.idl +++ b/offapi/com/sun/star/text/TextSection.idl @@ -57,7 +57,7 @@ published service TextSection /** This property contains a conditional expression. <p>If the result of the conditional expression is <true/> and the property - <member>TextSection::IsVisible</member> is <false/>, then the section is hidden.</p> + TextSection::IsVisible is <false/>, then the section is hidden.</p> */ [property] string Condition; @@ -77,12 +77,12 @@ published service TextSection [property] com::sun::star::text::SectionFileLink FileLink; /** specifies the source of a file link in the document that is - specified in <member>TextSection::FileLink</member>. + specified in TextSection::FileLink. <p>The source may be a text section or a bookmark. - If <member>TextSection::FileLink</member> is empty, then the + If TextSection::FileLink is empty, then the current document is searched for the source. If this property - is empty and <member>TextSection::FileLink</member> is set, + is empty and TextSection::FileLink is set, then the complete document content is linked into this section.</p> */ [property] string LinkRegion; diff --git a/offapi/com/sun/star/ucb/ContentEvent.idl b/offapi/com/sun/star/ucb/ContentEvent.idl index 54e3ff075358..bc5a740234c1 100644 --- a/offapi/com/sun/star/ucb/ContentEvent.idl +++ b/offapi/com/sun/star/ucb/ContentEvent.idl @@ -45,19 +45,19 @@ published struct ContentEvent: com::sun::star::lang::EventObject <table border=1> <tr align=left> - <td><member>ContentAction::INSERTED</member></td> + <td>ContentAction::INSERTED</td> <td>The content inserted into a folder</td> </tr> <tr align=left> - <td><member>ContentAction::REMOVED</member></td> + <td>ContentAction::REMOVED</td> <td>The content removed from a folder</td> </tr> <tr align=left> - <td><member>ContentAction::DELETED</member></td> + <td>ContentAction::DELETED</td> <td>The deleted content</td> </tr> <tr align=left> - <td><member>ContentAction::EXCHANGED</member></td> + <td>ContentAction::EXCHANGED</td> <td>The exchanged content (that already has the new content id)</td> </tr> </table> @@ -72,19 +72,19 @@ published struct ContentEvent: com::sun::star::lang::EventObject <table border=1> <tr align=left> - <td><member>ContentAction::INSERTED</member></td> + <td>ContentAction::INSERTED</td> <td>Id of the folder the content was inserted into</td> </tr> <tr align=left> - <td><member>ContentAction::REMOVED</member></td> + <td>ContentAction::REMOVED</td> <td>Id of the folder the content was removed from</td> </tr> <tr align=left> - <td><member>ContentAction::DELETED</member></td> + <td>ContentAction::DELETED</td> <td>Id of the deleted content</td> </tr> <tr align=left> - <td><member>ContentAction::EXCHANGED</member></td> + <td>ContentAction::EXCHANGED</td> <td>Previous(!) id of the exchanged content</td> </tr> </table> diff --git a/offapi/com/sun/star/ucb/ContentInfoAttribute.idl b/offapi/com/sun/star/ucb/ContentInfoAttribute.idl index 5861c8c5c56b..ac12077974bb 100644 --- a/offapi/com/sun/star/ucb/ContentInfoAttribute.idl +++ b/offapi/com/sun/star/ucb/ContentInfoAttribute.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { -/** These are the possible values for <member>ContentInfo::Attributes</member>. +/** These are the possible values for ContentInfo::Attributes. */ published constants ContentInfoAttribute { diff --git a/offapi/com/sun/star/ucb/ContentResultSet.idl b/offapi/com/sun/star/ucb/ContentResultSet.idl index ad8a5ea92394..542a485d80e8 100644 --- a/offapi/com/sun/star/ucb/ContentResultSet.idl +++ b/offapi/com/sun/star/ucb/ContentResultSet.idl @@ -106,10 +106,10 @@ published service ContentResultSet <p>There are two possible travel modes: <p><table border=1> - <tr><td><member>CursorTravelMode::BLOCKING</member></td> + <tr><td>CursorTravelMode::BLOCKING</td> <td>Each travel method of the result set will not return until the data for the new position were retrieved.</td></tr> - <tr><td><member>CursorTravelMode::NONBLOCKING</member></td> + <tr><td>CursorTravelMode::NONBLOCKING</td> <td>The implementation will throw a <code>CursorWouldBlockException</code>, if the data for the new position are not retrieved yet.</td></tr> @@ -157,7 +157,7 @@ published service ContentResultSet <p> The implementation initially needs to set the value of this property - to <member>CursorTravelMode::BLOCKING</member>. + to CursorTravelMode::BLOCKING. </p> @see CursorTravelMode diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index 06a9181fbf1b..b82cf8cc7a09 100644 --- a/offapi/com/sun/star/ucb/FetchResult.idl +++ b/offapi/com/sun/star/ucb/FetchResult.idl @@ -38,21 +38,21 @@ published struct FetchResult sequence< any > Rows; /** indicates the index of the first row contained in - <member>FetchResult::Rows</member> in the original result set. So if - <member>FetchResult::StartIndex</member> equals <code>3</code>, the - first element in the sequence <member>FetchResult::Rows</member> + FetchResult::Rows in the original result set. So if + FetchResult::StartIndex equals <code>3</code>, the + first element in the sequence FetchResult::Rows contains the data of the index <code>3</code> in the original result set. <p>The following rows are one after the other, but the direction - depends on the value of <member>FetchResult::Direction</member> + depends on the value of FetchResult::Direction */ long StartIndex; /** indicates the orientation in which the rows are fetched and set into - the sequence <member>FetchResult::Rows</member>. + the sequence FetchResult::Rows. - <p>When <member>FetchResult::Orientation</member> equals <TRUE/>, the - rows in <member>FetchResult::Rows</member> are ordered in the same way + <p>When FetchResult::Orientation equals <TRUE/>, the + rows in FetchResult::Rows are ordered in the same way as in the original result set. */ boolean Orientation; diff --git a/offapi/com/sun/star/ucb/FolderList.idl b/offapi/com/sun/star/ucb/FolderList.idl index a9275f3e60b1..0f9598289c60 100644 --- a/offapi/com/sun/star/ucb/FolderList.idl +++ b/offapi/com/sun/star/ucb/FolderList.idl @@ -35,7 +35,7 @@ published struct FolderList FolderListCommand Command; /** The list of folders (only used in conjunction with - <member>FolderListCommand::SET</member>). + FolderListCommand::SET). */ sequence<FolderListEntry> List; }; diff --git a/offapi/com/sun/star/ucb/FolderListEntry.idl b/offapi/com/sun/star/ucb/FolderListEntry.idl index e17d01e38201..63eb8af2a9be 100644 --- a/offapi/com/sun/star/ucb/FolderListEntry.idl +++ b/offapi/com/sun/star/ucb/FolderListEntry.idl @@ -50,7 +50,7 @@ published struct FolderListEntry boolean Removed; /** The folder shall be purged (only used in conjunction with the - <member>FolderListCommand::SET</member>). + FolderListCommand::SET). */ boolean Purge; }; diff --git a/offapi/com/sun/star/ucb/ListAction.idl b/offapi/com/sun/star/ucb/ListAction.idl index 6b41b3507f32..59d1f4a14eb7 100644 --- a/offapi/com/sun/star/ucb/ListAction.idl +++ b/offapi/com/sun/star/ucb/ListAction.idl @@ -93,8 +93,8 @@ published struct ListAction */ long ListActionType; - /** depending on the content of <member>ListAction::ListActionType</member> - the <member>ListAction::ActionInfo</member> could contain additional + /** depending on the content of ListAction::ListActionType + the ListAction::ActionInfo could contain additional information about the changes happened (see table above). */ diff --git a/offapi/com/sun/star/ucb/ListActionType.idl b/offapi/com/sun/star/ucb/ListActionType.idl index e4f28a3eaf5b..365eb60eb02a 100644 --- a/offapi/com/sun/star/ucb/ListActionType.idl +++ b/offapi/com/sun/star/ucb/ListActionType.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { <p>A change happened is sent from an XDynamicResultSet as ListAction to a XDynamicResultSetListener. - <p>The values are contained in <member>ListAction::ListActionType</member>. + <p>The values are contained in ListAction::ListActionType. */ published constants ListActionType @@ -38,7 +38,7 @@ published constants ListActionType <p>This type of notification is required to be sent first and only once to a new listener. - <p>The member <member>ListAction::ActionInfo</member> is required to + <p>The member ListAction::ActionInfo is required to contain a struct WelcomeDynamicResultSetStruct. This struct contains two com::sun::star::sdbc::XResultSets (old and new). @@ -47,40 +47,40 @@ published constants ListActionType com::sun::star::sdbc::XResultSets as he will not get another chance to get them again. - <p>The members <member>ListAction::Count</member> and - <member>ListAction::Position</member> are not used. + <p>The members ListAction::Count and + ListAction::Position are not used. */ const long WELCOME = 20; /** One or more rows were inserted into the list. - <p>This action is related to <member>ContentAction::INSERTED</member>. + <p>This action is related to ContentAction::INSERTED. - <p>The members <member>ListAction::Count</member> and - <member>ListAction::Position</member> contain the position and count of + <p>The members ListAction::Count and + ListAction::Position contain the position and count of newly inserted rows. If the count is greater than one, the inserted rows have to be one after the other. - <p> <member>ListAction::ActionInfo</member> could contain something but + <p> ListAction::ActionInfo could contain something but this is not required. For example, it could contain the properties of the new rows (i.e. for remote optimizing), but this is not required nor unrestrictedly recommended. <p>@todo ... further description of allowed contents for - <member>ListAction::ActionInfo</member> is needed + ListAction::ActionInfo is needed */ const long INSERTED = 21; /** One or more rows were removed from the list. - <p>This action is related to <member>ContentAction::REMOVED</member>. + <p>This action is related to ContentAction::REMOVED. - <p>The members <member>ListAction::Count</member> and - <member>ListAction::Position</member> contain the position and count of the + <p>The members ListAction::Count and + ListAction::Position contain the position and count of the removed rows. If the count is greater than one, the removed rows have to be one after the other. - <p>The member <member>ListAction::ListActionType</member> is not used. + <p>The member ListAction::ListActionType is not used. */ const long REMOVED = 22; @@ -89,20 +89,20 @@ published constants ListActionType <p>If "CLEARED" is sent you don't need to refer to the old ResultSet. - <p>The members <member>ListAction::ListActionType</member>, - <member>ListAction::Count</member> and <member>ListAction::Position</member> + <p>The members ListAction::ListActionType, + ListAction::Count and ListAction::Position are ignored. */ const long CLEARED = 23; /** One or more rows were moved to another position. - <p>The members <member>ListAction::Count</member> and - <member>ListAction::Position</member> contain the position and count of the + <p>The members ListAction::Count and + ListAction::Position contain the position and count of the moved rows. If the count is greater than one, the moved rows have to be one after the other. - <p><member>ListAction::ListActionType</member> is required to contain a "long", + <p>ListAction::ListActionType is required to contain a "long", which gives the shift of position. (i.e. When two rows at position 3 and 4 are moved for a shift "+1", they will appear at the positions 4 and 5. In this action is included, that @@ -115,18 +115,18 @@ published constants ListActionType <p>This action is related to a com::sun::star::beans::PropertyChangeEvent. - <p>The members <member>ListAction::Count</member> and - <member>ListAction::Position</member> contain the position and count of the + <p>The members ListAction::Count and + ListAction::Position contain the position and count of the rows, whose properties have changed. If the count is greater than one, the rows with modified properties have to be one after the other. - <p> <member>ListAction::ActionInfo</member> could contain something but + <p> ListAction::ActionInfo could contain something but this is not required. For example, it could contain the new properties (i.e. for remote optimizing), but this is not required nor unrestrictedly recommended. <p>@todo ... further description of allowed contents for - <member>ListAction::ActionInfo</member> is needed + ListAction::ActionInfo is needed */ const long PROPERTIES_CHANGED = 25; @@ -136,12 +136,12 @@ published constants ListActionType <p>This action is related to ContentAction == EXCHANGED. - <p>The members <member>ListAction::Count</member> and - <member>ListAction::Position</member> contain the position and count of the + <p>The members ListAction::Count and + ListAction::Position contain the position and count of the rows, whose identity have changed. If the count is greater than one, the rows with changed identity have to be one after the other. - <p><member>ListAction::ListActionType</member> must contain the new identities + <p>ListAction::ListActionType must contain the new identities <p>@todo ... @@ -159,8 +159,8 @@ published constants ListActionType to send "COMPLETED". So a listener has the possibility to wait for "COMPLETED" e.g. to print the full result. ) - <p>The members <member>ListAction::ListActionType</member>, - <member>ListAction::Count</member> and <member>ListAction::Position</member> + <p>The members ListAction::ListActionType, + ListAction::Count and ListAction::Position are useless. */ const long COMPLETED = 27; diff --git a/offapi/com/sun/star/ucb/NameClash.idl b/offapi/com/sun/star/ucb/NameClash.idl index af9573a874c2..75c7a63ff14c 100644 --- a/offapi/com/sun/star/ucb/NameClash.idl +++ b/offapi/com/sun/star/ucb/NameClash.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { -/** These are the possible values for <member>TransferInfo::NameClash</member>. +/** These are the possible values for TransferInfo::NameClash. */ published constants NameClash { diff --git a/offapi/com/sun/star/ucb/OpenMode.idl b/offapi/com/sun/star/ucb/OpenMode.idl index 323cd914ff59..ddd6d7534486 100644 --- a/offapi/com/sun/star/ucb/OpenMode.idl +++ b/offapi/com/sun/star/ucb/OpenMode.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { -/** These are the possible values for <member>OpenCommandArgument::Mode</member>. +/** These are the possible values for OpenCommandArgument::Mode. */ published constants OpenMode { diff --git a/offapi/com/sun/star/ucb/OutgoingMessageState.idl b/offapi/com/sun/star/ucb/OutgoingMessageState.idl index 67749e5e2b60..1cb37f1c8390 100644 --- a/offapi/com/sun/star/ucb/OutgoingMessageState.idl +++ b/offapi/com/sun/star/ucb/OutgoingMessageState.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { -/** These are the possible values for <member>RecipientInfo::State</member>. +/** These are the possible values for RecipientInfo::State. */ published enum OutgoingMessageState { diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl index c38350b07dcd..1252125c1f33 100644 --- a/offapi/com/sun/star/ucb/PackageFolderContent.idl +++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl @@ -191,7 +191,7 @@ published service PackageFolderContent title of the new stream ) and to obtain a Content object for that URL from the UCB. Then let the content execute the command "insert". The command will fail, if you set the command's parameter - <member>InsertCommandArgument::ReplaceExisting"</member> + InsertCommandArgument::ReplaceExisting" to false and there is already a stream with the title given by the content's URL. diff --git a/offapi/com/sun/star/ucb/PropertyValueState.idl b/offapi/com/sun/star/ucb/PropertyValueState.idl index 25ad32b281bb..36c6b0766c22 100644 --- a/offapi/com/sun/star/ucb/PropertyValueState.idl +++ b/offapi/com/sun/star/ucb/PropertyValueState.idl @@ -36,7 +36,7 @@ published enum PropertyValueState /** The value was obtained. - <p>The value is stored in <member>PropertyValueInfo::Value</member>. + <p>The value is stored in PropertyValueInfo::Value. */ PROCESSED, diff --git a/offapi/com/sun/star/ucb/RuleAction.idl b/offapi/com/sun/star/ucb/RuleAction.idl index 1fd616142428..358621409cde 100644 --- a/offapi/com/sun/star/ucb/RuleAction.idl +++ b/offapi/com/sun/star/ucb/RuleAction.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { -/** These are the possible values for <member>Rule::Action</member>. +/** These are the possible values for Rule::Action. @see RuleSet */ @@ -57,12 +57,12 @@ published constants RuleAction */ const short MARKUNREAD = 6; - /** "Move" - Moves object to <member>Rule::Parameter</member> when term + /** "Move" - Moves object to Rule::Parameter when term matches. */ const short MOVE = 7; - /** "Copy" - Copies object to <member>Rule::Parameter</member> when term + /** "Copy" - Copies object to Rule::Parameter when term matches. */ const short COPY = 8; @@ -71,12 +71,12 @@ published constants RuleAction */ const short DELETE = 9; - /** "Link" - Creates a link to <member>Rule::Parameter</member> when term + /** "Link" - Creates a link to Rule::Parameter when term matches. */ const short LINK = 10; - /** "Forward" - Forwards object to <member>Rule::Parameter</member> when + /** "Forward" - Forwards object to Rule::Parameter when term matches. */ const short FORWARD = 11; diff --git a/offapi/com/sun/star/ucb/RuleOperator.idl b/offapi/com/sun/star/ucb/RuleOperator.idl index 4be303ebba43..5eeae547b7b0 100644 --- a/offapi/com/sun/star/ucb/RuleOperator.idl +++ b/offapi/com/sun/star/ucb/RuleOperator.idl @@ -23,37 +23,37 @@ module com { module sun { module star { module ucb { -/** These are the possible values for <member>RuleTerm::RuleOperator</member>. +/** These are the possible values for RuleTerm::RuleOperator. @see RuleSet @see Rule */ published constants RuleOperator { - /** "Contains" - Object contains <member>RuleTerm::Operand</member>. + /** "Contains" - Object contains RuleTerm::Operand. */ const short CONTAINS = 1; /** "ContainsNot" - Object does not contain - <member>RuleTerm::Operand</member>. + RuleTerm::Operand. */ const short CONTAINSNOT = 2; /** "GreaterEqual" - Object is greater than or equal to - <member>RuleTerm::Operand</member>. + RuleTerm::Operand. */ const short GREATEREQUAL = 3; /** "LessEqual" - Object is less than or equal to - <member>RuleTerm::Operand</member>. + RuleTerm::Operand. */ const short LESSEQUAL = 4; - /** "Equal" - Object is equal to <member>RuleTerm::Operand</member>. + /** "Equal" - Object is equal to RuleTerm::Operand. */ const short EQUAL = 5; - /** "NotEqual" - Object is not equal to <member>RuleTerm::Operand</member>. + /** "NotEqual" - Object is not equal to RuleTerm::Operand. */ const short NOTEQUAL = 6; diff --git a/offapi/com/sun/star/ucb/TransferCommandOperation.idl b/offapi/com/sun/star/ucb/TransferCommandOperation.idl index e872459319df..bf9e7aa917d0 100644 --- a/offapi/com/sun/star/ucb/TransferCommandOperation.idl +++ b/offapi/com/sun/star/ucb/TransferCommandOperation.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { /** These are the possible values for - <member>GlobalTransferCommandArgument::Operation</member>. + GlobalTransferCommandArgument::Operation. */ published enum TransferCommandOperation { diff --git a/offapi/com/sun/star/ucb/TransferInfo.idl b/offapi/com/sun/star/ucb/TransferInfo.idl index 07c6af8faa96..1d6bb2eb51b0 100644 --- a/offapi/com/sun/star/ucb/TransferInfo.idl +++ b/offapi/com/sun/star/ucb/TransferInfo.idl @@ -59,8 +59,8 @@ published struct TransferInfo <p>The value can be one of the NameClash constants. <p>Implementations that are not able to detect whether there is a - clashing resource may ignore <member>NameClash::ERROR</member> and - <member>NameClash::RENAME</member> always write the new data. + clashing resource may ignore NameClash::ERROR and + NameClash::RENAME always write the new data. */ long NameClash; diff --git a/offapi/com/sun/star/ucb/XFetchProvider.idl b/offapi/com/sun/star/ucb/XFetchProvider.idl index 64a24245b6dd..416b094aeb3c 100644 --- a/offapi/com/sun/star/ucb/XFetchProvider.idl +++ b/offapi/com/sun/star/ucb/XFetchProvider.idl @@ -34,7 +34,7 @@ published interface XFetchProvider: com::sun::star::uno::XInterface /** returns the contents of the columns of the indicated rows @returns - <member>FetchResult::Rows</member> contains a sequence of anys. Each + FetchResult::Rows contains a sequence of anys. Each of these anys contains a sequence of anys. @param nRowStartPosition diff --git a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl index cd39c388df44..1e8e8c184188 100644 --- a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl +++ b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl @@ -35,7 +35,7 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf rows @returns - <member>FetchResult::Rows</member> contains a sequence of anys. Each + FetchResult::Rows contains a sequence of anys. Each of these anys contains a string. @param nRowStartPosition @@ -58,7 +58,7 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf indicated rows @returns - <member>FetchResult::Rows</member> contains a sequence of anys. Each + FetchResult::Rows contains a sequence of anys. Each of these anys contains an XContentIdentifier. @param nRowStartPosition @@ -80,7 +80,7 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf /** returns the <type>XContent</types>s of the columns of the indicated rows @returns - <member>FetchResult::Rows</member> contains a sequence of anys. Each + FetchResult::Rows contains a sequence of anys. Each of these anys contains an XContent. @param nRowStartPosition diff --git a/offapi/com/sun/star/ui/dialogs/XWizard.idl b/offapi/com/sun/star/ui/dialogs/XWizard.idl index 9ffec02bb7d4..6774bb10f34b 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizard.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizard.idl @@ -94,7 +94,7 @@ interface XWizard @param WizardButton denotes the button to enable or disable, as one of the WizardButton constants. Must not be - <member>WizardButton::NONE</member>. + WizardButton::NONE. @param Enable specifies whether the button should be enabled (<TRUE/>) or disabled (<FALSE/>) */ diff --git a/offapi/com/sun/star/util/URL.idl b/offapi/com/sun/star/util/URL.idl index 25f1f93d8fcb..e599cc99c7f4 100644 --- a/offapi/com/sun/star/util/URL.idl +++ b/offapi/com/sun/star/util/URL.idl @@ -30,11 +30,11 @@ module com { module sun { module star { module util { If the structure represents a valid URL or not depends on prior usage of the functions of XURLTransformer. Only after one of the functions returned <TRUE/> this can be assumed.</br> - It is not necessary to set all of the fields; either <member>URL::Complete</member> + It is not necessary to set all of the fields; either URL::Complete or (some of) the others are set. Additionally, most of the other - fields, like <member>URL::Host</member>, <member>URL::Port</member>, - <member>URL::User</member>, <member>URL::Password</member>, - or <member>URL::Mark</member>, are optional. + fields, like URL::Host, URL::Port, + URL::User, URL::Password, + or URL::Mark, are optional. @see XURLTransformer @@ -49,7 +49,7 @@ published struct URL It is used as a central input/output or input parameter for the interfaces of XURLTransformer. The usage of one of the XURLTransformer function is mandatory to validate the URL. It cannot be assumed that - <member>URL::Complete</member> represents always a valid URL! + URL::Complete represents always a valid URL! </p> */ string Complete; diff --git a/offapi/com/sun/star/util/XBroadcaster.idl b/offapi/com/sun/star/util/XBroadcaster.idl index edc206f5c5fd..513c2db8e699 100644 --- a/offapi/com/sun/star/util/XBroadcaster.idl +++ b/offapi/com/sun/star/util/XBroadcaster.idl @@ -34,8 +34,8 @@ interface XBroadcaster: com::sun::star::uno::XInterface /** suspends broadcasts to the registered listeners. <p> - The calls to <member>XBroadcaster::lockBroadcast()</member> and - <member>XBroadcaster::unlockBroadcasts()</member> may be + The calls to XBroadcaster::lockBroadcast() and + XBroadcaster::unlockBroadcasts() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, no broadcasts are sent to registered listeners. @@ -44,19 +44,19 @@ interface XBroadcaster: com::sun::star::uno::XInterface void lockBroadcasts(); /** resumes the broadcasts which were suspended by - <member>XBroadcaster::lockBroadcasts()</member>. + XBroadcaster::lockBroadcasts(). <p> - The calls to <member>XBroadcaster::lockBroadcast()</member> and - <member>XBroadcaster::unlockBroadcasts()</member> may be + The calls to XBroadcaster::lockBroadcast() and + XBroadcaster::unlockBroadcasts() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, no broadcasts are sent to registered listeners. </p> <p> Pending broadcasts will be sent immediately after the last - call to <member>XBroadcaster::lockBroadcast()</member> is matched - by a call to <member>XBroadcaster::unlockBroadcasts()</member>. + call to XBroadcaster::lockBroadcast() is matched + by a call to XBroadcaster::unlockBroadcasts(). An implementation can decide to broadcast all pending notification in order or batch them in single broadcasts. </p> diff --git a/offapi/com/sun/star/util/XCloseListener.idl b/offapi/com/sun/star/util/XCloseListener.idl index 2c064c102433..e7eae9c13a85 100644 --- a/offapi/com/sun/star/util/XCloseListener.idl +++ b/offapi/com/sun/star/util/XCloseListener.idl @@ -31,7 +31,7 @@ <p> Such close events are broadcasted by a XCloseBroadcaster - if somewhere tries to close it by calling <member>XCloseable::close()</member>. + if somewhere tries to close it by calling XCloseable::close(). Listener can: <ul> <li>break that by throwing CloseVetoException</li> @@ -53,16 +53,16 @@ published interface XCloseListener: com::sun::star::lang::XEventListener /** is called when somewhere tries to close listened object <p> - Is called before <member>XCloseListener::notifyClosing()</member>. + Is called before XCloseListener::notifyClosing(). Listener has the chance to break that by throwing a CloseVetoException. - This exception must be passed to the original caller of <member>XCloseable::close()</member> + This exception must be passed to the original caller of XCloseable::close() without any interaction. </p> <p> The parameter <var>GetsOwnership</var> regulate who has to try to close the listened object again, if this listener disagree with the request by throwing the exception. - If it's set to <FALSE/> the original caller of <member>XCloseable::close()</member> + If it's set to <FALSE/> the original caller of XCloseable::close() will be the owner in every case. It's not allowed to call close() from this listener then. If it's set to <TRUE/> this listener will be the new owner if he throw the exception, otherwise not! If his still running processes will be finished he must call close() on @@ -72,7 +72,7 @@ published interface XCloseListener: com::sun::star::lang::XEventListener <p> If this listener doesn't disagree with th close request it depends from his internal implementation if he deregister himself at the listened object. - But normally this must be done in <member>XCloseListener::notifyClosing()</member>. + But normally this must be done in XCloseListener::notifyClosing(). </p> @param Source diff --git a/offapi/com/sun/star/util/XCloseable.idl b/offapi/com/sun/star/util/XCloseable.idl index 78cf1380d7f4..648582b40562 100644 --- a/offapi/com/sun/star/util/XCloseable.idl +++ b/offapi/com/sun/star/util/XCloseable.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module util { If an object should be terminated, it can be:<br> <ul> <li>disposed (if it supports <member scope="com::sun::star::lang">XComponent::dispose()</member>)</li> - <li>closed (if it supports <member>XCloseable::close()</member>)</li> + <li>closed (if it supports XCloseable::close())</li> </ul> First version gives the object no chance to disagree with that (e.g. if a process is still running and can't be canceled really). Last version @@ -79,7 +79,7 @@ published interface XCloseable: XCloseBroadcaster Then it's not allowed to call close() from any other place (may a registered XCloseListener). If it is set to <TRUE/> the caller gives up his ownership. If a XCloseListener throw the veto exception he will be the new owner of the closing object. This information is passed to the listener by a parameter of - his notification method <member>XCloseListener::queryClosing()</member>. After his operations was finished + his notification method XCloseListener::queryClosing(). After his operations was finished he MUST try to close it again. If the closing object itself disagree by an exception and the parameter <var>DeliverOwnership</var> was set to <TRUE/> the object will be his own owner with all consequences of that. <br><strong>Note:</strong><br> diff --git a/offapi/com/sun/star/util/XModeChangeApproveListener.idl b/offapi/com/sun/star/util/XModeChangeApproveListener.idl index ee9277c04a4a..d479321b4bc3 100644 --- a/offapi/com/sun/star/util/XModeChangeApproveListener.idl +++ b/offapi/com/sun/star/util/XModeChangeApproveListener.idl @@ -38,7 +38,7 @@ published interface XModeChangeApproveListener : com::sun::star::lang::XEventLis { /** indicates that the mode of the broadcasting component is about to change. - <p>The <member>ModeChangeEvent::NewMode</member> indicates the new mode which + <p>The ModeChangeEvent::NewMode indicates the new mode which is to be set on the component</p> @throws VetoException diff --git a/offapi/com/sun/star/util/XURLTransformer.idl b/offapi/com/sun/star/util/XURLTransformer.idl index 9be4f6306b57..a55d6fa0bacd 100644 --- a/offapi/com/sun/star/util/XURLTransformer.idl +++ b/offapi/com/sun/star/util/XURLTransformer.idl @@ -34,18 +34,18 @@ module com { module sun { module star { module util { */ published interface XURLTransformer: com::sun::star::uno::XInterface { - /** parses the string in <member>URL::Complete</member> which should contain + /** parses the string in URL::Complete which should contain a syntactically complete URL. <p> - The implementation is allowed to correct minor failures in <member>URL::Complete</member> + The implementation is allowed to correct minor failures in URL::Complete if the meaning of the URL remain unchanged. Parts of the URL are stored in the other fields of <var>aURL</var>. </p> @param aURL the URL which include the complete string notation and will contain - all parsed parts of it after finishing this call. <member>URL::Complete</member> + all parsed parts of it after finishing this call. URL::Complete can be overwritten if the implementation corrected minor failures. @returns @@ -54,27 +54,27 @@ published interface XURLTransformer: com::sun::star::uno::XInterface */ boolean parseStrict( [inout] com::sun::star::util::URL aURL ); - /** parses the string in <member>URL::Complete</member>, which may contain + /** parses the string in URL::Complete, which may contain a syntactically complete URL or is specified by the provided protocol <p> The implementation can use smart functions to correct or interpret - <member>URL::Complete</member> if it is not a syntactically complete URL. + URL::Complete if it is not a syntactically complete URL. The parts of the URL are stored in the other fields of <var>aURL</var>. </p> @param aURL the URL which include the string notation and will contain all parsed parts of it after finishing this call. This includes - <member>URL::Complete</member>. + URL::Complete. @param sSmartProtocol optional information which protocol specification should be used to parse - member<member>URL::Complete</member>. If empty the implementation can use a + memberURL::Complete. If empty the implementation can use a protocol which fit best. @returns - <TRUE/> if parsing was successful (means if <member>URL::Complete</member> could + <TRUE/> if parsing was successful (means if URL::Complete could be syntactically correct) or <FALSE/> otherwise. */ boolean parseSmart( @@ -82,11 +82,11 @@ published interface XURLTransformer: com::sun::star::uno::XInterface [in] string sSmartProtocol ); /** assembles the parts of the URL specified by <var>aURL</var> and - stores it into <member>URL::Complete</member> + stores it into URL::Complete @param aURL the URL which contains alls necessary information in a structured form. The - member <member>URL::Complete</member> contains the URL in string notation after + member URL::Complete contains the URL in string notation after the operation finished successfully. Otherwise the content of URL::complete() is not defined. diff --git a/offapi/com/sun/star/view/DocumentZoomType.idl b/offapi/com/sun/star/view/DocumentZoomType.idl index f4a4e31e9811..98e3a9c9323a 100644 --- a/offapi/com/sun/star/view/DocumentZoomType.idl +++ b/offapi/com/sun/star/view/DocumentZoomType.idl @@ -41,7 +41,7 @@ published constants DocumentZoomType const short ENTIRE_PAGE = 2; /** The zoom is relative and is to be set via the property - <member>ViewSettings::ZoomValue</member>. + ViewSettings::ZoomValue. */ const short BY_VALUE = 3; /** The page width at the current selection is fit into the view, diff --git a/offapi/com/sun/star/view/PrinterDescriptor.idl b/offapi/com/sun/star/view/PrinterDescriptor.idl index c09ed1710b53..c419500e9afb 100644 --- a/offapi/com/sun/star/view/PrinterDescriptor.idl +++ b/offapi/com/sun/star/view/PrinterDescriptor.idl @@ -69,18 +69,18 @@ published service PrinterDescriptor [readonly, property] boolean IsBusy; /** indicates, whether the printer allows changes to - <member>PrinterDescriptor::PaperOrientation</member>. + PrinterDescriptor::PaperOrientation. */ [readonly, property] boolean CanSetPaperOrientation; /** indicates, whether the printer allows changes to - <member>PrinterDescriptor::PaperFormat</member>. + PrinterDescriptor::PaperFormat. */ [readonly, property] boolean CanSetPaperFormat; /** indicates if the printer allows changes to - <member>PrinterDescriptor::PaperSize</member>. + PrinterDescriptor::PaperSize. */ [readonly, property] boolean CanSetPaperSize; |