diff options
Diffstat (limited to 'offapi/com/sun/star/view')
21 files changed, 349 insertions, 636 deletions
diff --git a/offapi/com/sun/star/view/DocumentZoomType.idl b/offapi/com/sun/star/view/DocumentZoomType.idl index 65cc38657..c91079836 100644 --- a/offapi/com/sun/star/view/DocumentZoomType.idl +++ b/offapi/com/sun/star/view/DocumentZoomType.idl @@ -2,9 +2,9 @@ * * $RCSfile: DocumentZoomType.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,37 +64,37 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from idl: constants com::sun::star::view::DocumentZoomType -/** These constants describe how the document content is zoomed into the document view. +/** These constants specify how the document content is zoomed into the document view. */ constants DocumentZoomType { //------------------------------------------------------------------------- - /** the page content width (excluding margins) at the current selection fits into the view + /** The page content width (excluding margins) at the current selection is fit into the view. */ const short OPTIMAL = 0; //------------------------------------------------------------------------- - /** the page width at the current selection fits into the view + /** The page width at the current selection is fit into the view. */ const short PAGE_WIDTH = 1; //------------------------------------------------------------------------- - /** a complete page of the document fits into the view + /** A complete page of the document is fit into the view. */ const short ENTIRE_PAGE = 2; //------------------------------------------------------------------------- - /** the zoom is relative and is to be set via the property ZoomValue + /** The zoom is relative and is to be set via the property + <member>ViewSettigns::ZoomValue</member>. */ const short BY_VALUE = 3; //------------------------------------------------------------------------- - /** the page width at the current selection fits into the view. The view ends - exactly at the end of the page. + /** The page width at the current selection is fit into the view, + with zhe view ends exactly at the end of the page. */ const short PAGE_WIDTH_EXACT = 4; }; diff --git a/offapi/com/sun/star/view/OfficeDocumentView.idl b/offapi/com/sun/star/view/OfficeDocumentView.idl index bf376650e..9ff0366d6 100644 --- a/offapi/com/sun/star/view/OfficeDocumentView.idl +++ b/offapi/com/sun/star/view/OfficeDocumentView.idl @@ -2,9 +2,9 @@ * * $RCSfile: OfficeDocumentView.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,34 +76,32 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: service com::sun::star::view::OfficeDocumentView -/** specifies a view of a normal office document. +/** specifies a view of a standard office document. */ service OfficeDocumentView { - - - // DocMerge from xml: service com::sun::star::view::OfficeDocumentView: interface com::sun::star::view::XSelectionSupplier /** This mandatory interface gives access to the current user selection within this office document view. + + <p>The type of the selection depends on the actual document type.</p> */ interface com::sun::star::view::XSelectionSupplier; - // DocMerge from xml: service com::sun::star::view::OfficeDocumentView: interface com::sun::star::view::XViewSettingsSupplier /** This optional interface gives access to the view properties within this - control for an office document. + control for an office document. + + @see ViewSettings */ [optional] interface com::sun::star::view::XViewSettingsSupplier; - // DocMerge from xml: service com::sun::star::view::OfficeDocumentView: interface com::sun::star::view::XControlAccess /** Within this office document view, this optional interface gives - access to the controls which belong to specified control models. + access to the controls which belong to specified control models. */ [optional] interface com::sun::star::view::XControlAccess; @@ -113,21 +111,4 @@ service OfficeDocumentView }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/PaperFormat.idl b/offapi/com/sun/star/view/PaperFormat.idl index 34d9f20ab..71d74beee 100644 --- a/offapi/com/sun/star/view/PaperFormat.idl +++ b/offapi/com/sun/star/view/PaperFormat.idl @@ -2,9 +2,9 @@ * * $RCSfile: PaperFormat.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,84 +64,56 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: enum com::sun::star::view::PaperFormat /** specifies the format (size) of the paper on a text document. */ enum PaperFormat { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: A3, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::A3 - /** Specify the paper format to A3. + /** specifies the paper format as A3. */ A3, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: A4, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::A4 - /** Specify the paper format to A4. + /** specifies the paper format as A4. */ A4, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: A5, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::A5 - /** Specify the paper format to A5. + /** specifies the paper format as A5. */ A5, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: B4, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::B4 - /** Specify the paper format to B4. + /** specifies the paper format as B4. */ B4, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: B5, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::B5 - /** Specify the paper format to B5. + /** specifies the paper format as B5. */ B5, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: LETTER, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::LETTER - /** Specify the paper format to Letter. + /** specifies the paper format as Letter. */ LETTER, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: LEGAL, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::LEGAL - /** Specify the paper format to Legal. + /** specifies the paper format as Legal. */ LEGAL, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: TABLOID, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::TABLOID - /** Specify the paper format to Tabloid. + /** specifies the paper format as Tabloid. */ TABLOID, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: USER - - // DocMerge from xml: value com::sun::star::view::PaperFormat::USER - /** Specify the real paper size in 100th mm. + /** The real paper size is user defined in 100th mm. */ USER @@ -151,24 +123,4 @@ enum PaperFormat }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:05 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/PaperOrientation.idl b/offapi/com/sun/star/view/PaperOrientation.idl index d8fbe095a..f8d2c3ca1 100644 --- a/offapi/com/sun/star/view/PaperOrientation.idl +++ b/offapi/com/sun/star/view/PaperOrientation.idl @@ -2,9 +2,9 @@ * * $RCSfile: PaperOrientation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,28 +64,21 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: enum com::sun::star::view::PaperOrientation /** specifies the orientation of the paper. */ enum PaperOrientation { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperOrientation:: PORTRAIT, - - // DocMerge from xml: value com::sun::star::view::PaperOrientation::PORTRAIT - /** set the paper orientation to Portrait. + /** set the paper orientation to portrait. */ PORTRAIT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperOrientation:: LANDSCAPE - - // DocMerge from xml: value com::sun::star::view::PaperOrientation::LANDSCAPE - /** set the paper orientation to Landscape. + /** set the paper orientation to landscape. */ LANDSCAPE @@ -95,24 +88,4 @@ enum PaperOrientation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/PrintOptions.idl b/offapi/com/sun/star/view/PrintOptions.idl index 5e4c6276e..5f39828e7 100644 --- a/offapi/com/sun/star/view/PrintOptions.idl +++ b/offapi/com/sun/star/view/PrintOptions.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrintOptions.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,47 +64,42 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: service com::sun::star::view::PrintOptions /** describes the options for print jobs. + + <p>These options are only valid for a single print job. They do not + change layout or formatting of the document. */ service PrintOptions { //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::CopyCount /** specifies the number of copies to print. */ [property] short CopyCount; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::FileName /** if set, specifies the name of a file to print to. */ [property] string FileName; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::Collate /** advises the printer to collate the pages of the copies. */ [property] boolean Collate; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::Sort /** advises the printer to sort the pages of the copies. */ [property] boolean Sort; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::Pages /** specifies which pages to print. + + <p>This range is given as at the user interface. For example: "1-4;10" + to print the pages 1 to 4 and 10. </p> */ [property] string Pages; @@ -114,24 +109,4 @@ service PrintOptions }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/PrintSettings.idl b/offapi/com/sun/star/view/PrintSettings.idl index 2ecabbcdd..56edbaf32 100644 --- a/offapi/com/sun/star/view/PrintSettings.idl +++ b/offapi/com/sun/star/view/PrintSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrintSettings.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,98 +64,75 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: service com::sun::star::view::PrintSettings /** provides access to the settings for printing documents. + + <p>These settings are printer independet but affect the rendering of + the document. */ service PrintSettings { //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintBlackFonts /** If <TRUE/>, all characters are printed in black. - - <p>It is useful for printing colored text on a b/w printer.</p> */ [property] boolean PrintBlackFonts; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintControls /** If <TRUE/>, control shapes are included in printing. */ [property] boolean PrintControls; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintDrawings /** If <TRUE/>, drawing objects (shapes) are included in printing. */ [property] boolean PrintDrawings; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintGraphics /** If <TRUE/>, graphic objects are included in printing. */ [property] boolean PrintGraphics; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintLeftPages /** If <TRUE/>, left pages are included in printing. */ [property] boolean PrintLeftPages; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintRightPages /** If <TRUE/>, right pages are included in printing. */ [property] boolean PrintRightPages; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintTables /** If <TRUE/>, tables are included in printing. */ [property] boolean PrintTables; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintReversed /** If <TRUE/>, the pages are printed in reverse order. - - <p>The last page is printed first.</p> */ [property] boolean PrintReversed; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintProspect /** If <TRUE/>, the pages are printed in the order of prospects. */ [property] boolean PrintProspect; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintPageBackground /** If <TRUE/>, the background of the page is printed. */ [property] boolean PrintPageBackground; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintAnnotationMode /** determines how annotations are printed. - (enum NotePrintMode) + + @see NotePrintMode */ [property] short PrintAnnotationMode; @@ -165,24 +142,4 @@ service PrintSettings }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.4 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.2 2000/01/03 12:03:24 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/PrintableState.idl b/offapi/com/sun/star/view/PrintableState.idl index c205eb029..33c27608e 100644 --- a/offapi/com/sun/star/view/PrintableState.idl +++ b/offapi/com/sun/star/view/PrintableState.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrintableState.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,36 +64,43 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -/** specifies the print progress of an <type>XPrintable</type> +/** specifies the print progress of an <type>XPrintable</type>. - <p>printing consists of two abstract phases: collecting the raw - data to send to the printer and then sending them (spooling). + <p>Printing consists of two abstract phases: rendering the document + for the printer and then sending it to the printer (spooling). <type>PrintableState</type> describes which phase is currently progressing or has failed.</p> + + @see PrintableStateEvent */ enum PrintableState { - /** printing (that is, collecting the data to send to the printer) has begun + /** printing (rendering the document) has begun */ JOB_STARTED, - /** printing has finished, spooling has begun + + /** printing (rendering the document) has finished, spooling has begun */ JOB_COMPLETED, + /** spooling has finished successfully. This is the only state that can be considered as "success" for a print job. */ JOB_SPOOLED, - /** printing was aborted (e.g., by the user) while either printing or spooling + + /** printing was aborted (e.g., by the user) while either printing or spooling. */ JOB_ABORTED, - /** printing ran into an error + + /** printing ran into an error. */ JOB_FAILED, - /** the document could be printed but not spooled + + /** the document could be printed but not spooled. */ JOB_SPOOLING_FAILED }; diff --git a/offapi/com/sun/star/view/PrintableStateEvent.idl b/offapi/com/sun/star/view/PrintableStateEvent.idl index 8b0d25df8..2770ba389 100644 --- a/offapi/com/sun/star/view/PrintableStateEvent.idl +++ b/offapi/com/sun/star/view/PrintableStateEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrintableStateEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,23 +71,19 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -/** specifies the print progress of an <type>XPrintable</type> +/** specifies the print progress of an <type>XPrintable</type>. + + <p><member scope="com::sun::star::lang">EventObject::Source</member> + contains the <type>XPrintable</type> having changed its state</p>. - <p> - <ul> - <li><member scope="com::sun::star::lang">EventObject::Source</member> - contains the <type>XPrintable</type> having changed its state</li> - <li><member scope="com::sun::star::view">PrintableStateEvent</member> - contains the new state</li> - </ul> - </p> */ struct PrintableStateEvent : com::sun::star::lang::EventObject { + /// contains the current state. PrintableState State; }; diff --git a/offapi/com/sun/star/view/PrinterDescriptor.idl b/offapi/com/sun/star/view/PrinterDescriptor.idl index 5c9996148..7758eb3a3 100644 --- a/offapi/com/sun/star/view/PrinterDescriptor.idl +++ b/offapi/com/sun/star/view/PrinterDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrinterDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,13 +76,11 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: service com::sun::star::view::PrinterDescriptor -/** describes a printer by specifying the queue name and - some settings. +/** describes a printer by specifying the queue name and some settings. <p>This service may be represented by a <type dim="[]">PropertyValue</type>. @@ -91,67 +89,56 @@ service PrinterDescriptor { //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::Name /** specifies the name of the printer queue to be used. + + <p>Which printer queues are available, can be figured out with the + system library of the used programming language/environment. */ [property] string Name; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::PaperOrientation /** specifies the orientation of the paper. */ [property] com::sun::star::view::PaperOrientation PaperOrientation; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::PaperFormat /** specifies a predefined paper size or if the paper size is a user-defined size. - - - <p>Setting this property may change the value of "PaperSize".</p> + <p>Setting this property may change the value of + <member>PrinterDescriptor</member>PaperSize</member.</p> */ [property] com::sun::star::view::PaperFormat PaperFormat; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::PaperSize /** specifies the size of the paper in 100th mm. - - - <p>Setting this property may change the value of "PaperFormat".</p> + <p>Setting this property may change the value of + <member>PrinterDescriptor</member>PaperFormat</member.</p> */ [property] com::sun::star::awt::Size PaperSize; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::IsBusy - /** indicates if the printer is busy. + /** indicates, whether the printer is busy or not. */ [readonly, property] boolean IsBusy; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::CanSetPaperOrientation - /** indicates if the printer allows changes to PaperOrientation. + /** indicates, whether the printer allows changes to + <member>PrinterDescriptor::PaperOrientation</member>. */ [readonly, property] boolean CanSetPaperOrientation; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::CanSetPaperFormat - /** indicates if the printer allows changes to PaperFormat. + /** indicates, whether the printer allows changes to + <member>PrinterDescriptor::PaperFormat</member>. */ [readonly, property] boolean CanSetPaperFormat; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::CanSetPaperSize - /** indicates if the printer allows changes to PaperSize. + /** indicates if the printer allows changes to + <member>PrinterDescriptor::PaperSize</member>. */ [readonly, property] boolean CanSetPaperSize; @@ -161,33 +148,4 @@ service PrinterDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:17 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/ViewSettings.idl b/offapi/com/sun/star/view/ViewSettings.idl new file mode 100644 index 000000000..902fb3e30 --- /dev/null +++ b/offapi/com/sun/star/view/ViewSettings.idl @@ -0,0 +1,110 @@ +/************************************************************************* + * + * $RCSfile: ViewSettings.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_view_ViewSettings_idl__ +#define __com_sun_star_view_ViewSettings_idl__ + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module view { + +//============================================================================= + +/** provides access to the settings of the controller of an office document. + */ +service ViewSettings +{ + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the horizontal ruler is displayed. + */ + [optional, property] boolean ShowHoriRuler; + + //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the horizontal scroll bar is displayed. + */ + [optional, property] boolean ShowHoriScrollBar; + + //------------------------------------------------------------------------- + /** specfifies the zoom-value in percent. + */ + [optional, property] short ZoomValue; + + //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the vertical ruler is displayed. + */ + [optional, property] boolean ShowVertRuler; + + //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the vertical scroll bar is displayed. + */ + [optional, property] boolean ShowVertScrollBar; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/view/XControlAccess.idl b/offapi/com/sun/star/view/XControlAccess.idl index 4b60a23eb..bb1f6677b 100644 --- a/offapi/com/sun/star/view/XControlAccess.idl +++ b/offapi/com/sun/star/view/XControlAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XControlAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,19 +80,18 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XControlAccess -/** provides access to the controls in a view.@see com::sun::star::frame::XController +/** provides access to the controls in a view. + + @see com::sun::star::frame::XController */ interface XControlAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XControlAccess::getControl - /** is called to get the control from a control model. + /** is called to get the control from the specified control model. */ com::sun::star::awt::XControl getControl( [in] com::sun::star::awt::XControlModel xModel ) raises( com::sun::star::container::NoSuchElementException ); @@ -103,24 +102,4 @@ interface XControlAccess: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XLineCursor.idl b/offapi/com/sun/star/view/XLineCursor.idl index 5005b690b..7928b0ad8 100644 --- a/offapi/com/sun/star/view/XLineCursor.idl +++ b/offapi/com/sun/star/view/XLineCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLineCursor.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,44 +68,43 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XLineCursor -/** makes it possible to move a cursor to the start or end of laid out text.@see com::sun::star::sheet::CellCursor - @see com::sun::star::text::TextCursor - @see com::sun::star::view::ViewCursor +/** makes it possible to move a cursor by lines within laid out text. + + @see com::sun::star::sheet::CellCursor + @see com::sun::star::text::TextCursor + @see com::sun::star::view::ViewCursor */ interface XLineCursor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XLineCursor::isAtStartOfLine /** determines if the cursor is positioned at the start of a line. */ boolean isAtStartOfLine(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XLineCursor::isAtEndOfLine /** determines if the cursor is positioned at the end of a line. */ boolean isAtEndOfLine(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XLineCursor::gotoEndOfLine /** moves the cursor to the end of the current line. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + or the cursor will be just at the new position after the move (<FALSE/>). */ void gotoEndOfLine( [in] boolean bExpand ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XLineCursor::gotoStartOfLine /** moves the cursor to the start of the current line. - @see XLineCursor::gotoPreviousOfPara + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + or the cursor will be just at the new position after the move (<FALSE/>). */ void gotoStartOfLine( [in] boolean bExpand ); @@ -115,30 +114,4 @@ interface XLineCursor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/19 16:04:00 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XPrintSettingsSupplier.idl b/offapi/com/sun/star/view/XPrintSettingsSupplier.idl index 237937be6..deb03c673 100644 --- a/offapi/com/sun/star/view/XPrintSettingsSupplier.idl +++ b/offapi/com/sun/star/view/XPrintSettingsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintSettingsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,22 +72,21 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XPrintSettingsSupplier -/** offers printing related settings. +/** offers printing related settings, which affect document rendering, + but are not related to the printer itself. */ interface XPrintSettingsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::view::XPrintSettingsSupplier::getPrintSettings /** @returns - a set of properties which are related to printing. + a set of properties which are related to printing. - @see PrintSettings + @see PrintSettings */ com::sun::star::beans::XPropertySet getPrintSettings(); @@ -97,27 +96,4 @@ interface XPrintSettingsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XPrintable.idl b/offapi/com/sun/star/view/XPrintable.idl index 6c06f1775..66a991650 100644 --- a/offapi/com/sun/star/view/XPrintable.idl +++ b/offapi/com/sun/star/view/XPrintable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,44 +76,41 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XPrintable -/** represents something that can be printed. +/** offers printing functionality. */ interface XPrintable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::view::XPrintable::getPrinter /** @returns a descriptor of the current printer. - <p>The parameters of the current printer are used for formatting. + <p>The attributes of the current printer are used for formatting. @see PrinterDescriptor */ sequence<com::sun::star::beans::PropertyValue> getPrinter(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XPrintable::setPrinter /** assigns a new printer to the object. - - <p>The sequence is a <type>PrinterDescriptor</type>. </p> + <p>Setting a new printer will cause reformatting. + @see PrinterDescriptor */ void setPrinter( [in] sequence<com::sun::star::beans::PropertyValue> aPrinter ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XPrintable::print /** prints the object. + @param xOptions + specifies the number of copies and some other values which do not + affect formatting. + @see PrintOptions */ void print( [in] sequence<com::sun::star::beans::PropertyValue> xOptions ) @@ -125,30 +122,4 @@ interface XPrintable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XPrintableBroadcaster.idl b/offapi/com/sun/star/view/XPrintableBroadcaster.idl index 60511b833..195f48ffe 100644 --- a/offapi/com/sun/star/view/XPrintableBroadcaster.idl +++ b/offapi/com/sun/star/view/XPrintableBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintableBroadcaster.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,23 +71,24 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { -/** allows for getting information about a print job +//----------------------------------------------------------------------------- +/** allows for getting information about a print job. - <p><type>XPrintableBroadcaster</type> can be implemented by classes by - implementing <type>XPrintable</type>. It allows for <type>XPrintableListener</type> - to be set, so a user can be informed about the print progress.</p> + <p><type>XPrintableBroadcaster</type> can be implemented by classes which + implement <type>XPrintable</type>. It allows a <type>XPrintableListener</type> + to be registered, thus a client object will learn about the print progress.</p> @see XPrintableListener */ interface XPrintableBroadcaster : com::sun::star::uno::XInterface { - /** adds an <type>XPrintableListener</type> to be informed about print progress + /** adds an <type>XPrintableListener</type> to be notified about print progress. */ [oneway] void addPrintableListener( [in] XPrintableListener xListener ); - /** removes an <type>XPrintableListener</type> + /** removes an <type>XPrintableListener</type>. */ [oneway] void removePrintableListener( [in] XPrintableListener xListener ); }; diff --git a/offapi/com/sun/star/view/XPrintableListener.idl b/offapi/com/sun/star/view/XPrintableListener.idl index 06f63b3fb..1bfd883fa 100644 --- a/offapi/com/sun/star/view/XPrintableListener.idl +++ b/offapi/com/sun/star/view/XPrintableListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintableListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,23 +75,22 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { -/** allows for getting information about a print job. +/** receives events about print job progress. - <p><type>XPrintableListener</type> can be registered to - <type>XPrintableBroadcaster</type>. Then, the user will be informed about - print progress. - </p> + <p><type>XPrintableListener</type> can be registered to <type>XPrintableBroadcaster</type>. + Then, the client object will receive events about print progress. </p> @see XPrintableBroadcaster */ - interface XPrintableListener : com::sun::star::lang::XEventListener +interface XPrintableListener : com::sun::star::lang::XEventListener { - /** informs the user of the new state in print progress + //-------------------------------------------------------------------------- + /** informs the user of the new state in print progress. @param Event - contains the <type>XPrintable</type> having changed state and the new state + contains the <type>XPrintable</type> having changed state and the new state. */ [oneway] void stateChanged( [in] PrintableStateEvent Event ); }; diff --git a/offapi/com/sun/star/view/XScreenCursor.idl b/offapi/com/sun/star/view/XScreenCursor.idl index 5a505b543..99dcb1c42 100644 --- a/offapi/com/sun/star/view/XScreenCursor.idl +++ b/offapi/com/sun/star/view/XScreenCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScreenCursor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,25 +68,20 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XScreenCursor -/** enables the object to leaf through steps of the displayed size. +/** makes it possible to page through the document in steps of the displayed size. */ interface XScreenCursor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XScreenCursor::screenDown /** scrolls the view forward by one visible page. */ boolean screenDown(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XScreenCursor::screenUp /** scrolls the view backward by one visible page. */ boolean screenUp(); @@ -97,24 +92,4 @@ interface XScreenCursor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:53 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XSelectionChangeListener.idl b/offapi/com/sun/star/view/XSelectionChangeListener.idl index aa2ec2ac6..71e53425f 100644 --- a/offapi/com/sun/star/view/XSelectionChangeListener.idl +++ b/offapi/com/sun/star/view/XSelectionChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSelectionChangeListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,19 +72,23 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XSelectionChangeListener -/** makes it possible to receive an event when the selection changes.@see com::sun::star::sheet::SpreadsheetViewPane +/** makes it possible to receive an event when the current selection changes. + + @see com::sun::star::view::XSelectionSupplier */ interface XSelectionChangeListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::view::XSelectionChangeListener::selectionChanged /** is called when the selection changes. + + <p>You can get the new selection via <type>XSelectionSupplier</type> from + <member scope="com::sun::star::lang">EventObject::Source</member>. + */ [oneway] void selectionChanged( [in] com::sun::star::lang::EventObject aEvent ); @@ -94,27 +98,4 @@ interface XSelectionChangeListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XSelectionSupplier.idl b/offapi/com/sun/star/view/XSelectionSupplier.idl index a0487b3ef..b76e1493d 100644 --- a/offapi/com/sun/star/view/XSelectionSupplier.idl +++ b/offapi/com/sun/star/view/XSelectionSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSelectionSupplier.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,46 +76,39 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XSelectionSupplier -/** makes it possible to access and change the selection in a view.@see OfficeDocumentView +/** makes it possible to access and change the selection in a view. + + @see OfficeDocumentView */ interface XSelectionSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XSelectionSupplier::select - /** selects the object represented by <var>aInterface</var> if it is - known and selectable in this interface. + /** selects the object represented by <var>xSelection</var> if it is + known and selectable in this object. */ - boolean select( [in] any aSelection ) + boolean select( [in] any xSelection ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::view::XSelectionSupplier::getSelection /** @returns the current selection. - <p>The selection is either specified by an object which is contained - in the component to which the view belongs, or it is an interface of a - collection which contains such objects. + <p>The selection is either specified by an object which is contained + in the component to which the view belongs, or it is an interface of a + collection which contains such objects. */ any getSelection(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XSelectionSupplier::addSelectionChangeListener /** registers an event listener, which is called when the selection changes. */ void addSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XSelectionSupplier::removeSelectionChangeListener /** unregisters an event listener which was registered with <method>XSelectionSupplier::addSelectionChangeListener</method>. */ @@ -127,33 +120,4 @@ interface XSelectionSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/04/06 12:23:39 mi - com::sun::star::package finally removed - now in com::sun::star::packages (with 's' at the end, due to conflict with reserved identifier in Java) - - Revision 1.5 2001/03/16 16:41:53 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.2 1999/11/25 16:03:33 mi - welforming HTML for XML - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XViewCursor.idl b/offapi/com/sun/star/view/XViewCursor.idl index 3ac813fdb..dd84a60de 100644 --- a/offapi/com/sun/star/view/XViewCursor.idl +++ b/offapi/com/sun/star/view/XViewCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewCursor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,11 +68,10 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XViewCursor /** makes it possible to move a cursor up/down/left/right within laid out text. @see com::sun::star::sheet::CellCursor @@ -82,36 +81,65 @@ interface XViewCursor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XViewCursor::goDown /** moves the cursor the specified number of lines down. + + @param nCount + specifies the number of lines to go down. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + or the cursor will be just at the new position after the move (<FALSE/>). + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already in the bottom row. */ - boolean goDown( [in] short nCount, - [in] boolean bExpand ); + boolean goDown( [in] short nCount, [in] boolean bExpand ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XViewCursor::goUp /** moves the cursor the specified number of lines up. + + @param nCount + specifies the number of lines to go up. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already in the top row. */ - boolean goUp( [in] short nCount, - [in] boolean bExpand ); + boolean goUp( [in] short nCount, [in] boolean bExpand ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XViewCursor::goLeft /** moves the cursor the specified number of characters to the left. + + @param nCount + specifies the number of characters to move. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already at the leftmost position. */ - boolean goLeft( [in] short nCount, - [in] boolean bExpand ); + boolean goLeft( [in] short nCount, [in] boolean bExpand ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XViewCursor::goRight /** moves the cursor the specified number of characters to the right. + + @param nCount + specifies the number of characters to move. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already at the rightmost position. */ - boolean goRight( [in] short nCount, - [in] boolean bExpand ); + boolean goRight( [in] short nCount, [in] boolean bExpand ); }; @@ -119,27 +147,4 @@ interface XViewCursor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XViewSettingsSupplier.idl b/offapi/com/sun/star/view/XViewSettingsSupplier.idl index a0ff7fef9..e83b5db74 100644 --- a/offapi/com/sun/star/view/XViewSettingsSupplier.idl +++ b/offapi/com/sun/star/view/XViewSettingsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewSettingsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,20 +72,20 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XViewSettingsSupplier /** provides access to the view settings of the object. */ interface XViewSettingsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::view::XViewSettingsSupplier::getViewSettings /** @returns - an interface to the <type scope="com::sun::star::text">ViewSettings</type>. + an interface to the <type>ViewSettings</type>. + + <p>Subclasses might be returned instead, offering more settings. </p> */ com::sun::star::beans::XPropertySet getViewSettings(); @@ -95,24 +95,4 @@ interface XViewSettingsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif |