diff options
author | Chris Sherlock <chris.sherlock79@gmail.com> | 2014-02-04 19:55:39 +0000 |
---|---|---|
committer | Caolán McNamara <caolanm@redhat.com> | 2014-02-05 09:14:53 +0000 |
commit | 51a68b4992c6eb7015d838d1fdf9fc84ec0fa5d2 (patch) | |
tree | 3fe907e6cdefffc48000197ec7f94d9f8c104858 /include/vcl | |
parent | 651756a5f40b6340518e97a31113cb59438ab40d (diff) |
Doxygen warnings corrected
* Doxygen spits out a lot of warnings about not being able to find
match function signatures, etc. This is because in some headers we
have a using namespace statement, in others it gets confused between
::Window and Window (!).
* Wrong use of tags:
+ Lots of @seealso - should be @see
+ Wrong usage of @overload - corrected with the right function
signature
+ HTML tags that doxygen doesn't recognize removed
Change-Id: I1c2eed941619b8764dbfcfc5ab38027518cdf261
Diffstat (limited to 'include/vcl')
-rw-r--r-- | include/vcl/ImageListProvider.hxx | 2 | ||||
-rw-r--r-- | include/vcl/bitmap.hxx | 12 | ||||
-rw-r--r-- | include/vcl/bitmapex.hxx | 33 | ||||
-rw-r--r-- | include/vcl/builder.hxx | 66 | ||||
-rw-r--r-- | include/vcl/controllayout.hxx | 5 | ||||
-rw-r--r-- | include/vcl/ctrl.hxx | 11 | ||||
-rw-r--r-- | include/vcl/field.hxx | 12 | ||||
-rw-r--r-- | include/vcl/fixedhyper.hxx | 10 | ||||
-rw-r--r-- | include/vcl/graphicfilter.hxx | 8 | ||||
-rw-r--r-- | include/vcl/image.hxx | 4 | ||||
-rw-r--r-- | include/vcl/lazydelete.hxx | 4 | ||||
-rw-r--r-- | include/vcl/mnemonicengine.hxx | 30 | ||||
-rw-r--r-- | include/vcl/outdev.hxx | 16 | ||||
-rw-r--r-- | include/vcl/pdfextoutdevdata.hxx | 45 | ||||
-rw-r--r-- | include/vcl/pdfwriter.hxx | 121 | ||||
-rw-r--r-- | include/vcl/print.hxx | 66 | ||||
-rw-r--r-- | include/vcl/svapp.hxx | 4 | ||||
-rw-r--r-- | include/vcl/textview.hxx | 4 | ||||
-rw-r--r-- | include/vcl/threadex.hxx | 8 | ||||
-rw-r--r-- | include/vcl/throbber.hxx | 2 | ||||
-rw-r--r-- | include/vcl/toolbox.hxx | 2 | ||||
-rw-r--r-- | include/vcl/vclenum.hxx | 2 | ||||
-rw-r--r-- | include/vcl/virdev.hxx | 2 | ||||
-rw-r--r-- | include/vcl/window.hxx | 4 | ||||
-rw-r--r-- | include/vcl/wrkwin.hxx | 4 |
25 files changed, 244 insertions, 233 deletions
diff --git a/include/vcl/ImageListProvider.hxx b/include/vcl/ImageListProvider.hxx index 631a1a5328c6..faf1c25f3dcc 100644 --- a/include/vcl/ImageListProvider.hxx +++ b/include/vcl/ImageListProvider.hxx @@ -39,7 +39,7 @@ namespace vcl /* abstract */ class IImageListProvider { public: - virtual ImageList getImageList(ImageListType) SAL_THROW (( com::sun::star::lang::IllegalArgumentException )) = 0; + virtual ImageList getImageList(ImageListType) SAL_THROW (( css::lang::IllegalArgumentException )) = 0; protected: ~IImageListProvider() {} diff --git a/include/vcl/bitmap.hxx b/include/vcl/bitmap.hxx index adf6b63785a8..9003be4b995e 100644 --- a/include/vcl/bitmap.hxx +++ b/include/vcl/bitmap.hxx @@ -449,9 +449,6 @@ public: @param nDitherFlags The algorithm to be used for dithering - - @param pDitherPal - A custom palette to be used when dithering (not yet implemented, leave NULL) */ sal_Bool Dither( sal_uLong nDitherFlags = BMP_DITHER_MATRIX ); @@ -591,6 +588,9 @@ public: @param rScaleY The scale factor in y direction. + @param nScaleFlag + Method of scaling - it is recommended that either BMP_SCALE_DEFAULT or BMP_SCALE_BESTQUALITY be used. + @return sal_True, if the operation was completed successfully. */ sal_Bool Scale( const double& rScaleX, const double& rScaleY, sal_uInt32 nScaleFlag = BMP_SCALE_DEFAULT ); @@ -688,16 +688,16 @@ public: /** Replace all pixel having one the search colors with the corresponding replace color - @param pSearchColor + @param pSearchColors Array of colors specifying which pixel should be replaced - @param pReplaceColor + @param rReplaceColors Array of colors to be placed in all changed pixel @param nColorCount Size of the aforementioned color arrays - @param nTol + @param pTols Tolerance value. Specifies the maximal difference between pSearchColor colors and the individual pixel values, such that the corresponding pixel is still regarded a match. diff --git a/include/vcl/bitmapex.hxx b/include/vcl/bitmapex.hxx index da23547dfdd8..7306856bd779 100644 --- a/include/vcl/bitmapex.hxx +++ b/include/vcl/bitmapex.hxx @@ -181,6 +181,9 @@ public: @param pInitColor Color to use for padded pixel + @param bExpandTransparent + Whether to expand the transparency color or not. + @return sal_True, if padding was performed successfully. sal_False is not only returned when the operation failed, but also if nothing had to be done, e.g. because nDX and nDY were zero. @@ -201,7 +204,7 @@ public: during this copy operation, i.e. only the minimum of source and destination rectangle's width and height are used. - @param pBmpSrc + @param pBmpExSrc The source bitmap to copy from. If this argument is NULL, or equal to the object this method is called on, copying takes place within the same bitmap. @@ -260,6 +263,9 @@ public: @param rScaleY The scale factor in y direction. + @param nScaleFlag + The algorithm to be used for scaling + @return sal_True, if the operation was completed successfully. */ sal_Bool Scale( const double& rScaleX, const double& rScaleY, sal_uInt32 nScaleFlag = BMP_SCALE_DEFAULT ); @@ -298,16 +304,16 @@ public: /** Replace all pixel having one the search colors with the corresponding replace color - @param pSearchColor + @param pSearchColors Array of colors specifying which pixel should be replaced - @param pReplaceColor + @param pReplaceColors Array of colors to be placed in all changed pixel @param nColorCount Size of the aforementioned color arrays - @param nTol + @param pTols Tolerance value. Specifies the maximal difference between pSearchColor colors and the individual pixel values, such that the corresponding pixel is still regarded a match. @@ -454,21 +460,32 @@ public: The blend value defines how strong the frame will be blended with the existing content, 255 == full coverage, 0 == no frame will be drawn - @param aColorTopLeft, aColorBottomRight, aColorTopRight, aColorBottomLeft - The colors defining the frame. If the version without aColorTopRight and - aColorBottomLeft is used, these colors are linearly interpolated from + @param aColorTopLeft, aColorBottomRight + The colors defining the frame. These colors are linearly interpolated from aColorTopLeft and aColorBottomRight using the width and height of the area @param rSize The size of the frame in pixels */ - BitmapEx VCL_DLLPUBLIC createBlendFrame( const Size& rSize, sal_uInt8 nAlpha, Color aColorTopLeft, Color aColorBottomRight); + +/** Create a blend frame as BitmapEx + + @param nAlpha + The blend value defines how strong the frame will be blended with the + existing content, 255 == full coverage, 0 == no frame will be drawn + + @param aColorTopLeft, aColorBottomRight, aColorTopRight, aColorBottomLeft + The colors defining the frame. + + @param rSize + The size of the frame in pixels + */ BitmapEx VCL_DLLPUBLIC createBlendFrame( const Size& rSize, sal_uInt8 nAlpha, diff --git a/include/vcl/builder.hxx b/include/vcl/builder.hxx index 942430674c68..68392c18cfe5 100644 --- a/include/vcl/builder.hxx +++ b/include/vcl/builder.hxx @@ -42,7 +42,7 @@ class VCL_DLLPUBLIC VclBuilder: private boost::noncopyable { public: typedef std::map<OString, OString> stringmap; - typedef ::Window* (*customMakeWidget)(::Window *pParent, stringmap &rVec); + typedef Window* (*customMakeWidget)(Window *pParent, stringmap &rVec); private: typedef boost::ptr_map<OUString, osl::Module> ModuleMap; //We store these until the builder is deleted, that way we can use the @@ -71,10 +71,10 @@ private: struct WinAndId { OString m_sID; - ::Window *m_pWindow; + Window *m_pWindow; short m_nResponseId; PackingData m_aPackingData; - WinAndId(const OString &rId, ::Window *pWindow, bool bVertical) + WinAndId(const OString &rId, Window *pWindow, bool bVertical) : m_sID(rId) , m_pWindow(pWindow) , m_nResponseId(RET_CANCEL) @@ -182,7 +182,7 @@ private: } }; - typedef std::map< ::Window*, stringmap> AtkMap; + typedef std::map< Window*, stringmap> AtkMap; struct ParserState { @@ -207,7 +207,7 @@ private: Translations m_aTranslations; - std::map< ::Window*, ::Window*> m_aRedundantParentWidgets; + std::map< Window*, Window*> m_aRedundantParentWidgets; std::vector<SizeGroup> m_aSizeGroups; @@ -224,17 +224,17 @@ private: OString m_sID; OString m_sHelpRoot; ResHookProc m_pStringReplace; - ::Window *m_pParent; + Window *m_pParent; bool m_bToplevelHasDeferredInit; bool m_bToplevelHasDeferredProperties; bool m_bToplevelParentFound; ParserState *m_pParserState; - ::Window *get_by_name(OString sID); + Window *get_by_name(OString sID); void delete_by_name(OString sID); class sortIntoBestTabTraversalOrder - : public std::binary_function<const ::Window*, const ::Window*, bool> + : public std::binary_function<const Window*, const Window*, bool> { VclBuilder *m_pBuilder; public: @@ -242,22 +242,22 @@ private: : m_pBuilder(pBuilder) { } - bool operator()(const ::Window *pA, const ::Window *pB) const; + bool operator()(const Window *pA, const Window *pB) const; }; /// XFrame to be able to extract labels and other properties of the UNO commands (like of .uno:Bold). css::uno::Reference<css::frame::XFrame> m_xFrame; public: - VclBuilder(::Window *pParent, OUString sUIRootDir, OUString sUIFile, + VclBuilder(Window *pParent, OUString sUIRootDir, OUString sUIFile, OString sID = OString(), const com::sun::star::uno::Reference<com::sun::star::frame::XFrame> &rFrame = com::sun::star::uno::Reference<com::sun::star::frame::XFrame>()); ~VclBuilder(); - ::Window *get_widget_root(); + Window *get_widget_root(); //sID must exist and be of type T template <typename T> T* get(T*& ret, OString sID) { - ::Window *w = get_by_name(sID); + Window *w = get_by_name(sID); SAL_WARN_IF(!w, "vcl.layout", "widget \"" << sID.getStr() << "\" not found in .ui"); SAL_WARN_IF(!dynamic_cast<T*>(w), "vcl.layout", ".ui widget \"" << sID.getStr() << "\" needs to correspond to vcl type " << typeid(T).name()); @@ -273,9 +273,9 @@ public: return ret; } //sID may not exist, but must be of type T if it does - template <typename T /*= ::Window if we had c++11*/> T* get(OString sID) + template <typename T /*= Window if we had c++11*/> T* get(OString sID) { - ::Window *w = get_by_name(sID); + Window *w = get_by_name(sID); SAL_WARN_IF(w && !dynamic_cast<T*>(w), "vcl.layout", ".ui widget \"" << sID.getStr() << "\" needs to correspond to vcl type " << typeid(T).name()); assert(!w || dynamic_cast<T*>(w)); @@ -285,13 +285,13 @@ public: PopupMenu* get_menu(OString sID); //given an sID return the response value for that widget - short get_response(const ::Window *pWindow) const; + short get_response(const Window *pWindow) const; - OString get_by_window(const ::Window *pWindow) const; - void delete_by_window(const ::Window *pWindow); + OString get_by_window(const Window *pWindow) const; + void delete_by_window(const Window *pWindow); //apply the properties of rProps to pWindow - static void set_properties(::Window *pWindow, const stringmap &rProps); + static void set_properties(Window *pWindow, const stringmap &rProps); //Convert _ gtk markup to ~ vcl markup static OString convertMnemonicMarkup(const OString &rIn); @@ -310,17 +310,17 @@ public: void setDeferredProperties(); //Helpers to retrofit all the existing code to the builder - static void reorderWithinParent(std::vector< ::Window*>& rChilds, bool bIsButtonBox); - static void reorderWithinParent(::Window &rWindow, sal_uInt16 nNewPosition); + static void reorderWithinParent(std::vector< Window*>& rChilds, bool bIsButtonBox); + static void reorderWithinParent(Window &rWindow, sal_uInt16 nNewPosition); css::uno::Reference<css::frame::XFrame> getFrame() { return m_xFrame; } private: - ::Window *insertObject(::Window *pParent, + Window *insertObject(Window *pParent, const OString &rClass, const OString &rID, stringmap &rProps, stringmap &rPangoAttributes, stringmap &rAtkProps, std::vector<OString> &rItems); - ::Window *makeObject(::Window *pParent, + Window *makeObject(Window *pParent, const OString &rClass, const OString &rID, stringmap &rVec, const std::vector<OString> &rItems); @@ -338,10 +338,10 @@ private: void handleTranslations(xmlreader::XmlReader &reader); - void handleChild(::Window *pParent, xmlreader::XmlReader &reader); - ::Window* handleObject(::Window *pParent, xmlreader::XmlReader &reader); - void handlePacking(::Window *pCurrent, xmlreader::XmlReader &reader); - void applyPackingProperty(::Window *pCurrent, xmlreader::XmlReader &reader); + void handleChild(Window *pParent, xmlreader::XmlReader &reader); + Window* handleObject(Window *pParent, xmlreader::XmlReader &reader); + void handlePacking(Window *pCurrent, xmlreader::XmlReader &reader); + void applyPackingProperty(Window *pCurrent, xmlreader::XmlReader &reader); void collectProperty(xmlreader::XmlReader &reader, const OString &rID, stringmap &rVec); void collectPangoAttribute(xmlreader::XmlReader &reader, stringmap &rMap); void collectAtkAttribute(xmlreader::XmlReader &reader, stringmap &rMap); @@ -356,21 +356,21 @@ private: void handleRow(xmlreader::XmlReader &reader, const OString &rID, sal_Int32 nRowIndex); void handleAdjustment(const OString &rID, stringmap &rProperties); void handleTextBuffer(const OString &rID, stringmap &rProperties); - void handleTabChild(::Window *pParent, xmlreader::XmlReader &reader); + void handleTabChild(Window *pParent, xmlreader::XmlReader &reader); void handleMenu(xmlreader::XmlReader &reader, const OString &rID); std::vector<OString> handleItems(xmlreader::XmlReader &reader, const OString &rID); void handleSizeGroup(xmlreader::XmlReader &reader, const OString &rID); - void handleAtkObject(xmlreader::XmlReader &reader, const OString &rID, ::Window *pWindow); + void handleAtkObject(xmlreader::XmlReader &reader, const OString &rID, Window *pWindow); void handleActionWidget(xmlreader::XmlReader &reader); - PackingData get_window_packing_data(const ::Window *pWindow) const; - void set_window_packing_position(const ::Window *pWindow, sal_Int32 nPosition); + PackingData get_window_packing_data(const Window *pWindow) const; + void set_window_packing_position(const Window *pWindow, sal_Int32 nPosition); - ::Window* prepareWidgetOwnScrolling(::Window *pParent, WinBits &rWinStyle); - void cleanupWidgetOwnScrolling(::Window *pScrollParent, ::Window *pWindow, stringmap &rMap); + Window* prepareWidgetOwnScrolling(Window *pParent, WinBits &rWinStyle); + void cleanupWidgetOwnScrolling(Window *pScrollParent, Window *pWindow, stringmap &rMap); void set_response(OString sID, short nResponse); }; @@ -401,7 +401,7 @@ public: { return m_pUIBuilder->get<T>(ret, sID); } - template <typename T /*= ::Window if we had c++11*/> T* get(OString sID) + template <typename T /*= Window if we had c++11*/> T* get(OString sID) { return m_pUIBuilder->get<T>(sID); } diff --git a/include/vcl/controllayout.hxx b/include/vcl/controllayout.hxx index 42ef76969b14..0856a69946b5 100644 --- a/include/vcl/controllayout.hxx +++ b/include/vcl/controllayout.hxx @@ -58,9 +58,8 @@ struct VCL_DLLPUBLIC ControlLayoutData ::Pair GetLineStartEnd( long nLine ) const; /** ToRelativeLineIndex changes a layout data index to a count relative to its line. - <p>This is equivalent to getting the line start/end pairs with - <member>GetLineStartEnd</member> until the index lies within [start,end] of a line - </p> + This is equivalent to getting the line start/end pairs with + GetLineStartEnd until the index lies within [start,end] of a line @param nIndex the absolute index inside the display text to be changed to a relative index diff --git a/include/vcl/ctrl.hxx b/include/vcl/ctrl.hxx index 94527934ce51..f5d61246db26 100644 --- a/include/vcl/ctrl.hxx +++ b/include/vcl/ctrl.hxx @@ -105,13 +105,13 @@ public: SAL_DLLPRIVATE void ImplClearLayoutData() const; /** draws a frame around the give rectangle, onto the given device - only to be used from within the <member>Window::Draw</member> method of your sub class. + only to be used from within the Window::Draw method of your sub class. The frame is always drawn with a single line (without 3D effects). In addition, any mono color set at the control's settings is respected. Yet more additionally, if we're living in a themed desktop, this theming is ignored. - Note that this makes sense, since the *only known* clients of <member>Window::Draw</member> + Note that this makes sense, since the *only known* clients of Window::Draw are form controls, when printed or print-previewed. For form controls embedded in office documents, you don't want to have the theme look. @@ -149,9 +149,8 @@ public: Pair GetLineStartEnd( long nLine ) const; /** ToRelativeLineIndex changes a layout data index to a count relative to its line. - <p>This is equivalent to getting the line start/end pairs with - <member>GetLineStartEnd</member> until the index lies within [start,end] of a line - </p> + This is equivalent to getting the line start/end pairs with + GetLineStartEnd() until the index lies within [start,end] of a line @param nIndex the absolute index inside the display text to be changed to a relative index @@ -176,7 +175,7 @@ public: virtual Size GetOptimalSize() const; /** sets a reference device used for rendering control text - @seealso DrawControlText + @see DrawControlText */ void SetReferenceDevice( OutputDevice* _referenceDevice ); OutputDevice* GetReferenceDevice() const; diff --git a/include/vcl/field.hxx b/include/vcl/field.hxx index acc59a3e2cc6..db6f8589fe3d 100644 --- a/include/vcl/field.hxx +++ b/include/vcl/field.hxx @@ -380,14 +380,14 @@ public: /** enables or disables the enforcement of valid values - If this is set to <TRUE/> (which is the default), then GetDate will always return a valid + If this is set to true (which is the default), then GetDate will always return a valid date, no matter whether the current text can really be interpreted as date. (Note: this is the compatible bahavior). - If this is set to <FALSE/>, the GetDate will return GetInvalidDate, in case the current text + If this is set to false, the GetDate will return GetInvalidDate, in case the current text cannot be interpreted as date. - In addition, if this is set to <FALSE/>, the text in the field will <em>not</em> be corrected + In addition, if this is set to false, the text in the field will \em not be corrected when the control loses the focus - instead, the invalid input will be preserved. */ void EnforceValidValue( sal_Bool _bEnforce ) { mbEnforceValidValue = _bEnforce; } @@ -461,14 +461,14 @@ public: /** enables or disables the enforcement of valid values - If this is set to <TRUE/> (which is the default), then GetTime will always return a valid + If this is set to true (which is the default), then GetTime will always return a valid time, no matter whether the current text can really be interpreted as time. (Note: this is the compatible bahavior). - If this is set to <FALSE/>, the GetTime will return GetInvalidTime, in case the current text + If this is set to false, the GetTime will return GetInvalidTime, in case the current text cannot be interpreted as time. - In addition, if this is set to <FALSE/>, the text in the field will <em>not</em> be corrected + In addition, if this is set to false, the text in the field will <em>not</em> be corrected when the control loses the focus - instead, the invalid input will be preserved. */ void EnforceValidValue( sal_Bool _bEnforce ) { mbEnforceValidValue = _bEnforce; } diff --git a/include/vcl/fixedhyper.hxx b/include/vcl/fixedhyper.hxx index aa64663a7ca8..30a2ab5e6a7b 100644 --- a/include/vcl/fixedhyper.hxx +++ b/include/vcl/fixedhyper.hxx @@ -93,16 +93,16 @@ virtual bool set_property(const OString &rKey, const OString &rValue); - /** sets <member>m_aClickHdl</member> with <arg>rLink</arg>. + /** sets m_aClickHdl with rLink. - <member>m_aClickHdl</member> is called if the text is clicked. + m_aClickHdl is called if the text is clicked. */ inline void SetClickHdl( const Link& rLink ) { m_aClickHdl = rLink; } - /** returns <member>m_aClickHdl</member>. + /** returns m_aClickHdl. @return - <member>m_aClickHdl</member> + m_aClickHdl */ inline const Link& GetClickHdl() const { return m_aClickHdl; } @@ -114,7 +114,7 @@ /** returns the URL of the hyperlink. @return - <member>m_sURL</member> + m_sURL */ OUString GetURL() const; diff --git a/include/vcl/graphicfilter.hxx b/include/vcl/graphicfilter.hxx index db129e1135ec..24d7057d62cc 100644 --- a/include/vcl/graphicfilter.hxx +++ b/include/vcl/graphicfilter.hxx @@ -170,14 +170,14 @@ public: /** Ctor to set a filename - ::Detect() must be called to identify the file + Detect() must be called to identify the file If the file has no unique header (Mtf's), the format is determined from the extension */ GraphicDescriptor( const INetURLObject& rPath ); /** Ctor using a stream - ::Detect() must be called to identify the file + Detect() must be called to identify the file As some formats (Mtf's) do not have a unique header, it makes sense to supply the file name (incl. ext.), so that the format can be derived from the extension */ @@ -278,10 +278,10 @@ public: sal_uInt16 ExportGraphic( const Graphic& rGraphic, const INetURLObject& rPath, sal_uInt16 nFormat = GRFILTER_FORMAT_DONTKNOW, - const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >* pFilterData = NULL ); + const css::uno::Sequence< css::beans::PropertyValue >* pFilterData = NULL ); sal_uInt16 ExportGraphic( const Graphic& rGraphic, const OUString& rPath, SvStream& rOStm, sal_uInt16 nFormat = GRFILTER_FORMAT_DONTKNOW, - const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >* pFilterData = NULL ); + const css::uno::Sequence< css::beans::PropertyValue >* pFilterData = NULL ); long GetExportGraphicHint() const { return nExpGraphHint; } sal_uInt16 CanImportGraphic( const INetURLObject& rPath, diff --git a/include/vcl/image.hxx b/include/vcl/image.hxx index 7623d5920681..c0853f255b9d 100644 --- a/include/vcl/image.hxx +++ b/include/vcl/image.hxx @@ -57,14 +57,14 @@ public: explicit Image( const Bitmap& rBitmap ); Image( const Bitmap& rBitmap, const Bitmap& rMaskBitmap ); Image( const Bitmap& rBitmap, const Color& rColor ); - explicit Image( const ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphic >& rxGraphic ); + explicit Image( const css::uno::Reference< css::graphic::XGraphic >& rxGraphic ); explicit Image( const OUString &rPNGFileUrl ); ~Image(); Size GetSizePixel() const; BitmapEx GetBitmapEx() const; - ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphic > GetXGraphic() const; + css::uno::Reference< css::graphic::XGraphic > GetXGraphic() const; Image GetColorTransformedImage( ImageColorTransform eColorTransform ) const; diff --git a/include/vcl/lazydelete.hxx b/include/vcl/lazydelete.hxx index 067b4febee1b..94814afe0563 100644 --- a/include/vcl/lazydelete.hxx +++ b/include/vcl/lazydelete.hxx @@ -262,10 +262,10 @@ namespace vcl Use like static DeleteUnoReferenceOnDeinit<lang::XMultiServiceFactory> - xStaticFactory (<create factory object>); + xStaticFactory (\<create factory object>); Reference<lang::XMultiServiceFactory> xFactory (xStaticFactory.get()); if (xFactory.is()) - <do something with xFactory> + \<do something with xFactory> */ template <typename I> class DeleteUnoReferenceOnDeinit : public ::vcl::DeleteOnDeinitBase diff --git a/include/vcl/mnemonicengine.hxx b/include/vcl/mnemonicengine.hxx index 64de438bce36..e07298da53ed 100644 --- a/include/vcl/mnemonicengine.hxx +++ b/include/vcl/mnemonicengine.hxx @@ -49,7 +49,7 @@ namespace vcl The MenomonicEngine itself does not use this value, it is only passed to other methods of this callback interface. - If this value is <NULL/>, searching stops. + If this value is NULL, searching stops. */ virtual const void* FirstSearchEntry( OUString& _rEntryText ) const = 0; @@ -60,10 +60,10 @@ namespace vcl The MenomonicEngine itself does not use this value, it is only passed to other methods of this callback interface. - If this value is <NULL/>, searching stops. + If this value is NULL, searching stops. If this value is the same as returned by the previous call - to <member>FirstSearchEntry</member> (i.e. you cycled + to FirstSearchEntry (i.e. you cycled around), then searching stops, too. */ virtual const void* NextSearchEntry( const void* _pCurrentSearchEntry, OUString& _rEntryText ) const = 0; @@ -77,37 +77,37 @@ namespace vcl @param _pEntry the entry to select. This is the return value of a previous call - to <member>FirstSearchEntry</member> or <member>NextSearchEntry</member>. + to FirstSearchEntry or NextSearchEntry. */ virtual void SelectSearchEntry( const void* _pEntry ) = 0; /** "executes" the current search entry, i.e. the one returned - in the previous <member>NextSearchEntry</member> call. + in the previous NextSearchEntry call. Note: The semantics of "execute" depends on your implementation. You might even have a list of entries which cannot be executed at all. - This method is called after <member>SelectSearchEntry</member>, + This method is called after SelectSearchEntry, if and only if the current entry's mnemonic is unambiguous. For instance, imagine a list which has two entries with the same mnemonic character, say "c". Now if the user presses <code>Alt-C</code>, the MnemonicEngine - will call <member>SelectCurrentEntry</member> as soon as it encounters - the first entry, but it'll never call <member>ExecuteSearchEntry</member>. + will call SelectCurrentEntry as soon as it encounters + the first entry, but it'll never call ExecuteSearchEntry. If, however, "c" is a unique mnemonic character in your entry list, then the - call of <member>SelectSearchEntry</member> will be followed by a - call to <member>ExecuteSearchEntry</member>. + call of SelectSearchEntry will be followed by a + call to ExecuteSearchEntry. This way, you can implement cyclic selection of entries: In - <member>FirstSearchEntry</member>, return the entry which was previously - selected, and in <member>NextSearchEntry</member>, interlly cycle around + FirstSearchEntry, return the entry which was previously + selected, and in NextSearchEntry, interlly cycle around in your list. Then, multiple user inputs of <code>Alt-C</code> will cycle through all entries with the mnemonic being "c". @param _pEntry the entry to select. This is the return value of a previous call - to <member>FirstSearchEntry</member> or <member>NextSearchEntry</member>. + to FirstSearchEntry or NextSearchEntry. */ virtual void ExecuteSearchEntry( const void* _pEntry ) const = 0; @@ -131,11 +131,11 @@ namespace vcl If the key event denotes pressing an accelerator key, then the entry list is searched for a matching entry. If such an entry is - found, <member>IMnemonicEntryList::SelectSearchEntry</member> + found, IMnemonicEntryList::SelectSearchEntry is called. If the entry is the only one with the given mnemonic character, then - also <member>IMnemonicEntryList::ExecuteSearchEntry</member> + also IMnemonicEntryList::ExecuteSearchEntry is called. @return diff --git a/include/vcl/outdev.hxx b/include/vcl/outdev.hxx index 4f2243658c59..8a7c43938022 100644 --- a/include/vcl/outdev.hxx +++ b/include/vcl/outdev.hxx @@ -624,22 +624,26 @@ public: static OUString GetNonMnemonicString( const OUString& rStr ) { sal_Int32 nDummy; return GetNonMnemonicString( rStr, nDummy ); } - sal_Bool GetTextBoundRect( Rectangle& rRect, + sal_Bool GetTextBoundRect( Rectangle& rRect, const OUString& rStr, sal_Int32 nBase = 0, sal_Int32 nIndex = 0, sal_Int32 nLen = -1, sal_uLong nLayoutWidth = 0, const sal_Int32* pDXArray = NULL ) const; - sal_Bool GetTextOutline( PolyPolygon&, + + sal_Bool GetTextOutline( PolyPolygon&, const OUString& rStr, sal_Int32 nBase = 0, sal_Int32 nIndex = 0, sal_Int32 nLen = -1, sal_Bool bOptimize = sal_True, sal_uLong nLayoutWidth = 0, const sal_Int32* pDXArray = NULL ) const; - sal_Bool GetTextOutlines( PolyPolyVector&, + + sal_Bool GetTextOutlines( PolyPolyVector&, const OUString& rStr, sal_Int32 nBase = 0, sal_Int32 nIndex = 0, sal_Int32 nLen = -1, sal_Bool bOptimize = sal_True, sal_uLong nLayoutWidth = 0, const sal_Int32* pDXArray = NULL ) const; - sal_Bool GetTextOutlines( ::basegfx::B2DPolyPolygonVector&, + + sal_Bool GetTextOutlines( ::basegfx::B2DPolyPolygonVector &rVector, const OUString& rStr, sal_Int32 nBase = 0, sal_Int32 nIndex = 0, sal_Int32 nLen = -1, sal_Bool bOptimize = sal_True, sal_uLong nLayoutWidth = 0, const sal_Int32* pDXArray = NULL ) const; - sal_Bool GetGlyphBoundRects( const Point& rOrigin, const OUString& rStr, int nIndex, + + sal_Bool GetGlyphBoundRects( const Point& rOrigin, const OUString& rStr, int nIndex, int nLen, int nBase, MetricVector& rVector ); void DrawPixel( const Point& rPt ); @@ -805,7 +809,7 @@ public: Theoreticaly, handing over a matrix would be needed to handle painting rotated EPS files (e.g. contained in Metafiles). This would then need to be supported for Mac and PS printers, but - that's too much for now, wrote #i107046# for this */ + that's too much for now, wrote \#i107046# for this */ bool DrawEPS( const Point& rPt, const Size& rSz, const GfxLink& rGfxLink, GDIMetaFile* pSubst = NULL ); diff --git a/include/vcl/pdfextoutdevdata.hxx b/include/vcl/pdfextoutdevdata.hxx index 1f4e18b03202..b6314edc7495 100644 --- a/include/vcl/pdfextoutdevdata.hxx +++ b/include/vcl/pdfextoutdevdata.hxx @@ -185,7 +185,7 @@ public : /** Create a new named destination to be used in a link to this document from another PDF document (see PDF spec 1.4, 8.2.1) - @parm sDestName + @param sDestName the name this destination will be addressed with from others PDF document @param rRect @@ -295,7 +295,7 @@ public : @param rText sets the title text of the item - @param nDestId + @param nDestID declares which Dest (created with CreateDest) the outline item will point to @@ -332,17 +332,17 @@ public : must be called while drawing the next page. BeginStructureElement and EndStructureElement must be called only after - <member scope="vcl">PDFWriter::NewPage</member> has been called and before - <member scope="vcl">PDFWriter::Emit</member>gets called. The current page + PDFWriter::NewPage has been called and before + PDFWriter::Emit gets called. The current page number is an implicit context parameter for Begin/EndStructureElement. For pagination artifacts that are not part of the logical structure of the document (like header, footer or page number) the special - StructElement <code>NonStructElement</code> exists. To place content + StructElement NonStructElement exists. To place content outside of the struture tree simply call - <code>BeginStructureElement( NonStructElement )</code> then draw your - content and then call <code>EndStructureElement()</code>. Any children - of a <code>NonStructElement</code> will not be part of the structure as well. + BeginStructureElement( NonStructElement ) then draw your + content and then call EndStructureElement(). Any children + of a NonStructElement will not be part of the structure as well. @param eType denotes what kind of element to begin (e.g. a heading or paragraph) @@ -365,7 +365,7 @@ public : <p> For different purposes it may be useful to paint a structure element's content discontinously. In that case an already existing structure element - can be appended to by using <code>SetCurrentStructureElement</code>. The + can be appended to by using SetCurrentStructureElement. The refenrenced structure element becomes the current structure element with all consequences: all following structure elements are appended as children of the current element. @@ -375,8 +375,8 @@ public : the id of the new current structure element @returns - <true/> if the current structure element could be set successfully - <false/> if the current structure element could not be changed + True if the current structure element could be set successfully + False if the current structure element could not be changed (e.g. if the passed element id is invalid) */ bool SetCurrentStructureElement( sal_Int32 nElement ); @@ -391,7 +391,7 @@ public : SetStructureAttribute sets an attribute of the current structural element to a new value. A consistency check is performed before actually setting the value; - if the check fails, the function returns <FALSE/> and the attribute remains + if the check fails, the function returns False and the attribute remains unchanged. @param eAttr @@ -401,15 +401,15 @@ public : the value to set the attribute to @returns - <TRUE/> if the value was valid and the change has been performed, - <FALSE/> if the attribute or value was invalid; attribute remains unchanged + True if the value was valid and the change has been performed, + False if the attribute or value was invalid; attribute remains unchanged */ bool SetStructureAttribute( PDFWriter::StructAttribute eAttr, PDFWriter::StructAttributeValue eVal ); /** set a structure attribute on the current structural element SetStructureAttributeNumerical sets an attribute of the current structural element to a new numerical value. A consistency check is performed before actually setting - the value; if the check fails, the function returns <FALSE/> and the attribute + the value; if the check fails, the function returns False and the attribute remains unchanged. @param eAttr @@ -419,15 +419,15 @@ public : the value to set the attribute to @returns - <TRUE/> if the value was valid and the change has been performed, - <FALSE/> if the attribute or value was invalid; attribute remains unchanged + True if the value was valid and the change has been performed, + False if the attribute or value was invalid; attribute remains unchanged */ bool SetStructureAttributeNumerical( PDFWriter::StructAttribute eAttr, sal_Int32 nValue ); /** set the bounding box of a structural element SetStructureBoundingBox sets the BBox attribute to a new value. Since the BBox - attribute can only be applied to <code>Table</code>, <code>Figure</code>, - <code>Form</code> and <code>Formula</code> elements, a call of this function + attribute can only be applied to Table, Figure, + Form and Formula elements, a call of this function for other element types will be ignored and the BBox attribute not be set. @param rRect @@ -476,11 +476,14 @@ public : /** create a new form control This function creates a new form control in the PDF and sets its various - properties. Do not pass an actual AnyWidget as <code>rControlType</code> + properties. Do not pass an actual AnyWidget as rControlType will be cast to the type described by the type member. @param rControlType - a descendant of <code>AnyWidget</code> determing the control's properties + a descendant of AnyWidget determing the control's properties + + @param nPageNr + the page number to apply the effect to; -1 denotes the current page */ void CreateControl( const PDFWriter::AnyWidget& rControlType, sal_Int32 nPageNr = -1 ); }; diff --git a/include/vcl/pdfwriter.hxx b/include/vcl/pdfwriter.hxx index 1f63d37b2d18..d7f61fb5ae34 100644 --- a/include/vcl/pdfwriter.hxx +++ b/include/vcl/pdfwriter.hxx @@ -666,8 +666,8 @@ The following structure describes the permissions used in PDF security ~PDFWriter(); /** Returns an OutputDevice for formatting - <p>This Output device is guaranteed to use the same - font metrics as the resulting PDF file.</p> + This Output device is guaranteed to use the same + font metrics as the resulting PDF file. @returns the reference output device @@ -675,13 +675,12 @@ The following structure describes the permissions used in PDF security OutputDevice* GetReferenceDevice(); /** Creates a new page to fill - <p>If width and height are not set the page size - is inherited from the page tree</p> - <p>other effects: + If width and height are not set the page size + is inherited from the page tree + other effects: resets the graphics state: MapMode, Font Colors and other state information MUST be set again or are undefined. - </p> @returns returns the page id of the new page @@ -707,7 +706,7 @@ The following structure describes the permissions used in PDF security void PlayMetafile( const GDIMetaFile&, const PlayMetafileContext&, vcl::PDFExtOutDevData* pDevDat = NULL ); /* sets the document locale originally passed with the context to a new value - * only affects the output if used before calling <code>Emit/code>. + * only affects the output if used before calling Emit. */ void SetDocumentLocale( const com::sun::star::lang::Locale& rDocLocale ); @@ -821,10 +820,10 @@ The following structure describes the permissions used in PDF security /** Start a transparency group Drawing operations can be grouped together to acquire a common transparency - behaviour; after calling <code>BeginTransparencyGroup</code> all drawing + behaviour; after calling BeginTransparencyGroup all drawing operations will be grouped together into a transparent object. - The transparency behaviour is set with ond of the <code>EndTransparencyGroup</code> + The transparency behaviour is set with ond of the EndTransparencyGroup calls and can be either a constant transparency factor or a transparent soft mask in form of an 8 bit gray scale bitmap. @@ -874,7 +873,7 @@ The following structure describes the permissions used in PDF security /** Create a new named destination to be used in a link from another PDF document - @parm sDestName + @param sDestName the name (label) of the bookmark, to be used to jump to @param rRect @@ -931,6 +930,9 @@ The following structure describes the permissions used in PDF security point to this destination. In such cases, a public destination Id will be assigned to the form widget, and later on, the concrete destination data for this public Id will be registered using RegisterDestReference. + @param nDestId + destination ID + @param rRect target rectangle on page to be displayed if dest is jumped to @@ -948,7 +950,7 @@ The following structure describes the permissions used in PDF security /** Set the destination for a link - <p>will change a URL type link to a dest link if necessary</p> + will change a URL type link to a dest link if necessary @param nLinkId the link to be changed @@ -962,13 +964,13 @@ The following structure describes the permissions used in PDF security */ sal_Int32 SetLinkDest( sal_Int32 nLinkId, sal_Int32 nDestId ); /** Set the URL for a link - <p>will change a dest type link to an URL type link if necessary</p> + will change a dest type link to an URL type link if necessary @param nLinkId the link to be changed @param rURL the URL the link shall point to. - The URL will be parsed (and corrected) by the <code>com.sun.star.util.URLTransformer</code> + The URL will be parsed (and corrected) by the com.sun.star.util.URLTransformer service; the result will then appear literally in the PDF file produced @returns @@ -977,33 +979,30 @@ The following structure describes the permissions used in PDF security */ sal_Int32 SetLinkURL( sal_Int32 nLinkId, const OUString& rURL ); /** Resolve link in logical structure - <p> + If a link is created after the corresponding visual appearance was drawn it is not possible to set the link id as a property attribute to the link structure item that should be created in tagged PDF around the visual appearance of a link. - </p> - <p> + For this reason an arbitrary id can be given to - <code>SetStructureAttributeNumerical</code> at the time the text for + SetStructureAttributeNumerical at the time the text for the link is drawn. To resolve this arbitrary id again when the actual - link annotation is created use SetLinkPropertyID. When <code>Emit</code> - finally gets called all <code>LinkAnnotation</code> type structure attributes + link annotation is created use SetLinkPropertyID. When Emit + finally gets called all LinkAnnotation type structure attributes will be replaced with the correct link id. - </p> - <p> + CAUTION: this technique must be used either for all or none of the links in a document since the link id space and arbitrary property id space - could overlap and it would be impossible to resolve whether a <code>Link</code> + could overlap and it would be impossible to resolve whether a Link structure attribute value was arbitrary or already a real id. - </p> @param nLinkId the link to be mapped @param nPropertyID - the arbitrary id set in a <code>Link</code> structure element to address - the link with real id <code>nLinkId</code> + the arbitrary id set in a Link structure element to address + the link with real id nLinkId */ void SetLinkPropertyID( sal_Int32 nLinkId, sal_Int32 nPropertyID ); /** Create a new outline item @@ -1015,7 +1014,7 @@ The following structure describes the permissions used in PDF security @param rText sets the title text of the item - @param nDestId + @param nDestID declares which Dest (created with CreateDest) the outline item will point to @@ -1084,7 +1083,6 @@ The following structure describes the permissions used in PDF security /** begin a new logical structure element - <p> BeginStructureElement/EndStructureElement calls build the logical structure of the PDF - the basis for tagged PDF. Structural elements are implemented using marked content tags. Each structural element can contain sub elements @@ -1094,34 +1092,26 @@ The following structure describes the permissions used in PDF security A structural element need not be contained on one page; e.g. paragraphs often run from one page to the next. In this case the corresponding EndStructureElement must be called while drawing the next page. - </p> - <p> BeginStructureElement and EndStructureElement must be called only after - <member scope="vcl">PDFWriter::NewPage</member> has been called and before - <member scope="vcl">PDFWriter::Emit</member>gets called. The current page - number is an implicit context parameter for Begin/EndStructureElement. - </p> + PDFWriter::NewPage has been called and before PDFWriter::Emit gets called. The + current page number is an implicit context parameter for Begin/EndStructureElement. - <p> For pagination artifacts that are not part of the logical structure of the document (like header, footer or page number) the special - StructElement <code>NonStructElement</code> exists. To place content + StructElement NonStructElement exists. To place content outside of the struture tree simply call - <code>BeginStructureElement( NonStructElement )</code> then draw your - content and then call <code>EndStructureElement()</code>. All children - of a <code>NonStructElement</code> will not be part of the structure. + BeginStructureElement( NonStructElement ) then draw your + content and then call EndStructureElement(). All children + of a NonStructElement will not be part of the structure. Nonetheless if you add a child structural element to a - <code>NonStructElement</code> you will still have to call - <code>EndStructureElement</code> for it. Best think of the structure + NonStructElement you will still have to call + EndStructureElement for it. Best think of the structure tree as a stack. - </p> - <p> Note: there is always one structural element in existance without having - called <code>BeginStructureElement</code>; this is the root of the structure + called BeginStructureElement; this is the root of the structure tree (called StructTreeRoot). The StructTreeRoot has always the id 0. - </p> @param eType denotes what kind of element to begin (e.g. a heading or paragraph) @@ -1131,36 +1121,32 @@ The following structure describes the permissions used in PDF security role map will be created mapping alias to regular structure type. @returns - the new structure element's id for use in <code>SetCurrentStructureElement</code> + the new structure element's id for use in SetCurrentStructureElement */ sal_Int32 BeginStructureElement( enum StructElement eType, const OUString& rAlias = OUString() ); /** end the current logical structure element - <p> Close the current structure element. The current element's parent becomes the current structure element again. - </p> @see BeginStructureElement */ void EndStructureElement(); /** set the current structure element - <p> For different purposes it may be useful to paint a structure element's content discontinously. In that case an already existing structure element - can be appended to by using <code>SetCurrentStructureElement</code>. The + can be appended to by using SetCurrentStructureElement. The refenrenced structure element becomes the current structure element with all consequences: all following structure elements are appended as children of the current element. - </p> @param nElement the id of the new current structure element @returns - <true/> if the current structure element could be set successfully - <false/> if the current structure element could not be changed + True if the current structure element could be set successfully + False if the current structure element could not be changed (e.g. if the passed element id is invalid) */ bool SetCurrentStructureElement( sal_Int32 nElement ); @@ -1169,7 +1155,7 @@ The following structure describes the permissions used in PDF security SetStructureAttribute sets an attribute of the current structural element to a new value. A consistency check is performed before actually setting the value; - if the check fails, the function returns <FALSE/> and the attribute remains + if the check fails, the function returns False and the attribute remains unchanged. @param eAttr @@ -1179,15 +1165,15 @@ The following structure describes the permissions used in PDF security the value to set the attribute to @returns - <TRUE/> if the value was valid and the change has been performed, - <FALSE/> if the attribute or value was invalid; attribute remains unchanged + True if the value was valid and the change has been performed, + False if the attribute or value was invalid; attribute remains unchanged */ bool SetStructureAttribute( enum StructAttribute eAttr, enum StructAttributeValue eVal ); /** set a structure attribute on the current structural element SetStructureAttributeNumerical sets an attribute of the current structural element to a new numerical value. A consistency check is performed before actually setting - the value; if the check fails, the function returns <FALSE/> and the attribute + the value; if the check fails, the function returns False and the attribute remains unchanged. @param eAttr @@ -1197,15 +1183,15 @@ The following structure describes the permissions used in PDF security the value to set the attribute to @returns - <TRUE/> if the value was valid and the change has been performed, - <FALSE/> if the attribute or value was invalid; attribute remains unchanged + True if the value was valid and the change has been performed, + False if the attribute or value was invalid; attribute remains unchanged */ bool SetStructureAttributeNumerical( enum StructAttribute eAttr, sal_Int32 nValue ); /** set the bounding box of a structural element SetStructureBoundingBox sets the BBox attribute to a new value. Since the BBox - attribute can only be applied to <code>Table</code>, <code>Figure</code>, - <code>Form</code> and <code>Formula</code> elements, a call of this function + attribute can only be applied to Table, Figure, + Form and Formula elements, a call of this function for other element types will be ignored and the BBox attribute not be set. @param rRect @@ -1265,11 +1251,14 @@ The following structure describes the permissions used in PDF security /** create a new form control This function creates a new form control in the PDF and sets its various - properties. Do not pass an actual AnyWidget as <code>rControlType</code> + properties. Do not pass an actual AnyWidget as rControlType will be cast to the type described by the type member. @param rControlType - a descendant of <code>AnyWidget</code> determing the control's properties + a descendant of AnyWidget determing the control's properties + + @param nPageNr + the page number to apply the effect to; -1 denotes the current page @returns the new control's id for reference purposes @@ -1279,9 +1268,9 @@ The following structure describes the permissions used in PDF security /** Inserts an additional stream to the PDF file This function adds an arbitrary stream to the produced PDF file. May be called - any time before <code>Emit()</code>. The stream will be written during - <code>Emit</code> by calling the <code>PDFOutputStream</code> Object's <code>write</code> - method. After the call the <code>PDFOutputStream</code> will be deleted. + any time before Emit(). The stream will be written during + Emit by calling the PDFOutputStream Object's write + method. After the call the PDFOutputStream will be deleted. All additional streams and their mimetypes will be entered into an array in the trailer dictionary. @@ -1289,7 +1278,7 @@ The following structure describes the permissions used in PDF security @param rMimeType the mimetype of the stream - @param rStream + @param pStream the interface to the additional stream @param bCompress diff --git a/include/vcl/print.hxx b/include/vcl/print.hxx index e0e113519bf5..93595fcfbc2c 100644 --- a/include/vcl/print.hxx +++ b/include/vcl/print.hxx @@ -438,13 +438,13 @@ public: For convenience a second sequence will be merged in to get a combined sequence. In case of duplicate property names, the value of i_MergeList wins. */ - com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > - getJobProperties( const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& i_rMergeList ) const; + css::uno::Sequence< css::beans::PropertyValue > + getJobProperties( const css::uno::Sequence< css::beans::PropertyValue >& i_rMergeList ) const; /* get the PropertyValue of a Property */ - com::sun::star::beans::PropertyValue* getValue( const OUString& i_rPropertyName ); - const com::sun::star::beans::PropertyValue* getValue( const OUString& i_rPropertyName ) const; + css::beans::PropertyValue* getValue( const OUString& i_rPropertyName ); + const css::beans::PropertyValue* getValue( const OUString& i_rPropertyName ) const; /* get a bool property in case the property is unknown or not convertible to bool, i_bFallback is returned */ @@ -456,16 +456,16 @@ public: /* set a property value - can also be used to add another UI property */ - void setValue( const OUString& i_rPropertyName, const com::sun::star::uno::Any& i_rValue ); - void setValue( const com::sun::star::beans::PropertyValue& i_rValue ); + void setValue( const OUString& i_rPropertyName, const css::uno::Any& i_rValue ); + void setValue( const css::beans::PropertyValue& i_rValue ); /* return the currently active UI options. These are the same that were passed to setUIOptions. */ - const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& getUIOptions() const; + const css::uno::Sequence< css::beans::PropertyValue >& getUIOptions() const; /* set possible UI options. should only be done once before passing the PrinterListener to Printer::PrintJob */ - void setUIOptions( const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& ); + void setUIOptions( const css::uno::Sequence< css::beans::PropertyValue >& ); /* enable/disable an option; this can be used to implement dialog logic. */ bool isUIOptionEnabled( const OUString& rPropName ) const; @@ -492,7 +492,7 @@ public: the paper size. */ // must be overloaded by the app, return page size in 1/100th mm - virtual com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > getPageParameters( int i_nPage ) const = 0; + virtual css::uno::Sequence< css::beans::PropertyValue > getPageParameters( int i_nPage ) const = 0; virtual void printPage( int i_nPage ) const = 0; // must be overloaded by the app virtual void jobStarted(); // will be called after a possible dialog has been shown and the real printjob starts virtual void jobFinished( com::sun::star::view::PrintableState ); @@ -529,7 +529,7 @@ public: SAL_DLLPRIVATE bool setupPrinter( Window* i_pDlgParent ); SAL_DLLPRIVATE int getPageCountProtected() const; - SAL_DLLPRIVATE com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > getPageParametersProtected( int i_nPage ) const; + SAL_DLLPRIVATE css::uno::Sequence< css::beans::PropertyValue > getPageParametersProtected( int i_nPage ) const; SAL_DLLPRIVATE sal_uLong removeTransparencies( GDIMetaFile& i_rIn, GDIMetaFile& o_rOut ); SAL_DLLPRIVATE void resetPrinterOptions( bool i_bFileOutput ); @@ -538,12 +538,12 @@ public: class VCL_DLLPUBLIC PrinterOptionsHelper { protected: - boost::unordered_map< OUString, com::sun::star::uno::Any, OUStringHash > m_aPropertyMap; - com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > m_aUIProperties; + boost::unordered_map< OUString, css::uno::Any, OUStringHash > m_aPropertyMap; + css::uno::Sequence< css::beans::PropertyValue > m_aUIProperties; public: PrinterOptionsHelper() {} // create without ui properties - PrinterOptionsHelper( const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& i_rUIProperties ) + PrinterOptionsHelper( const css::uno::Sequence< css::beans::PropertyValue >& i_rUIProperties ) : m_aUIProperties( i_rUIProperties ) {} ~PrinterOptionsHelper() @@ -553,16 +553,16 @@ class VCL_DLLPUBLIC PrinterOptionsHelper * merges changed properties and returns "true" if any occurred * if the optional output set is not NULL then the names of the changed properties are returned **/ - bool processProperties( const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& i_rNewProp, + bool processProperties( const css::uno::Sequence< css::beans::PropertyValue >& i_rNewProp, std::set< OUString >* o_pChangeProp = NULL ); /* append to a sequence of property values the ui property sequence passed at creation * as the "ExtraPrintUIOptions" property. if that sequence was empty, no "ExtraPrintUIOptions" property * will be appended. **/ - void appendPrintUIOptions( com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& io_rProps ) const; + void appendPrintUIOptions( css::uno::Sequence< css::beans::PropertyValue >& io_rProps ) const; // returns an empty Any for not existing properties - com::sun::star::uno::Any getValue( const OUString& i_rPropertyName ) const; + css::uno::Any getValue( const OUString& i_rPropertyName ) const; sal_Bool getBoolValue( const OUString& i_rPropertyName, sal_Bool i_bDefault = sal_False ) const; // convenience for fixed strings @@ -588,7 +588,7 @@ class VCL_DLLPUBLIC PrinterOptionsHelper OUString maGroupHint; sal_Bool mbInternalOnly; sal_Bool mbEnabled; - com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > maAddProps; + css::uno::Sequence< css::beans::PropertyValue > maAddProps; UIControlOptions( const OUString& i_rDependsOnName = OUString(), sal_Int32 i_nDependsOnEntry = -1, @@ -612,27 +612,27 @@ class VCL_DLLPUBLIC PrinterOptionsHelper // transported via UTF16 strings. // Show general control - static com::sun::star::uno::Any setUIControlOpt( const com::sun::star::uno::Sequence< OUString >& i_rIDs, + static css::uno::Any setUIControlOpt( const css::uno::Sequence< OUString >& i_rIDs, const OUString& i_rTitle, - const com::sun::star::uno::Sequence< OUString >& i_rHelpId, + const css::uno::Sequence< OUString >& i_rHelpId, const OUString& i_rType, - const com::sun::star::beans::PropertyValue* i_pValue = NULL, + const css::beans::PropertyValue* i_pValue = NULL, const UIControlOptions& i_rControlOptions = UIControlOptions() ); // Show and set the title of a TagPage of id i_rID - static com::sun::star::uno::Any setGroupControlOpt(const OUString& i_rID, + static css::uno::Any setGroupControlOpt(const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId); // Show and set the label of a VclFrame of id i_rID - static com::sun::star::uno::Any setSubgroupControlOpt(const OUString& i_rID, + static css::uno::Any setSubgroupControlOpt(const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId, const UIControlOptions& i_rControlOptions = UIControlOptions()); // Show a bool option as a checkbox - static com::sun::star::uno::Any setBoolControlOpt(const OUString& i_rID, + static css::uno::Any setBoolControlOpt(const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId, const OUString& i_rProperty, @@ -640,29 +640,29 @@ class VCL_DLLPUBLIC PrinterOptionsHelper const UIControlOptions& i_rControlOptions = UIControlOptions()); // Show a set of choices in a list box - static com::sun::star::uno::Any setChoiceListControlOpt(const OUString& i_rID, + static css::uno::Any setChoiceListControlOpt(const OUString& i_rID, const OUString& i_rTitle, - const com::sun::star::uno::Sequence< OUString >& i_rHelpId, + const css::uno::Sequence< OUString >& i_rHelpId, const OUString& i_rProperty, - const com::sun::star::uno::Sequence< OUString >& i_rChoices, + const css::uno::Sequence< OUString >& i_rChoices, sal_Int32 i_nValue, - const com::sun::star::uno::Sequence< sal_Bool >& i_rDisabledChoices = com::sun::star::uno::Sequence< sal_Bool >(), + const css::uno::Sequence< sal_Bool >& i_rDisabledChoices = css::uno::Sequence< sal_Bool >(), const UIControlOptions& i_rControlOptions = UIControlOptions()); // show a set of choices as radio buttons - static com::sun::star::uno::Any setChoiceRadiosControlOpt(const com::sun::star::uno::Sequence< OUString >& i_rIDs, + static css::uno::Any setChoiceRadiosControlOpt(const css::uno::Sequence< OUString >& i_rIDs, const OUString& i_rTitle, - const com::sun::star::uno::Sequence< OUString >& i_rHelpId, + const css::uno::Sequence< OUString >& i_rHelpId, const OUString& i_rProperty, - const com::sun::star::uno::Sequence< OUString >& i_rChoices, + const css::uno::Sequence< OUString >& i_rChoices, sal_Int32 i_nValue, - const com::sun::star::uno::Sequence< sal_Bool >& i_rDisabledChoices = com::sun::star::uno::Sequence< sal_Bool >(), + const css::uno::Sequence< sal_Bool >& i_rDisabledChoices = css::uno::Sequence< sal_Bool >(), const UIControlOptions& i_rControlOptions = UIControlOptions()); // show an integer range (e.g. a spin field) // note: max value < min value means do not apply min/max values - static com::sun::star::uno::Any setRangeControlOpt(const OUString& i_rID, + static css::uno::Any setRangeControlOpt(const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId, const OUString& i_rProperty, @@ -673,7 +673,7 @@ class VCL_DLLPUBLIC PrinterOptionsHelper // show a string field // note: max value < min value means do not apply min/max values - static com::sun::star::uno::Any setEditControlOpt(const OUString& i_rID, + static css::uno::Any setEditControlOpt(const OUString& i_rID, const OUString& i_rTitle, const OUString& i_rHelpId, const OUString& i_rProperty, diff --git a/include/vcl/svapp.hxx b/include/vcl/svapp.hxx index cd7759fb2b01..558d528e61b3 100644 --- a/include/vcl/svapp.hxx +++ b/include/vcl/svapp.hxx @@ -1591,7 +1591,7 @@ class VCL_DLLPUBLIC SolarMutexClearableGuard bool m_bCleared; public: /** Acquires mutex - @param pMutex pointer to mutex which is to be acquired */ + */ SolarMutexClearableGuard() : m_bCleared(false) , m_solarMutex( Application::GetSolarMutex() ) @@ -1628,7 +1628,7 @@ class VCL_DLLPUBLIC SolarMutexResettableGuard bool m_bCleared; public: /** Acquires mutex - @param pMutex pointer to mutex which is to be acquired */ + */ SolarMutexResettableGuard() : m_bCleared(false) , m_solarMutex( Application::GetSolarMutex() ) diff --git a/include/vcl/textview.hxx b/include/vcl/textview.hxx index 628132d2afeb..63835ad9e963 100644 --- a/include/vcl/textview.hxx +++ b/include/vcl/textview.hxx @@ -139,8 +139,8 @@ public: void Copy(); void Paste(); - void Copy( ::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::clipboard::XClipboard >& rxClipboard ); - void Paste( ::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::clipboard::XClipboard >& rxClipboard ); + void Copy( css::uno::Reference< css::datatransfer::clipboard::XClipboard >& rxClipboard ); + void Paste( css::uno::Reference< css::datatransfer::clipboard::XClipboard >& rxClipboard ); void Undo(); void Redo(); diff --git a/include/vcl/threadex.hxx b/include/vcl/threadex.hxx index 51876033d5e4..9433e394df39 100644 --- a/include/vcl/threadex.hxx +++ b/include/vcl/threadex.hxx @@ -204,11 +204,11 @@ inline detail::copy_back_wrapper<T> inout_by_ptr( T * p ) (e.g. for out parameters) to foreign threads, use inout_by_ref() for this purpose. For in parameters, this may not affect you, because the functor object is copy constructed into free store. This way - you must not use boost::cref()/boost::ref() or similar for objects on - your thread's stack. + you must not use \verbatim boost::cref()/boost::ref() \endverbatim or similar + for objects on your thread's stack. Use inout_by_ref() or inout_by_ptr() for this purpose, e.g. - <pre> + \code{.cpp} using namespace vcl::solarthread; long n = 3; @@ -222,7 +222,7 @@ inline detail::copy_back_wrapper<T> inout_by_ptr( T * p ) syncExecute( boost::bind( &foo, inout_by_ptr(&pc) ) ); // calling foo( char const*& rpc ): syncExecute( boost::bind( &foo, inout_by_ref(pc) ) ); - </pre> + \endcode @tpl ResultT result type, defaults to FuncT::result_type to seamlessly support mem_fn and bind diff --git a/include/vcl/throbber.hxx b/include/vcl/throbber.hxx index 9c753aa51587..78bcbf98862b 100644 --- a/include/vcl/throbber.hxx +++ b/include/vcl/throbber.hxx @@ -62,7 +62,7 @@ public: void stop(); bool isRunning() const; - void setImageList( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphic > >& ImageList ); + void setImageList( const css::uno::Sequence< css::uno::Reference< css::graphic::XGraphic > >& ImageList ); void setImageList( ::std::vector< Image > const& i_images ); // default images diff --git a/include/vcl/toolbox.hxx b/include/vcl/toolbox.hxx index ff42380414d3..b0901488e6b9 100644 --- a/include/vcl/toolbox.hxx +++ b/include/vcl/toolbox.hxx @@ -327,7 +327,7 @@ public: sal_uInt16 nPos = TOOLBOX_APPEND ); /// Insert a command (like '.uno:Save'). virtual void InsertItem( const OUString& rCommand, - const com::sun::star::uno::Reference<com::sun::star::frame::XFrame>& rFrame, + const css::uno::Reference<css::frame::XFrame>& rFrame, ToolBoxItemBits nBits = 0, const Size& rRequestedSize = Size(), sal_uInt16 nPos = TOOLBOX_APPEND ); diff --git a/include/vcl/vclenum.hxx b/include/vcl/vclenum.hxx index e5d3fbdafe46..7d7ca50a20c8 100644 --- a/include/vcl/vclenum.hxx +++ b/include/vcl/vclenum.hxx @@ -116,7 +116,7 @@ enum VclPackType }; // Return Values from Dialog::Execute -//!!! bei Aenderungen \basic\source\runtime\methods.cxx msgbox anpassen +//!!! bei Aenderungen /basic/source/runtime/methods.cxx msgbox anpassen enum VclResponseType { diff --git a/include/vcl/virdev.hxx b/include/vcl/virdev.hxx index a15e0573ccf6..d668bcb01d23 100644 --- a/include/vcl/virdev.hxx +++ b/include/vcl/virdev.hxx @@ -51,7 +51,7 @@ private: /** Used for alpha VDev, to set areas to opaque - @since #i32109# + @since \#i32109# */ SAL_DLLPRIVATE void ImplFillOpaqueRectangle( const Rectangle& rRect ); diff --git a/include/vcl/window.hxx b/include/vcl/window.hxx index 2adcc5d7783a..2fcdf0c732e5 100644 --- a/include/vcl/window.hxx +++ b/include/vcl/window.hxx @@ -465,8 +465,8 @@ public: the font to be tested @returns - <TRUE/> if the font can be used as UI font - <FALSE/> if the font is unsuitable as UI font + True if the font can be used as UI font + False if the font is unsuitable as UI font */ SAL_DLLPRIVATE bool ImplCheckUIFont( const Font& rFont ); SAL_DLLPRIVATE void ImplUpdateGlobalSettings( AllSettings& rSettings, sal_Bool bCallHdl = sal_True ); diff --git a/include/vcl/wrkwin.hxx b/include/vcl/wrkwin.hxx index 4b1d843943ab..942ed10c9c76 100644 --- a/include/vcl/wrkwin.hxx +++ b/include/vcl/wrkwin.hxx @@ -72,7 +72,7 @@ public: void ShowFullScreenMode( sal_Bool bFullScreenMode, sal_Int32 nDisplayScreen ); /** - @overload Calls ShowFullScreenMode( bFullScreenMode, GetScreenNumber()). + @overload void ShowFullScreenMode(sal_Bool bFullScreenMode, sal_Int32 nDisplayScreen) */ void ShowFullScreenMode( sal_Bool bFullScreenMode = sal_True ); void EndFullScreenMode() { ShowFullScreenMode( sal_False ); } @@ -82,7 +82,7 @@ public: sal_uInt16 nFlags, sal_Int32 nDisplayScreen ); /** - @overload Calls StartPresentationMode( bFullScreenMode, nFlags, GetScreenNumber()). + @overload void StartPresentationMode( sal_Bool bPresentation, sal_uInt16 nFlags, sal_uInt32 nDisplayScreen) */ void StartPresentationMode( sal_Bool bPresentation = sal_True, sal_uInt16 nFlags = 0 ); |