diff options
author | Michael Hönnig <mi@openoffice.org> | 2001-10-25 14:50:46 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2001-10-25 14:50:46 +0000 |
commit | 8c0d2d88516aef21f9d32c7c2c8fa4bb92368039 (patch) | |
tree | 45c0fddb0b44c65e763733fa90a39e66b235d6f6 /offapi/com/sun/star | |
parent | 05a4762ae7529ab0d9089eebcc92c4fac2e5baf1 (diff) |
proofreading and corrections from Richard Holt
Diffstat (limited to 'offapi/com/sun/star')
-rw-r--r-- | offapi/com/sun/star/style/CharacterProperties.idl | 6 | ||||
-rw-r--r-- | offapi/com/sun/star/style/NumberingLevel.idl | 9 | ||||
-rw-r--r-- | offapi/com/sun/star/style/PageProperties.idl | 56 | ||||
-rw-r--r-- | offapi/com/sun/star/style/ParagraphProperties.idl | 35 | ||||
-rw-r--r-- | offapi/com/sun/star/style/ParagraphStyleCategory.idl | 6 | ||||
-rw-r--r-- | offapi/com/sun/star/style/Style.idl | 19 | ||||
-rw-r--r-- | offapi/com/sun/star/style/StyleFamilies.idl | 9 | ||||
-rw-r--r-- | offapi/com/sun/star/style/XDefaultsSupplier.idl | 10 | ||||
-rw-r--r-- | offapi/com/sun/star/style/XStyleCondition.idl | 10 | ||||
-rw-r--r-- | offapi/com/sun/star/style/XStyleLoader.idl | 22 |
10 files changed, 92 insertions, 90 deletions
diff --git a/offapi/com/sun/star/style/CharacterProperties.idl b/offapi/com/sun/star/style/CharacterProperties.idl index 3fabc25f6660..deb977acd2ae 100644 --- a/offapi/com/sun/star/style/CharacterProperties.idl +++ b/offapi/com/sun/star/style/CharacterProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: CharacterProperties.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: os $ $Date: 2001-05-21 13:26:45 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -190,7 +190,7 @@ service CharacterProperties //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharBackTransparent - /** determines if the text background color is set at transparent. + /** determines if the text background color is set to transparent. */ [optional, property] boolean CharBackTransparent; diff --git a/offapi/com/sun/star/style/NumberingLevel.idl b/offapi/com/sun/star/style/NumberingLevel.idl index 262e45bd22c1..8d6868843bc3 100644 --- a/offapi/com/sun/star/style/NumberingLevel.idl +++ b/offapi/com/sun/star/style/NumberingLevel.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberingLevel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:18 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -104,7 +104,7 @@ service NumberingLevel //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::style::NumberingLevel::Suffix - /** This suffix is inserted behind the numbering symbol(s). + /** This suffix is inserted after the numbering symbol(s). */ [property] string Suffix; @@ -152,6 +152,9 @@ service NumberingLevel /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/12/21 08:35:18 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:44:12 mi moved from api diff --git a/offapi/com/sun/star/style/PageProperties.idl b/offapi/com/sun/star/style/PageProperties.idl index 14deeacf4d1d..faf2026ae176 100644 --- a/offapi/com/sun/star/style/PageProperties.idl +++ b/offapi/com/sun/star/style/PageProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: PageProperties.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: os $ $Date: 2001-02-13 07:57:55 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -233,7 +233,7 @@ service PageProperties */ [property] string HeaderBackGraphicFilter; //----------------------------------------------------------------------------- -/** determins the location of the background graphic of the header. +/** determines the location of the background graphic of the header. */ [property] com::sun::star::style::GraphicLocation HeaderBackGraphicLocation; //----------------------------------------------------------------------------- @@ -245,52 +245,52 @@ service PageProperties */ [property] long HeaderRightMargin; //----------------------------------------------------------------------------- -/** determins if the the background color of the header is transparent. +/** determines if the the background color of the header is transparent. */ [property] boolean HeaderBackTransparent; //----------------------------------------------------------------------------- -/** determins the left border of the header. +/** determines the left border of the header. */ [property] com::sun::star::table::BorderLine HeaderLeftBorder; //----------------------------------------------------------------------------- -/** determins the right border of the header. +/** determines the right border of the header. */ [property] com::sun::star::table::BorderLine HeaderRightBorder; //----------------------------------------------------------------------------- -/** determins the top border of the header. +/** determines the top border of the header. */ [property] com::sun::star::table::BorderLine HeaderTopBorder; //----------------------------------------------------------------------------- -/** determins the bottom border of the header. +/** determines the bottom border of the header. */ [property] com::sun::star::table::BorderLine HeaderBottomBorder; //----------------------------------------------------------------------------- -/** determins the left border distance of the header. +/** determines the left border distance of the header. */ [property] long HeaderLeftBorderDistance; //----------------------------------------------------------------------------- -/** determins the right border distance of the header. +/** determines the right border distance of the header. */ [property] long HeaderRightBorderDistance; //----------------------------------------------------------------------------- -/** determins the top border distance of the header. +/** determines the top border distance of the header. */ [property] long HeaderTopBorderDistance; //----------------------------------------------------------------------------- -/** determins the bottom border distance of the header. +/** determines the bottom border distance of the header. */ [property] long HeaderBottomBorderDistance; //----------------------------------------------------------------------------- -/** determins the shadow of the header. +/** determines the shadow of the header. */ [property] com::sun::star::table::ShadowFormat HeaderShadowFormat; //----------------------------------------------------------------------------- -/** determins the distance between the header and the body text area. +/** determines the distance between the header and the body text area. */ [property] long HeaderBodyDistance; //----------------------------------------------------------------------------- -/** determins if the header content on left and right pages is the same. +/** determines if the header content on left and right pages is the same. */ [property] boolean HeaderIsShared; //----------------------------------------------------------------------------- @@ -298,11 +298,11 @@ service PageProperties */ [property] long HeaderHeight; //----------------------------------------------------------------------------- -/** determins if the height of the header depends on the content. +/** determines if the height of the header depends on the content. */ [property] boolean HeaderIsDynamicHeight; //----------------------------------------------------------------------------- -/** determins if a header is used on the page. +/** determines if a header is used on the page. */ [property] boolean HeaderIsOn; @@ -336,19 +336,19 @@ service PageProperties */ [property] string FooterBackGraphicFilter; //----------------------------------------------------------------------------- -/** determins the location of the background graphic in the footer. +/** determines the location of the background graphic in the footer. */ [property] com::sun::star::style::GraphicLocation FooterBackGraphicLocation; //----------------------------------------------------------------------------- -/** determins the left margin of the footer. +/** determines the left margin of the footer. */ [property] long FooterLeftMargin; //----------------------------------------------------------------------------- -/** determins the right margin of the footer. +/** determines the right margin of the footer. */ [property] long FooterRightMargin; //----------------------------------------------------------------------------- -/** determins if the background is transparent. +/** determines if the background is transparent. */ [property] boolean FooterBackTransparent; //----------------------------------------------------------------------------- @@ -384,27 +384,27 @@ service PageProperties */ [property] long FooterBottomBorderDistance; //----------------------------------------------------------------------------- -/** determins the shadow of the footer. +/** determines the shadow of the footer. */ [property] com::sun::star::table::ShadowFormat FooterShadowFormat; //----------------------------------------------------------------------------- -/** determins the distance between the footer and the body text area. +/** determines the distance between the footer and the body text area. */ [property] long FooterBodyDistance; //----------------------------------------------------------------------------- -/** determins if the height of the footer depends on the content. +/** determines if the height of the footer depends on the content. */ [property] boolean FooterIsDynamicHeight; //----------------------------------------------------------------------------- -/** determins if the footer content on left and right pages is the same. +/** determines if the footer content on left and right pages is the same. */ [property] boolean FooterIsShared; //----------------------------------------------------------------------------- -/** determins the height of the footer. +/** determines the height of the footer. */ [property] long FooterHeight; //----------------------------------------------------------------------------- -/** determins if a footer is used on the page. +/** determines if a footer is used on the page. */ [property] boolean FooterIsOn; //----------------------------------------------------------------------------- @@ -440,7 +440,7 @@ of the current page is used as limit. */ [optional,property] byte FootnoteLineRelativeWidth; //----------------------------------------------------------------------------- -/** contains the adjustmen of the separator line between the text and the footnote area. +/** contains the adjustment of the separator line between the text and the footnote area. <p><type scope="com::sun::star::text">HorizontalAdjust</type>s.</p> */ [optional,property] short FootnoteLineAdjust; diff --git a/offapi/com/sun/star/style/ParagraphProperties.idl b/offapi/com/sun/star/style/ParagraphProperties.idl index cb30dc6107fc..0bf4b5e5bceb 100644 --- a/offapi/com/sun/star/style/ParagraphProperties.idl +++ b/offapi/com/sun/star/style/ParagraphProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: ParagraphProperties.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: nn $ $Date: 2001-05-23 17:46:57 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -148,7 +148,7 @@ service ParagraphProperties // DocMerge from xml: property com::sun::star::style::ParagraphProperties::ParaBackGraphicLocation /** contains the value for the position of a background graphic. - <p> </p>@see com::sun::star::style::GraphicLocation</p> + @see com::sun::star::style::GraphicLocation */ [optional, property] com::sun::star::style::GraphicLocation ParaBackGraphicLocation; @@ -165,8 +165,6 @@ service ParagraphProperties // DocMerge from xml: property com::sun::star::style::ParagraphProperties::ParaExpandSingleWord /** 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> */ @@ -191,10 +189,7 @@ service ParagraphProperties // DocMerge from xml: property com::sun::star::style::ParagraphProperties::ParaTopMargin /** determines the top margin of the paragraph in 100th mm. - - - <p>The distance between two paragraphs is specified by: - </p> + <p>The distance between two paragraphs is specified by:</p> <ul> <li>either the bottom margin of the previous paragraph.</li> <li>or the top margin of the following paragraph.</li> @@ -208,10 +203,7 @@ service ParagraphProperties // DocMerge from xml: property com::sun::star::style::ParagraphProperties::ParaBottomMargin /** determines the bottom margin of the paragraph in 100th mm. - - - <p>The distance between two paragraphs is specified by: - </p> + <p>The distance between two paragraphs is specified by:</p> <ul> <li>either the bottom margin of the previous paragraph </li> @@ -308,7 +300,7 @@ service ParagraphProperties //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::style::ParagraphProperties::ParaKeepTogether - /** Setting this property to TRUE prevents page or column + /** Setting this property to <TRUE/> prevents page or column breaks between this and the following paragraph. @@ -320,7 +312,7 @@ service ParagraphProperties //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::style::ParagraphProperties::ParaSplit - /** Setting this property to FALSE prevents the paragraph from + /** Setting this property to <FALSE/> prevents the paragraph from getting split into two pages or columns. */ [optional, property] boolean ParaSplit; @@ -328,8 +320,7 @@ service ParagraphProperties //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::style::ParagraphProperties::NumberingLevel - /** specifies the numbering level of the - paragraph. + /** specifies the numbering level of the paragraph. */ [optional, property] short NumberingLevel; @@ -346,7 +337,7 @@ service ParagraphProperties [optional, property] short NumberingStartValue; //------------------------------------------------------------------------- - /** determins if the numbering rules restart counting at the current paragraph. + /** determines if the numbering rules restart, counting at the current paragraph. */ [optional, property] boolean ParaIsNumberingRestart; //------------------------------------------------------------------------- @@ -376,20 +367,20 @@ service ParagraphProperties */ [optional, property] byte ParaWidows; //------------------------------------------------------------------------- - /** determins the type, color and size of the shadow. + /** determines the type, color, and size of the shadow. @see com.sun.star.table.ShadowFormat */ [optional, property] com::sun::star::table::ShadowFormat ParaShadowFormat; //------------------------------------------------------------------------- - /** determins if hanging punctuation is allowed. + /** determines if hanging punctuation is allowed. */ [optional, property] boolean IsHangingPunctuation; //------------------------------------------------------------------------- - /** determins if a distance between asian text, western text or complex text is set. + /** determines if a distance between asian text, western text or complex text is set. */ [optional, property] boolean IsCharacterDistance; //------------------------------------------------------------------------- - /** determins if the the rules for forbidden characters at the start or end + /** determines if the the rules for forbidden characters at the start or end of text lines are considered. */ [optional, property] boolean IsForbiddenRules; diff --git a/offapi/com/sun/star/style/ParagraphStyleCategory.idl b/offapi/com/sun/star/style/ParagraphStyleCategory.idl index 022813a53b78..f5a383b709bb 100644 --- a/offapi/com/sun/star/style/ParagraphStyleCategory.idl +++ b/offapi/com/sun/star/style/ParagraphStyleCategory.idl @@ -2,9 +2,9 @@ * * $RCSfile: ParagraphStyleCategory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:12 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -99,7 +99,7 @@ constants ParagraphStyleCategory //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::style::ParagraphStyleCategory::EXTRA - /** is applied to styles that are used in special regions like headers, footers and footnote text. + /** is applied to styles that are used in special regions like headers, footers, and footnote text. */ const short EXTRA = 4; //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/style/Style.idl b/offapi/com/sun/star/style/Style.idl index c1b51894e77e..99ee60a49ebb 100644 --- a/offapi/com/sun/star/style/Style.idl +++ b/offapi/com/sun/star/style/Style.idl @@ -2,9 +2,9 @@ * * $RCSfile: Style.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:12 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,11 +82,11 @@ service Style //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::style::Style::IsPhysical - /** determins if a style is physically created. + /** determines if a style is physically created. <p> Built in styles may not be created until they are needed. - To prevent standard style properties from being exported it may be - usefull to check if the style is created first. + To prevent standard style properties from being exported, it may be + useful to check if the style is created first. </p> */ [optional, readonly, property] boolean IsPhysical; @@ -110,11 +110,11 @@ service Style //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::style::Style::IsAutoUpdate - /** determins if a style is automatically updated if the properties of an object + /** determines if a style is automatically updated, if the properties of an object that the style is applied to are changed. - <p> I.e. if a the style is applied to a paragraph and the properties of the paragraph - are changed than the style will be updated accordingly.</p> + <p> For example, if the style is applied to a paragraph and the properties of the paragraph + are changed then the style will be updated accordingly.</p> */ [optional, property] string IsAutoUpdate; }; @@ -126,6 +126,9 @@ service Style /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:44:12 mi + moved from api + Revision 1.2 2000/10/10 09:30:02 os #79332# IsPhysical and DisplayName now readonly diff --git a/offapi/com/sun/star/style/StyleFamilies.idl b/offapi/com/sun/star/style/StyleFamilies.idl index 317f07dde4f0..6985a00249f0 100644 --- a/offapi/com/sun/star/style/StyleFamilies.idl +++ b/offapi/com/sun/star/style/StyleFamilies.idl @@ -2,9 +2,9 @@ * * $RCSfile: StyleFamilies.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:40 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,8 +80,6 @@ /** This service contains the collection of style families within the container document. - - <p>Examples of style families may be: <dl> <dt>CharacterStyles @@ -154,6 +152,9 @@ service StyleFamilies /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/01/23 10:08:40 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:44:12 mi moved from api diff --git a/offapi/com/sun/star/style/XDefaultsSupplier.idl b/offapi/com/sun/star/style/XDefaultsSupplier.idl index 31977a9cf32d..7fc2e240a079 100644 --- a/offapi/com/sun/star/style/XDefaultsSupplier.idl +++ b/offapi/com/sun/star/style/XDefaultsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDefaultsSupplier.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:43 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,14 +76,14 @@ //============================================================================= -/** This interface provides access to a XPropertySet of defaults. This can - either be the parent of a XPropertySet or the global property defaults +/** This interface provides access to an XPropertySet of defaults. This can + either be the parent of an XPropertySet or the global property defaults for a document. */ interface XDefaultsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** This method returns a XPropertySet of defaults. + /** This method returns an XPropertySet of defaults. */ com::sun::star::beans::XPropertySet getDefaults(); diff --git a/offapi/com/sun/star/style/XStyleCondition.idl b/offapi/com/sun/star/style/XStyleCondition.idl index c6d630b55f68..aa49b0916040 100644 --- a/offapi/com/sun/star/style/XStyleCondition.idl +++ b/offapi/com/sun/star/style/XStyleCondition.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStyleCondition.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:43 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,7 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::style::XStyleCondition -/** This interface makes it possible to access conditional styles of the - object. +/** This interface makes it possible to access conditional styles of the object. */ interface XStyleCondition: com::sun::star::uno::XInterface { @@ -103,6 +102,9 @@ interface XStyleCondition: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:43 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:44:12 mi moved from api diff --git a/offapi/com/sun/star/style/XStyleLoader.idl b/offapi/com/sun/star/style/XStyleLoader.idl index d0c881ea7a39..fe6fe21ac32e 100644 --- a/offapi/com/sun/star/style/XStyleLoader.idl +++ b/offapi/com/sun/star/style/XStyleLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStyleLoader.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:43 $ + * last change: $Author: mi $ $Date: 2001-10-25 15:50:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,16 +89,15 @@ interface XStyleLoader: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::style::XStyleLoader::loadStylesFromURL /** loads styles from a document at the given URL. - - - <p>If <var>OverwriteStyles</var> is <TRUE/>, then all styles + <p> + If <var>OverwriteStyles</var> is <TRUE/>, then all styles will be loaded. Otherwise, only styles which are not already defined in this document are loaded.</p> @param string URL: The directory and the filename from document with the styles @param aOptions : Specifies which of the Style families the method should load. - The sequence<PropertyValue> has following optional items + The sequence <PropertyValue/> has the following, optional items: <ul> <li> boolean LoadCellStyles </li> <li> boolean LoadTextStyles </li> @@ -107,7 +106,7 @@ interface XStyleLoader: com::sun::star::uno::XInterface <li> boolean LoadNumberingStyles </li> <li> boolean OverwriteStyles</li> </ul> - <p>As default all supported style families are loaded and existing styles are overwritten.</p> + <p>As the default, all supported style families are loaded and existing styles are overwritten.</p> */ void loadStylesFromURL( [in] string URL, [in] sequence<com::sun::star::beans::PropertyValue> aOptions ) @@ -115,9 +114,9 @@ interface XStyleLoader: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - a sequence of the supported properties as declared in <type>loadStylesFromURL</type> - with their current values. - */ + a sequence of the supported properties as declared in <type>loadStylesFromURL</type> + with their current values. + */ sequence<com::sun::star::beans::PropertyValue> getStyleLoaderOptions(); }; @@ -129,6 +128,9 @@ interface XStyleLoader: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2001/03/16 16:41:43 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.5 2001/02/22 16:19:34 os description changed |