diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-04-29 18:33:02 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:05 +0200 |
commit | b7ba598ced9708da45372a6c3f8e1a17c306be8f (patch) | |
tree | 8f7bef1c06944e35828dfec635abd626ca402cec /offapi/com/sun/star/sheet | |
parent | ae7595a7553c61cab3cc9014bb12239e02fd8c6a (diff) |
*api: clean up multi-line and mal-formed XML tags
It is amazing what some people believe autodoc supports.
Also, com::sun::star::uno::Any does not exist in IDL, that is part of
the C++ language binding.
Change-Id: I1f1f5cf5d27663ace6ff618ecbecb41fd2dfa1fc
Diffstat (limited to 'offapi/com/sun/star/sheet')
17 files changed, 210 insertions, 230 deletions
diff --git a/offapi/com/sun/star/sheet/AccessibleCell.idl b/offapi/com/sun/star/sheet/AccessibleCell.idl index a830e588f46a..fd5c4fe193f0 100644 --- a/offapi/com/sun/star/sheet/AccessibleCell.idl +++ b/offapi/com/sun/star/sheet/AccessibleCell.idl @@ -40,52 +40,48 @@ service AccessibleCell <ul> <li>The parent returned by - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleParent</method> + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() is the accessible spreadsheet.</li> <li>This object has no children.</li> <li>The description is ???.</li> <li>The name is something like A10 or B23 or so on.</li> - <li>The role is <const scope="::com::sun::star::accessibility" - >AccessibleRole::TABLE_CELL</const></li> + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::TABLE_CELL</li> <li>There are relations between the cell and the shapes with an anchor on this cell.</li> <li>The following states are supported: <ul> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::DEFUNC</const> is always false if the + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + is always false if the parent table is showed, otherwise it is true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::EDITABLE</const> is false if the cell + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + is false if the cell or the table is protected, otherwise it is true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::ENABLED</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::MULTILINE</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::MULTISELECTABLE</const> is always - true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::OPAQUE</const> is false if the cell + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::MULTILINE + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::MULTISELECTABLE + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + is false if the cell has no background color or graphic, otherwise it is true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::RESIZEABLE</const> is false if the + <li>::com::sun::star::accessibility::AccessibleStateType::RESIZEABLE + is false if the table is protected, otherwise is it true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SELECTABLE</const> is always - true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SELECTED</const> is true, if the - cell is selected.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::TRANSIENT</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SHOWING</const>Is true if the + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED + is true, if the cell is selected.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::TRANSIENT + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + is true if the Bounding Box lies in Bounding Box of the parent. Otherwise it is false.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::VISIBLE</const>Is false if the + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + is false if the column/row with this cell is filtered or hidden. Otherwise is true.</li> </ul> diff --git a/offapi/com/sun/star/sheet/AccessiblePageHeaderFooterAreasView.idl b/offapi/com/sun/star/sheet/AccessiblePageHeaderFooterAreasView.idl index 0ac6227c1d2b..4a3ccdf0428c 100644 --- a/offapi/com/sun/star/sheet/AccessiblePageHeaderFooterAreasView.idl +++ b/offapi/com/sun/star/sheet/AccessiblePageHeaderFooterAreasView.idl @@ -38,22 +38,21 @@ service AccessiblePageHeaderFooterAreasView page preview. <ul> - <li>The parent returned by <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleParent</method> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() is the accessible spreadsheet page preview.</li> <li>The children returned by - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleChild</method> all - support the interface - <type scope="::com::sun::star::accessibility">XAccessible</type. + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface + ::com::sun::star::accessibility::XAccessible. Calling - <method scope="::com::sun::star::accessibility" - >XAccessible::getAccessibleContext</method> for these children + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children returns an object that supports one of the following services.</li> <ul> <li>::com::sun::star::text::AccessibleHeaderFooterView: - A child where calling <method scope="::com::sun::star::text" - >XAccessibleContext::getAccessibleChild</method> + A child where calling + ::com::sun::star::text::XAccessibleContext::getAccessibleChild() an object that supports this service is returned for every header and footer that is at least partially visible.</li> </ul> @@ -64,50 +63,47 @@ service AccessiblePageHeaderFooterAreasView </ul> <li>The description is ???.</li> <li>The name is Header or Footer respectively.</li> - <li>The role is <const scope="::com::sun::star::accessibility" - >AccessibleRole::HEADER</const> or - <const scope="::com::sun::star::accessibility" - >AccessibleRole::FOOTER</const>.</li> + <li>The role is ::com::sun::star::accessibility::AccessibleRole::HEADER + or ::com::sun::star::accessibility::AccessibleRole::FOOTER.</li> <li>There are no relations.</li> <li>The following states are supported: <ul> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::DEFUNC</const> is always false until - the preview is closed.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::EDITABLE</const> is always false, + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + is always false until the preview is closed.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + is always false, because the document is not editable in the page preview. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::ENABLED</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::MULTILINE</const> makes no sense on + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::MULTILINE + makes no sense on a document and so it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::MULTISELECTABLE</const> is always + <li>::com::sun::star::accessibility::AccessibleStateType::MULTISELECTABLE + is always false, because in a page preview a selection is not possible. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::OPAQUE</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::RESIZEABLE</const> is always false, + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::RESIZEABLE + is always false, because you can resize the window of the page preview, but not the page preview itself. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SELECTABLE</const> is always false, + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE + is always false, because in the page preview is no selection possible. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SELECTED</const> is always false, + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED + is always false, because in the page preview is no selection possible. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SHOWING</const>Is true if the + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + is true if the Bounding Box lies in the Bounding Box of the parent. Otherwise it is false.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::VISIBLE</const>Is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + is always true.</li> </ul> </li> </ul> diff --git a/offapi/com/sun/star/sheet/AccessibleSpreadsheet.idl b/offapi/com/sun/star/sheet/AccessibleSpreadsheet.idl index a9623635f448..bf23bd1f4368 100644 --- a/offapi/com/sun/star/sheet/AccessibleSpreadsheet.idl +++ b/offapi/com/sun/star/sheet/AccessibleSpreadsheet.idl @@ -39,20 +39,19 @@ service AccessibleSpreadsheet on the desktop. <ul> - <li>The parent returned by <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleParent</method> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() is the accessible spreadsheet document view.</li> - <li>The children returned by <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleChild</method> all - support the interface XAccessible. Calling - <method scope="::com::sun::star::accessibility" - >XAccessible::getAccessibleContext</method> for these children + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children returns an object that supports the following service.</li> <ul> <li>::com::sun::star::sheet::AccessibleCell: A child where calling - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleChild</method> + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() an object that supports this service is returned for every cell in this table.</li> </ul> @@ -66,41 +65,37 @@ service AccessibleSpreadsheet </ul> <li>The description is ???.</li> <li>The name is the given table name.</li> - <li>The role is <const scope="::com::sun::star::accessibility" - >AccessibleRole::TABLE</const></li> + <li>The role is ::com::sun::star::accessibility::AccessibleRole::TABLE + </li> <li>There are relations between the table and the shapes with an anchor on this table (not with an anchor on a cell in this table).</li> <li>The following states are supported: <ul> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::DEFUNC</const> is always false if the + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + is always false if the table is not deleted and the document is open, otherwise it is true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::EDITABLE</const> is false if the + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + is false if the table is protected, otherwise it is true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::ENABLED</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::MULTI_SELECTABLE</const> is always - true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::OPAQUE</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::RESIZEABLE</const>is always - false.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SELECTABLE</const> is always - true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SELECTED</const> is true if the - complete table (all cells) is selected.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SHOWING</const>Is true if the + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::RESIZEABLE + is always false.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED + is true if the complete table (all cells) is selected.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + is true if the Bounding Box lies in the Bounding Box of the parent. Otherwise it is false.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::VISIBLE</const>Is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + is always true.</li> </ul> </li> </ul> diff --git a/offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl b/offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl index e58cfaa32d95..74c33bc30b37 100644 --- a/offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl +++ b/offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl @@ -39,35 +39,30 @@ service AccessibleSpreadsheetPageView <ul> <li>The parent returned by - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleParent</method> + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() is the window which contains the view of these page preview.</li> <li>The children returned by - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleChild</method> all - support the interface XAccessible. Calling - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleContext</method> for these children returns + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleContext() + for these children returns an object that supports one of the following services.</li> <ul> - <li><type scope="::com::sun::star::sheet" - >AccessiblePageHeaderFooterAreasView</type>: A child where calling - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleChild</method> + <li>::com::sun::star::sheet::AccessiblePageHeaderFooterAreasView: + A child where calling + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() an object that supports this service is returned for every header and footer that is at least partially visible.</li> <li>::com::sun::star::table::AccessibleTableView: A child where calling - <method scope="::com::sun::star::accessibility" - >XAccessibleChild::getAccessibleChild</method> + ::com::sun::star::accessibility::XAccessibleChild::getAccessibleChild() an object that supports this service is returned for every table fragment that is contained in the document body and is at least partially visible. A table fragment is the part of a table that is displayed on a certain page.</li> <li>::com::sun::star::drawing::AccessibleShape: A child where calling - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleChild</method> + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() an object that supports this service is returned for every shape that is at least partially visible. These objects are children of the @@ -75,8 +70,7 @@ service AccessibleSpreadsheetPageView whether they are bound to a table or a cell.</li> <li>::com::sun::star::text::AccessibleParagraphView: A child where calling - <method scope="::com::sun::star::accessibility" - >XAccessibleContext::getAccessibleChild</method> + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() an object that supports this service is returned for every note (its paragraphs) and its location (which is represented as a paragraph with the cell name as content).</li> @@ -101,48 +95,46 @@ service AccessibleSpreadsheetPageView </ul> <li>The description is ???.</li> <li>The name is Spreadsheet Document Page Preview.</li> - <li>The role is <const scope="::com::sun::star::accessibility" - >AccessibleRole::DOCUMENT</const></li> + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::DOCUMENT</li> <li>There are no relations.</li> <li>The following states are supported: <ul> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::DEFUNC</const> is always false until - the preview is closed.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::EDITABLE</const> is always false, + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + is always false until the preview is closed.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + is always false, because the document is not editable in the page preview. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::ENABLED</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::MULTILINE</const> makes no sense on a + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::MULTILINE + makes no sense on a document and so it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::MULTI_SELECTABLE</const> is always - false, because in a page preview a selection is not - possible. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::OPAQUE</const> is always true.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::RESIZEABLE</const> is always false, + <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE + is always false, because in a page preview a selection is + not possible. So it is left out of the list.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::RESIZEABLE + is always false, because you can resize the window of the page preview, but not the page preview itself. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SELECTABLE</const> is always false, + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE + is always false, because in the page preview is no selection possible. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SELECTED</const> is always false, + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED + is always false, because in the page preview is no selection possible. So it is left out of the list.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::SHOWING</const>Is true if the + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + is true if the Bounding Box lies in the Bounding Box of the parent. Otherwise it is false.</li> - <li><const scope="::com::sun::star::accessibility" - >AccessibleStateType::VISIBLE</const>Is always true.</li> + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + is always true.</li> </ul> </li> </ul> diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl index d6a8dc66c4f9..a80d252f5f79 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl @@ -76,27 +76,26 @@ published service DataPilotFieldGroup interfaces can be used to manage the members that this group contains. It is possible to insert, remove, and replace members.</p> - <p>The method <member scope="com::sun::star::container"> - XNameReplace::replaceByName</member> can be used to rename the + <p>The method com::sun::star::container::XNameReplace::replaceByName + can be used to rename the specified member. To do so, the new name has to be passed as second argument. An implementation should support the following data types: <ul> <li>a non-empty `string` specifying the new name of the group member.</li> - <li>an object supporting the <type scope="com::sun::star::container"> - XNamed</type> interface, for example an instance of + <li>an object supporting the com::sun::star::container::XNamed + interface, for example an instance of DataPilotFieldGroupItem received from another group.</li> </ul></p> - <p>The method <member scope="com::sun::star::container"> - XNameContainer::insertByName</member> can be used to insert a new + <p>The method com::sun::star::container::XNameContainer::insertByName() + can be used to insert a new member into this field group. An implementation should ignore the second argument and insert the specified member name.</p> - <p>The method <member scope="com::sun::star::container"> - XNameContainer::removeByName</member> can be used to remove an - existing member name.</p> + <p>The method com::sun::star::container::XNameContainer::removeByName() + can be used to remove an existing member name.</p> */ [optional] interface com::sun::star::container::XNameContainer; diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl index f1376ba83aab..0c0bf251eef0 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl @@ -76,8 +76,8 @@ published constants DataPilotFieldGroupBy 2002-Jan-03 00:00:00 through 2002-Jan-09 23:59:59.</li> </ul></p> - <p>See descriptions for <member>XDataPilotFieldGrouping::createDateGroup - </member> for more details about day grouping.</p> + <p>See descriptions for XDataPilotFieldGrouping::createDateGroup() + for more details about day grouping.</p> */ const long DAYS = 8; diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl index 6ed967dd3527..1ec91ac4ef1d 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl @@ -69,24 +69,24 @@ published struct DataPilotFieldGroupInfo more flags from DataPilotFieldGroupBy, grouping is performed on date or time.</li> <li>If `TRUE` is set, #Step contains a value greater - than or equal to 1, and #GroupBy set to <const> - DataPilotFieldGroupBy::DAYS</const>, grouping is performed on ranges - of days (see descriptions for <member> - XDataPilotFieldGrouping::createDateGroup</member> for more details + than or equal to 1, and #GroupBy set to + DataPilotFieldGroupBy::DAYS, grouping is performed on ranges + of days (see descriptions for + XDataPilotFieldGrouping::createDateGroup() for more details about day grouping).</li> </ul></p> */ boolean HasDateValues; - /** specifies the start value for the grouping if <member>HasAutoStart - </member> is set to `FALSE`. + /** specifies the start value for the grouping if #HasAutoStart + is set to `FALSE`. */ double Start; - /** specifies the end value for the grouping if <member>HasAutoEnd - </member> is set to `FALSE`. + /** specifies the end value for the grouping if #HasAutoEnd + is set to `FALSE`. */ double End; @@ -119,8 +119,8 @@ published struct DataPilotFieldGroupInfo /** specifies the named groups in this field if there are some. - <p>The returned object is an instance of <type>DataPilotFieldGroups - </type>. The collection of groups can be modified by inserting, + <p>The returned object is an instance of DataPilotFieldGroups + . 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 DataPilotField::GroupInfo diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl index 1b1ca66e13fe..5065d353d2ed 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl @@ -67,33 +67,31 @@ published service DataPilotFieldGroups interfaces can be used to manage the item groups. It is possible to insert, remove, and replace item groups.</p> - <p>The method <member scope="com::sun::star::container"> - XNameReplace::replaceByName</member> can be used to replace the item + <p>The method com::sun::star::container::XNameReplace::replaceByName() + can be used to replace the item names in an existing group with a new collection of item names. An implementation should support the following data types: <ul> <li>an empty `any` to remove all items and leave the group empty. The group can be filled later with new item names.</li> - <li>a <atom dim="[]">string</atom> containing all item names that will + <li>a `string[]` containing all item names that will be part of the group.</li> - <li>an object supporting <type scope="com::sun::star::container"> - XIndexAccess</type> containing elements that provide an item name per - element via the interface <type scope="com::sun::star::container"> - XNamed</type>, for example an instance of <type>DataPilotFieldGroup - </type>.</li> + <li>an object supporting com::sun::star::container::XIndexAccess + containing elements that provide an item name per element via the + interface com::sun::star::container::XNamed, + for example an instance of DataPilotFieldGroup.</li> </ul></p> - <p>The method <member scope="com::sun::star::container"> - XNameContainer::insertByName</member> can be used to insert a new + <p>The method com::sun::star::container::XNameContainer::insertByName() + can be used to insert a new field group with the passed collection of item names. An implementation should support the same data types as described above - for the method <member scope="com::sun::star::container"> - XNameReplace::replaceByName</member>.</p> + for the method + com::sun::star::container::XNameReplace::replaceByName().</p> - <p>The method <member scope="com::sun::star::container"> - XNameContainer::removeByName</member> can be used to remove an - existing field group.</p> + <p>The method com::sun::star::container::XNameContainer::removeByName() + can be used to remove an existing field group.</p> */ [optional] interface com::sun::star::container::XNameContainer; diff --git a/offapi/com/sun/star/sheet/DataPilotFieldReferenceType.idl b/offapi/com/sun/star/sheet/DataPilotFieldReferenceType.idl index 9fe394f35888..c312f42f55af 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldReferenceType.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldReferenceType.idl @@ -62,8 +62,10 @@ constants DataPilotFieldReferenceType <p>Empty results are handled as for named items (see above).<p> - <p>The difference for the first (for <TYPE>com::sun::star::sheet::DataPilotFieldReferenceItemType::PREVIOUS</TYPE>) - or last (for <TYPE>com::sun::star::sheet::DataPilotFieldReferenceItemType::NEXT</TYPE>) item of the base field is + <p>The difference for the first (for + com::sun::star::sheet::DataPilotFieldReferenceItemType::PREVIOUS) + or last (for com::sun::star::sheet::DataPilotFieldReferenceItemType::NEXT + ) item of the base field is shown as empty result.</p> */ @@ -75,8 +77,11 @@ constants DataPilotFieldReferenceType Totals outside of the base field are shown as empty results. <p>Division by zero results in an error. Otherwise, empty results are shown as 0. Results for - the base item, first (for <TYPE>com::sun::star::sheet::DataPilotFieldReferenceItemType::PREVIOUS</TYPE>) - or last (for <TYPE>com::sun::star::sheet::DataPilotFieldReferenceItemType::NEXT</TYPE>) item of the base field are shown + the base item, first (for + com::sun::star::sheet::DataPilotFieldReferenceItemType::PREVIOUS) + or last (for + com::sun::star::sheet::DataPilotFieldReferenceItemType::NEXT) + item of the base field are shown as 1 if not empty.</p> */ diff --git a/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl index f860a9447e0b..0cbcdecc2be1 100644 --- a/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl +++ b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl @@ -61,8 +61,8 @@ struct DataPilotTablePositionData whereas when the value of DataPilotTablePositionData::PositionType is either DataPilotTablePositionType::ROW_HEADER or DataPilotTablePositionType::COLUMN_HEADER, then the - #PositionData member contains an instance of type <type> - DataPilotTableHeaderData</type>.</p> + #PositionData member contains an instance of type + DataPilotTableHeaderData.</p> @see com::sun::star::sheet::DataPiotTableResultData @see com::sun::star::sheet::DataPiotTableHeaderData diff --git a/offapi/com/sun/star/sheet/ExternalLinkInfo.idl b/offapi/com/sun/star/sheet/ExternalLinkInfo.idl index 6254f3875cb7..667c42d15c3a 100644 --- a/offapi/com/sun/star/sheet/ExternalLinkInfo.idl +++ b/offapi/com/sun/star/sheet/ExternalLinkInfo.idl @@ -39,8 +39,8 @@ struct ExternalLinkInfo <p>Modes used: <ol> - <li>If #Type is <const>ExternalLinkType::EXTERNAL - </const>, this member shall contain a `string` with the + <li>If #Type is ExternalLinkType::EXTERNAL, + this member shall contain a `string` with the <em>URI</em> of a document. The formula that would need this information for example would contain <code>=[1]Sheet1!A1</code> or <code>='[1]Sheet name'!A1</code> where <em>[1]</em> does resolve to diff --git a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl index 856cfe376aac..89c21dca4328 100644 --- a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl +++ b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl @@ -44,7 +44,7 @@ constants FormulaMapGroupSpecialOffset <li>A value of type `double` for literal floating-point constants.</li> <li>A `string` for literal text.</li> - <li>A <atom dim="[][]">any</atom> for a literal array. The contained + <li>A `any[][]` for a literal array. The contained values shall be of type `double` or `string`. Floating-point values and strings may occur together in an array.</li> <li>A struct of type SingleReference for a reference to a diff --git a/offapi/com/sun/star/sheet/FormulaParser.idl b/offapi/com/sun/star/sheet/FormulaParser.idl index 6a78986e57d6..2c1145ec1369 100644 --- a/offapi/com/sun/star/sheet/FormulaParser.idl +++ b/offapi/com/sun/star/sheet/FormulaParser.idl @@ -40,8 +40,8 @@ service FormulaParser /** specifies whether to use English parser and formatter. - <p>Note: When changing this, an already existing <member>OpCodeMap - </member> needs to be recreated internally, so for performance reasons + <p>Note: When changing this, an already existing #OpCodeMap + needs to be recreated internally, so for performance reasons set this <em>before</em> setting the #OpCodeMap. */ [property] boolean CompileEnglish; @@ -70,9 +70,9 @@ service FormulaParser /** contains a list of external links referenced in formulas. - <p>Use of this property depends on the <member>FormulaConvention - </member> in use. It is relevant only for <const> - AddressConvention::XL_OOX</const> to map indices to external + <p>Use of this property depends on the FormulaConvention + in use. It is relevant only for + AddressConvention::XL_OOX to map indices to external documents. The sequence must be in the order of indices used. Note that indices are 1-based, the sequence must start with an empty element.</p> diff --git a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl index b8d03f90e4b3..3b935013b794 100644 --- a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl +++ b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl @@ -79,26 +79,26 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface members of this struct have to fulfill the following requirements: <ul> - <li>If the member <member>DataPilotFieldGroupInfo::HasAutoStart - </member> is set to `FALSE`, then the value of <member> - DataPilotFieldGroupInfo::Start</member> must be a floating-point - value representing a valid date/time value (if <member> - DataPilotFieldGroupInfo::HasAutoStart</member> is set to `TRUE`, + <li>If the member DataPilotFieldGroupInfo::HasAutoStart + is set to `FALSE`, then the value of + DataPilotFieldGroupInfo::Start must be a floating-point + value representing a valid date/time value (if + DataPilotFieldGroupInfo::HasAutoStart is set to `TRUE`, the value of DataPilotFieldGroupInfo::Start will be ignored).</li> - <li>If the member <member>DataPilotFieldGroupInfo::HasAutoEnd - </member> is set to `FALSE`, then the value of <member> - DataPilotFieldGroupInfo::End</member> must be a floating-point - value representing a valid date/time value( if <member> - DataPilotFieldGroupInfo::HasAutoEnd</member> is set to `TRUE`, + <li>If the member DataPilotFieldGroupInfo::HasAutoEnd + is set to `FALSE`, then the value of + DataPilotFieldGroupInfo::End must be a floating-point + value representing a valid date/time value( if + DataPilotFieldGroupInfo::HasAutoEnd is set to `TRUE`, the value of DataPilotFieldGroupInfo::End will be ignored).</li> - <li>If the members <member>DataPilotFieldGroupInfo::HasAutoStart - </member> and DataPilotFieldGroupInfo::HasAutoEnd - are set to `FALSE` both, then the value of <member> - DataPilotFieldGroupInfo::Start</member> must be less than or equal + <li>If the members DataPilotFieldGroupInfo::HasAutoStart + and DataPilotFieldGroupInfo::HasAutoEnd + are set to `FALSE` both, then the value of + DataPilotFieldGroupInfo::Start must be less than or equal to the value of DataPilotFieldGroupInfo::End.</li> <li>The member DataPilotFieldGroupInfo::HasDateValues @@ -123,11 +123,11 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface into one range (e.g. a value of 7 groups the members of a week into a range).</li> - <li>The contents of the member <member> - DataPilotFieldGroupInfo::SourceField</member> will be ignored.</li> + <li>The contents of the member + DataPilotFieldGroupInfo::SourceField will be ignored.</li> - <li>The contents of the member <member> - DataPilotFieldGroupInfo::Groups</member> will be ignored.</li> + <li>The contents of the member + DataPilotFieldGroupInfo::Groups will be ignored.</li> </ul> @returns diff --git a/offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl b/offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl index bb211ec43873..681967c15a86 100644 --- a/offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl +++ b/offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl @@ -49,8 +49,7 @@ interface XDrillDownDataSupplier: com::sun::star::uno::XInterface @param aFilters filtering criteria @returns a filtered subset of the original source data as 2-dimensional - sequences of <type scope="com::sun::star::uno">Any</any>. The first row - must be the header row. Each com::sun::star::uno::Any + sequences of `any`. The first row must be the header row. Each `any` instance must contain either double value for a numeric cell, or a string value for a string cell. diff --git a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl index 4d46ed1beee1..90fe048dd1ea 100644 --- a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl +++ b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl @@ -69,17 +69,17 @@ interface XFormulaOpCodeMapper sequence in order. <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 + language in parameter Language is mapped to a FormulaToken + containing the internal OpCode used by the spreadsheet application in FormulaToken::OpCode and by - contract maybe additional information in <member> - FormulaToken::Data</member>.</p> + contract maybe additional information in + FormulaToken::Data.</p> <p>The order of the FormulaToken sequence returned matches the input order of the string sequence.</p> - <p>An unknown Name string gets the OpCode value of <member> - OpCodeUnknown</member> assigned.</p> + <p>An unknown Name string gets the OpCode value of + #OpCodeUnknown assigned.</p> <p>Additional information in FormulaToken::Data is returned for: @@ -105,18 +105,18 @@ interface XFormulaOpCodeMapper is thrown. @param Groups - Group of mappings to be returned, a bit mask of <type> - FormulaMapGroup</type> constants. + Group of mappings to be returned, a bit mask of + FormulaMapGroup constants. @returns Sequence of FormulaOpCodeMapEntry. <p>Each element of the formula language in parameter Language is 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 FormulaToken::Data. See <member> - getMappings</member> for more details.</p> + OpCode used by the spreadsheet application in + FormulaToken::OpCode and by contract maybe additional + information in FormulaToken::Data. See + getMappings() for more details.</p> */ sequence< FormulaOpCodeMapEntry > getAvailableMappings( [in] long Language, [in] long Groups ) diff --git a/offapi/com/sun/star/sheet/XMultiFormulaTokens.idl b/offapi/com/sun/star/sheet/XMultiFormulaTokens.idl index ea2af811986b..580a6ee84b37 100644 --- a/offapi/com/sun/star/sheet/XMultiFormulaTokens.idl +++ b/offapi/com/sun/star/sheet/XMultiFormulaTokens.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module sheet { com::sun::star::sheet::XMultiFormulaTokens::getCount() method. When the client code tries to access formula tokens at index that is outside the allowed index range, the implementation shall return an - <type scope="com::sun::star::lang">IndexOutOfBoundsException</member>. + com::sun::star::lang::IndexOutOfBoundsException. */ interface XMultiFormulaTokens { |