Issue 121168 - Typo errors in IDL of getCurrentSortOrder
Summary: Typo errors in IDL of getCurrentSortOrder
Status: UNCONFIRMED
Alias: None
Product: App Dev
Classification: Unclassified
Component: api (show other issues)
Version: 3.3.0 or older (OOo)
Hardware: All All
: P3 Normal
Target Milestone: ---
Assignee: AOO issues mailing list
QA Contact:
URL:
Keywords:
Depends on: 116191
Blocks:
  Show dependency tree
 
Reported: 2012-10-05 17:11 UTC by bmarcelly
Modified: 2013-02-24 21:09 UTC (History)
4 users (show)

See Also:
Issue Type: DEFECT
Latest Confirmation in: ---
Developer Difficulty: ---

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this issue.
Description bmarcelly 2012-10-05 17:11:56 UTC 
IDL page : c.s.s.awt.grid.XSortableMutableGridData

Type of return data reads :
::com::sun::star::beans::Pair< string, string >
It should be written :
::com::sun::star::beans::StringPair

Paragraph Returns reads :
::com::sun::star::beans::Pair::First denotes the column by which the data is sorted, or -1 if the data is currently unsorted. ::com::sun::star::beans::Pair::Second is true if the data is sorted ascending, false otherwise. 
It should be written :
::com::sun::star::beans::StringPair::First denotes the column by which the data is sorted, or -1 if the data is currently unsorted. ::com::sun::star::beans::StringPair::Second is true if the data is sorted ascending, false otherwise.
Comment 1 hanya 2012-10-06 11:09:32 UTC 
Definition of getCurrentSortOrder method in revision 1208211 is [1]
::com::sun::star::beans::Pair< long, boolean > getCurrentSortOrder();

But IDL reference on api.openoffice shows
::com::sun::star::beans::Pair< string, string > getCurrentSortOrder();
Note css.beans.Pair is not shown in the reference because of autodoc problem.

Current implementation is match with generated definition in C++ header [3].
In my local copy of IDL reference for AOO 3.4.1, the return value is defined as Pair<any, any>.

[1] http://svn.apache.org/viewvc/incubator/ooo/trunk/main/offapi/com/sun/star/awt/grid/XSortableGridData.idl?view=markup#l64
[2] http://www.openoffice.org/api/docs/common/ref/com/sun/star/awt/grid/XSortableGridData.html#getCurrentSortOrder
[3] http://svn.apache.org/viewvc/incubator/ooo/trunk/main/toolkit/source/controls/grid/sortablegriddatamodel.cxx?view=markup#l576
Comment 2 bmarcelly 2012-10-10 10:03:01 UTC 
The autodoc problem for ::com::sun::star::beans::Pair is already described in Bug 116191.

Further confusion for me came from the fact that ::com::sun::star::beans::Pair  does not appear in the HTML view of the IDL, only ::com::sun::star::beans::StringPair appears.
Comment 3 Ariel Constenla-Haile 2012-10-10 10:18:26 UTC 
(In reply to comment #2)
> Further confusion for me came from the fact that
> ::com::sun::star::beans::Pair  does not appear in the HTML view of the IDL

This is Bug 98568