Issue 109968 - [api] undocumented cursor properties
Summary: [api] undocumented cursor properties
Status: CLOSED FIXED
Alias: None
Product: App Dev
Classification: Unclassified
Component: api (show other issues)
Version: 3.3.0 or older (OOo)
Hardware: All All
: P3 Trivial
Target Milestone: ---
Assignee: jsc
QA Contact: issues@api
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-03-09 10:37 UTC by mst.ooo
Modified: 2013-02-24 21:06 UTC (History)
3 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 mst.ooo 2010-03-09 10:37:55 UTC 
writer implements a bunch of properties on its text cursor that are not
documented in the API reference.

for example:

unomap.cxx:144:
		{ SW_PROP_NMID(UNO_NAME_DOCUMENT_INDEX), FN_UNO_DOCUMENT_INDEX,
CPPU_E2T(CPPUTYPE_REFDOCINDEX),
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },            \
		{ SW_PROP_NMID(UNO_NAME_TEXT_TABLE), FN_UNO_TEXT_TABLE,	
CPPU_E2T(CPPUTYPE_REFTXTTABLE),	
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },               \
		{ SW_PROP_NMID(UNO_NAME_CELL), FN_UNO_CELL,		
CPPU_E2T(CPPUTYPE_REFCELL),		
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },
         \
		{ SW_PROP_NMID(UNO_NAME_TEXT_FRAME), FN_UNO_TEXT_FRAME,	
CPPU_E2T(CPPUTYPE_REFTEXTFRAME),	
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },
         \
		{ SW_PROP_NMID(UNO_NAME_TEXT_SECTION), FN_UNO_TEXT_SECTION,
CPPU_E2T(CPPUTYPE_REFTEXTSECTION),
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },
        \


unomap.cxx:279:
        { SW_PROP_NMID(UNO_NAME_DOCUMENT_INDEX_MARK),
FN_UNO_DOCUMENT_INDEX_MARK, CPPU_E2T(CPPUTYPE_REFDOCIDXMRK),
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },\
        { SW_PROP_NMID(UNO_NAME_TEXT_FIELD), FN_UNO_TEXT_FIELD,
CPPU_E2T(CPPUTYPE_REFTXTFIELD),
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },\
        { SW_PROP_NMID(UNO_NAME_REFERENCE_MARK), FN_UNO_REFERENCE_MARK,
CPPU_E2T(CPPUTYPE_REFTEXTCNTNT), PropertyAttribute::MAYBEVOID ,0 },\
        { SW_PROP_NMID(UNO_NAME_FOOTNOTE), FN_UNO_FOOTNOTE,
CPPU_E2T(CPPUTYPE_REFFOOTNOTE),
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },\
        { SW_PROP_NMID(UNO_NAME_ENDNOTE), FN_UNO_ENDNOTE,
CPPU_E2T(CPPUTYPE_REFFOOTNOTE),
PropertyAttribute::MAYBEVOID|PropertyAttribute::READONLY ,0 },\
Comment 1 mst.ooo 2010-03-09 14:10:35 UTC 
created a new service css.text.TextRangeContentProperties.idl.

fixed in cws odfmetadata4:
http://hg.services.openoffice.org/hg/cws/odfmetadata4/rev/246fbbe011aa
Comment 2 mst.ooo 2010-03-17 12:27:01 UTC 
please verify
Comment 3 jsc 2010-03-18 15:16:21 UTC 
verified

Is it possible to provide a little bit more documentation in the service
description. The current one line documentation is obsolete because it provides
nothing more info as the type and name of property. I know we often have
documented IDL types this way but we can improve it. 

And if possible we should extend the DevGuide and provide an exmaple ...
Comment 4 jsc 2010-07-06 14:47:40 UTC 
closed, verified on master