diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-04-28 00:44:31 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:05 +0200 |
commit | 928b8640c0d1a9c49249100efbdd70f8c1090b07 (patch) | |
tree | d4f2388c89d137d62bced7b9e8339f964d3632ad /offapi/com/sun/star/document | |
parent | 6e1d239ae04bbb1b639ae8d04c59d3375f867712 (diff) |
*api: convert <TRUE/> <FALSE/> <VOID/> <NULL/>
sed -i 's,<\(TRUE\|FALSE\|VOID\|NULL\)/>,`\1`,g'
Change-Id: Ia4df97ca809b00993530d67203bbe4ba7a072201
Diffstat (limited to 'offapi/com/sun/star/document')
12 files changed, 33 insertions, 33 deletions
diff --git a/offapi/com/sun/star/document/DocumentEvent.idl b/offapi/com/sun/star/document/DocumentEvent.idl index 6a5e72bbdd1d..0b54ad20dca8 100644 --- a/offapi/com/sun/star/document/DocumentEvent.idl +++ b/offapi/com/sun/star/document/DocumentEvent.idl @@ -49,7 +49,7 @@ struct DocumentEvent : ::com::sun::star::lang::EventObject /** denotes the view respectively controller which the event applies to. - <p>Might be <NULL/> if the event is not related to a concrete view of + <p>Might be `NULL` if the event is not related to a concrete view of the document.</p> */ ::com::sun::star::frame::XController2 diff --git a/offapi/com/sun/star/document/ExtendedTypeDetection.idl b/offapi/com/sun/star/document/ExtendedTypeDetection.idl index 324c6d20e18f..02e2652a5c9e 100644 --- a/offapi/com/sun/star/document/ExtendedTypeDetection.idl +++ b/offapi/com/sun/star/document/ExtendedTypeDetection.idl @@ -73,7 +73,7 @@ published service ExtendedTypeDetection which contains information about the document which should be detected and must return <ul> <li>an internal type name for detected format</li> - <li>or <NULL/> if format is unknown nor supported.</li> + <li>or `NULL` if format is unknown nor supported.</li> </ul> May be that given descriptor already includes the opened document stream as parameter MediaDescriptor::InputStream. Then this one should be used every time. diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl index fceaede3d0ec..3ba1a444caaa 100644 --- a/offapi/com/sun/star/document/MediaDescriptor.idl +++ b/offapi/com/sun/star/document/MediaDescriptor.idl @@ -64,8 +64,8 @@ service MediaDescriptor <p> Loading a component of type "template" creates a new untitled document - by default, but setting the "AsTemplate" property to <FALSE/> loads the - template document for editing. Setting "AsTemplate" to <TRUE/> creates a + by default, but setting the "AsTemplate" property to `FALSE` loads the + template document for editing. Setting "AsTemplate" to `TRUE` creates a new untitled document out of the loaded document, even if it has not a "template" type. </p> @@ -307,7 +307,7 @@ service MediaDescriptor /** opens a new view for an already loaded document <p> - Setting this to <TRUE/> forces the component to create a new window on loading + Setting this to `TRUE` forces the component to create a new window on loading in any case. If the component supports multiple views, a second view is opened, if not, the component is loaded one more time. Otherwise the behavior depends on the default window handling of the com::sun::star::frame::Desktop environment. @@ -319,7 +319,7 @@ service MediaDescriptor /** overwrite any existing file <p> - For storing only: overwrite any existing file, default is <FALSE/>, + For storing only: overwrite any existing file, default is `FALSE`, so an error occurs if the target file already exists. </p> */ @@ -361,9 +361,9 @@ service MediaDescriptor /** show preview <p> - Setting this to <TRUE/> tells the a loaded component that it is loaded as + Setting this to `TRUE` tells the a loaded component that it is loaded as a preview, so it can optimize loading and viewing for this special purpose. - Default is <FALSE/>. + Default is `FALSE`. </p> */ [optional,property] boolean Preview; @@ -409,7 +409,7 @@ service MediaDescriptor /** let the document be opened in repair mode <p> - For loading of corrupted zip packages: Setting this to <TRUE/> let the document + For loading of corrupted zip packages: Setting this to `TRUE` let the document be opened in repair mode, so as much as possible information will be retrieved. </p> @@ -471,9 +471,9 @@ service MediaDescriptor /** regulate using of compressing <p> - For storing: Setting this to <TRUE/> means, don't use a zip file to save + For storing: Setting this to `TRUE` means, don't use a zip file to save the document, use a folder instead (only usable for UCB contents, that - support folders). Default is <FALSE/>. + support folders). Default is `FALSE`. </p> */ [optional,property] boolean Unpacked; diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl index acb0ff1fb378..5303ae7cafa8 100644 --- a/offapi/com/sun/star/document/OfficeDocument.idl +++ b/offapi/com/sun/star/document/OfficeDocument.idl @@ -132,7 +132,7 @@ published service OfficeDocument /** controls the focus behavior of the form controls in the document <p> - If this flag is set to <TRUE/>, any view belonging to the document + If this flag is set to `TRUE`, any view belonging to the document should focus the first control in the document. With this, you may control if your document works primarily as a form document. </p> @@ -141,8 +141,8 @@ published service OfficeDocument /** controls the initial (on-load) behavior of the form controls in the document - <p>If set to <TRUE/>, upon loading the document, the form controls will be in design mode.<br/> - If set to <FALSE/>, they will be alive, i.e. operational.<br/> + <p>If set to `TRUE`, upon loading the document, the form controls will be in design mode.<br/> + If set to `FALSE`, they will be alive, i.e. operational.<br/> With this, you may control if your document works primarily as a form document. </p> */ diff --git a/offapi/com/sun/star/document/Settings.idl b/offapi/com/sun/star/document/Settings.idl index 9a94f005cf48..b0c6f3189926 100644 --- a/offapi/com/sun/star/document/Settings.idl +++ b/offapi/com/sun/star/document/Settings.idl @@ -159,13 +159,13 @@ published service Settings <p>Note, that you have to print in duplex mode, if both, #IsPrintBookletFront and - #IsPrintBookletBack are set to <TRUE/>.</p> + #IsPrintBookletBack are set to `TRUE`.</p> */ [optional, property] boolean IsPrintBooklet; // Draw and Impress /** is only effective, if #IsPrintBooklet is - <TRUE/>. If this property is also <TRUE/>, only the fronts of + `TRUE`. If this property is also `TRUE`, only the fronts of the pages of your booklet are printed. <p>This is especially useful, if your printer does not supply @@ -175,7 +175,7 @@ published service Settings // Draw and Impress /** is only effective, if #IsPrintBooklet is - <TRUE/>. If this property is also <TRUE/>, only the backs of + `TRUE`. If this property is also `TRUE`, only the backs of the pages of your booklet are printed. <p>This is especially useful, if your printer does not supply diff --git a/offapi/com/sun/star/document/XActionLockable.idl b/offapi/com/sun/star/document/XActionLockable.idl index a2e1bb9450a8..f1bbb386ca76 100644 --- a/offapi/com/sun/star/document/XActionLockable.idl +++ b/offapi/com/sun/star/document/XActionLockable.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module document { published interface XActionLockable: com::sun::star::uno::XInterface { /** @returns - <TRUE/> if at least one lock exists. + `TRUE` if at least one lock exists. */ boolean isActionLocked(); diff --git a/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl b/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl index e22552c503f4..793690ec4c8b 100644 --- a/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl +++ b/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl @@ -46,7 +46,7 @@ interface XDocumentEventBroadcaster @param _Listener the listener to register. The behavior of the method is undefined this listener - is <NULL/>. + is `NULL`. */ void addDocumentEventListener( [in] XDocumentEventListener _Listener ); @@ -54,7 +54,7 @@ interface XDocumentEventBroadcaster @param _Listener the listener to revoke. The behavior of the method is undefined this listener - is <NULL/>. + is `NULL`. */ void removeDocumentEventListener( [in] XDocumentEventListener _Listener ); @@ -74,7 +74,7 @@ interface XDocumentEventBroadcaster @param _EventName the name of the event to be notified. @param _ViewController - the view/controller which the event applies to. May be <NULL/> + the view/controller which the event applies to. May be `NULL` @param _Supplement supplemental information related to the event. diff --git a/offapi/com/sun/star/document/XDocumentProperties.idl b/offapi/com/sun/star/document/XDocumentProperties.idl index c6a53a4f6a70..5a4b1f5c221c 100644 --- a/offapi/com/sun/star/document/XDocumentProperties.idl +++ b/offapi/com/sun/star/document/XDocumentProperties.idl @@ -285,7 +285,7 @@ published interface XDocumentProperties </p> @throws com::sun::star::lang::IllegalArgumentException - if argument is <NULL/> + if argument is `NULL` @throws com::sun::star::io::WrongFormatException if parsing the XML document fails @throws com::sun::star::lang::WrappedTargetException @@ -351,7 +351,7 @@ published interface XDocumentProperties </p> @throws com::sun::star::lang::IllegalArgumentException - if argument is <NULL/> + if argument is `NULL` @throws com::sun::star::lang::WrappedTargetException if thrown when trying to open a stream in the given storage @throws com::sun::star::io::IOException diff --git a/offapi/com/sun/star/document/XDocumentRecovery.idl b/offapi/com/sun/star/document/XDocumentRecovery.idl index 3507a43b804d..96c6968f3a26 100644 --- a/offapi/com/sun/star/document/XDocumentRecovery.idl +++ b/offapi/com/sun/star/document/XDocumentRecovery.idl @@ -40,12 +40,12 @@ interface XDocumentRecovery <p>When saving a session, either in case of a emergency (when OpenOffice.org crashed), or during a periodic session save as configured by the user, storeToRecoveryFile() is called for every - document where <code>wasModifiedSinceLastSave</code> returns <TRUE/>.</p> + document where <code>wasModifiedSinceLastSave</code> returns `TRUE`.</p> - <p>It's allowed to implement this method sloppy, by returning <TRUE/> in cases where it is not sure whether + <p>It's allowed to implement this method sloppy, by returning `TRUE` in cases where it is not sure whether the document actually has been modified. So, the most simple implementation could simply delegate this call to com::sun::star::util::XModifiable::isModified(). (Well, actually that's the - second simple implementation, the <em>most</em> simple one would, still legitimately, always return <TRUE/>.)</p> + second simple implementation, the <em>most</em> simple one would, still legitimately, always return `TRUE`.)</p> <p>However, in such a case, the document might be saved more often than needed. In particular during the periodic session save, this might become a problem when saving is expensive, for a single document diff --git a/offapi/com/sun/star/document/XTypeDetection.idl b/offapi/com/sun/star/document/XTypeDetection.idl index 158fe88a580a..5617fac0e558 100644 --- a/offapi/com/sun/star/document/XTypeDetection.idl +++ b/offapi/com/sun/star/document/XTypeDetection.idl @@ -86,9 +86,9 @@ published interface XTypeDetection: com::sun::star::uno::XInterface means the MediaDescriptor which specify the resource for detection @param AllowDeep - if it is set to <TRUE/> a "deep" detection will be follow a "flat" detection + if it is set to `TRUE` a "deep" detection will be follow a "flat" detection <br> - if it is set to <FALSE/> a "flat" detection will be made only + if it is set to `FALSE` a "flat" detection will be made only @returns an internal type name which represent the detected format diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index cc55e2d3b8c2..bd748f5f6dee 100644 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -164,7 +164,7 @@ interface XUndoManager will immediately be disposed, if applicable.</p> @throws ::com::sun::star::lang::IllegalArgumentException - if the given undo action is <NULL/>. + if the given undo action is `NULL`. */ void addUndoAction( [in] XUndoAction i_action @@ -223,7 +223,7 @@ interface XUndoManager /** determines whether undo() can reasonably be expected to succeed. @return - <FALSE/> if and only if the undo stack is currently empty, or there is an open and not-yet-closed + `FALSE` if and only if the undo stack is currently empty, or there is an open and not-yet-closed undo context. */ boolean isUndoPossible(); @@ -231,7 +231,7 @@ interface XUndoManager /** determines whether redo() can reasonably be expected to succeed. @return - <FALSE/> if and only if the redo stack is currently empty, or there is an open and not-yet-closed + `FALSE` if and only if the redo stack is currently empty, or there is an open and not-yet-closed undo context. */ boolean isRedoPossible(); diff --git a/offapi/com/sun/star/document/XViewDataSupplier.idl b/offapi/com/sun/star/document/XViewDataSupplier.idl index c02bc152be8a..29f92883d535 100644 --- a/offapi/com/sun/star/document/XViewDataSupplier.idl +++ b/offapi/com/sun/star/document/XViewDataSupplier.idl @@ -41,7 +41,7 @@ published interface XViewDataSupplier: com::sun::star::uno::XInterface @returns a com::sun::star::container::XIndexAccess, that gives access to a list of com::sun::star::beans::PropertyValue - for every open view. May <NULL/> if no view is currently available. + for every open view. May `NULL` if no view is currently available. */ ::com::sun::star::container::XIndexAccess getViewData(); @@ -50,7 +50,7 @@ published interface XViewDataSupplier: com::sun::star::uno::XInterface @param Data a list of com::sun::star::beans::PropertyValues with information about last opened views to restore it - <NULL/> isn't allowed here. + `NULL` isn't allowed here. */ void setViewData( [in] com::sun::star::container::XIndexAccess Data ); }; |