diff options
Diffstat (limited to 'include/unotools')
33 files changed, 286 insertions, 286 deletions
diff --git a/include/unotools/accessiblerelationsethelper.hxx b/include/unotools/accessiblerelationsethelper.hxx index 12a4fdb9a8d3..135492c420a0 100644 --- a/include/unotools/accessiblerelationsethelper.hxx +++ b/include/unotools/accessiblerelationsethelper.hxx @@ -34,14 +34,14 @@ class AccessibleRelationSetHelperImpl; -//========================================================================= + //= XAccessibleRelationSet helper classes -//========================================================================= + //... namespace utl ....................................................... namespace utl { -//......................................................................... + /** @descr This base class provides an implementation of the @@ -145,7 +145,7 @@ private: AccessibleRelationSetHelperImpl* mpHelperImpl; }; -//......................................................................... + } //... namespace utl ....................................................... #endif diff --git a/include/unotools/accessiblestatesethelper.hxx b/include/unotools/accessiblestatesethelper.hxx index f1cce0691bb7..bbccf61937b5 100644 --- a/include/unotools/accessiblestatesethelper.hxx +++ b/include/unotools/accessiblestatesethelper.hxx @@ -33,14 +33,14 @@ class AccessibleStateSetHelperImpl; -//========================================================================= + //= XAccessibleStateSet helper classes -//========================================================================= + //... namespace utl ....................................................... namespace utl { -//......................................................................... + /** @descr This base class provides an implementation of the @@ -153,7 +153,7 @@ private: AccessibleStateSetHelperImpl* mpHelperImpl; }; -//......................................................................... + } //... namespace utl ....................................................... #endif diff --git a/include/unotools/closeveto.hxx b/include/unotools/closeveto.hxx index 45086de72f21..1f23c11d396b 100644 --- a/include/unotools/closeveto.hxx +++ b/include/unotools/closeveto.hxx @@ -26,14 +26,14 @@ #include <boost/scoped_ptr.hpp> -//...................................................................................................................... + namespace utl { -//...................................................................................................................... - //================================================================================================================== + + //= CloseVeto - //================================================================================================================== + struct CloseVeto_Data; /** will add a XCloseListener to a given component, and veto its closing as long as the <code>CloseVeto</code> instance is alive. @@ -51,9 +51,9 @@ namespace utl ::boost::scoped_ptr< CloseVeto_Data > m_pData; }; -//...................................................................................................................... + } // namespace dbaui -//...................................................................................................................... + #endif // INCLUDED_UNOTOOLS_CLOSEVETO_HXX diff --git a/include/unotools/cmdoptions.hxx b/include/unotools/cmdoptions.hxx index a8bfba2fe7d0..ad53ee0b769e 100644 --- a/include/unotools/cmdoptions.hxx +++ b/include/unotools/cmdoptions.hxx @@ -27,12 +27,12 @@ #include <rtl/ustring.hxx> #include <unotools/options.hxx> -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr The method GetList() returns a list of property values. Use follow defines to separate values by names. *//*-*************************************************************************************************************/ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -41,7 +41,7 @@ class SvtCommandOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about dynamic menus @descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard". @@ -63,7 +63,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: CMDOPTION_NONE }; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -82,7 +82,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: SvtCommandOptions(); virtual ~SvtCommandOptions(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return complete specified list @descr Call it to get all entries of an dynamic menu. We return a list of all nodes with his names and properties. @@ -97,7 +97,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: bool HasEntries( CmdOption eOption ) const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short Lookup if a command URL is inside a given list @descr Lookup if a command URL is inside a given lst @@ -112,7 +112,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: bool Lookup( CmdOption eOption, const OUString& aCommandURL ) const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short register an office frame, which must update its dispatches if the underlying configuration was changed. @@ -131,7 +131,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! diff --git a/include/unotools/compatibility.hxx b/include/unotools/compatibility.hxx index 1b47c5f24b63..a9afa0c9753d 100644 --- a/include/unotools/compatibility.hxx +++ b/include/unotools/compatibility.hxx @@ -26,9 +26,9 @@ #include <com/sun/star/beans/PropertyValue.hpp> #include <unotools/options.hxx> -//_________________________________________________________________________________________________________________ + // types, enums, ... -//_________________________________________________________________________________________________________________ + enum CompatibilityOptions { @@ -45,7 +45,7 @@ enum CompatibilityOptions COPT_EXPAND_WORDSPACE }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr The method GetList() returns a list of property values. Use follow defines to separate values by names. *//*-*************************************************************************************************************/ @@ -65,11 +65,11 @@ enum CompatibilityOptions #define COMPATIBILITY_DEFAULT_NAME OUString( "_default" ) -//_________________________________________________________________________________________________________________ + // forward declarations -//_________________________________________________________________________________________________________________ -/*-************************************************************************************************************//** + +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -78,7 +78,7 @@ enum CompatibilityOptions class SvtCompatibilityOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about dynamic menus @descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard". @@ -90,17 +90,17 @@ class SvtCompatibilityOptions_Impl; class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -119,11 +119,11 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options SvtCompatibilityOptions(); virtual ~SvtCompatibilityOptions(); - //--------------------------------------------------------------------------------------------------------- + // interface - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short clear complete specified list @descr Call this methods to clear the whole list. @@ -139,7 +139,7 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options void SetDefault( OUString sName, bool bValue ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return complete specified list @descr Call it to get all entries of compatibility options. We return a list of all nodes with its names and properties. @@ -154,7 +154,7 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > > GetList() const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short append a new item @descr @@ -194,13 +194,13 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options bool IsConsiderWrappingStyle() const; bool IsExpandWordSpace() const; - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! @@ -216,9 +216,9 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/include/unotools/componentresmodule.hxx b/include/unotools/componentresmodule.hxx index 64f4c886fa30..9c89affe7c7b 100644 --- a/include/unotools/componentresmodule.hxx +++ b/include/unotools/componentresmodule.hxx @@ -28,16 +28,16 @@ class ResMgr; -//........................................................................ + namespace utl { -//........................................................................ + class OComponentResModuleImpl; - //==================================================================== + //= OComponentResourceModule - //==================================================================== + /** extends the comphelper::OModule implementation with simply resource access */ @@ -62,9 +62,9 @@ namespace utl virtual void onLastClient(); }; - //========================================================================= + //= ModuleRes - //========================================================================= + /** specialized ResId, using the resource manager provided by a given OModule */ class UNOTOOLS_DLLPUBLIC ModuleRes : public ::ResId @@ -73,9 +73,9 @@ namespace utl ModuleRes( sal_uInt16 _nId, OComponentResourceModule& _rModule ) : ResId( _nId, *_rModule.getResManager() ) { } }; - //==================================================================== + //= defining a concrete module - //==================================================================== + #define DEFINE_MODULE( ModuleClass, ClientClass, ResClass ) \ /* -------------------------------------------------------------------- */ \ class ModuleClass : public ::utl::OComponentResourceModule \ @@ -140,9 +140,9 @@ namespace utl } \ }; - //==================================================================== + //= implementing a concrete module - //==================================================================== + #define IMPLEMENT_MODULE( ModuleClass, resprefix ) \ struct CreateModuleClass \ { \ @@ -171,9 +171,9 @@ namespace utl create( CreateModuleClass(), ::osl::GetGlobalMutex() ); \ } \ -//........................................................................ + } // namespace utl -//........................................................................ + #endif // INCLUDED_UNOTOOLS_COMPONENTRESMODULE_HXX diff --git a/include/unotools/configitem.hxx b/include/unotools/configitem.hxx index d278ccba6b7c..7865bdb3f60c 100644 --- a/include/unotools/configitem.hxx +++ b/include/unotools/configitem.hxx @@ -27,7 +27,7 @@ #include <unotools/unotoolsdllapi.h> #include <unotools/options.hxx> -//----------------------------------------------------------------------------- + namespace com{ namespace sun{ namespace star{ namespace uno{ class Any; @@ -42,7 +42,7 @@ namespace com{ namespace sun{ namespace star{ class XChangesListener; } }}} -//----------------------------------------------------------------------------- + namespace utl { #define CONFIG_MODE_IMMEDIATE_UPDATE 0x00 @@ -82,7 +82,7 @@ namespace utl void CallNotify( const com::sun::star::uno::Sequence<OUString>& aPropertyNames); - //*********************************************************************************************************************** + // In special mode ALL_LOCALES we must support reading/writing of localized cfg entries as Sequence< PropertyValue >. // These methods are helper to convert given lists of names and Any-values. // format: PropertyValue.Name = <locale as ISO string> diff --git a/include/unotools/confignode.hxx b/include/unotools/confignode.hxx index 295569de4c1b..50ed8e98af2b 100644 --- a/include/unotools/confignode.hxx +++ b/include/unotools/confignode.hxx @@ -33,14 +33,14 @@ namespace comphelper class ComponentContext; } -//........................................................................ + namespace utl { -//........................................................................ - //======================================================================== + + //= OConfigurationNode - //======================================================================== + class OConfigurationTreeRoot; /** a small wrapper around a configuration node.<p/> Nodes in the terminology used herein are <em>inner</em> nodes of a configuration @@ -178,7 +178,7 @@ namespace utl /// invalidate the object virtual void clear() throw(); - // ----------------------- + // meta information about the node /// checks whether or not the object represents a set node. @@ -211,9 +211,9 @@ namespace utl OUString normalizeName(const OUString& _rName, NAMEORIGIN _eOrigin) const; }; - //======================================================================== + //= OConfigurationTreeRoot - //======================================================================== + /** a specialized version of a OConfigurationNode, representing the root of a configuration sub tree<p/> Only this class is able to commit any changes made any any OConfigurationNode @@ -316,9 +316,9 @@ namespace utl virtual void clear() throw(); }; -//........................................................................ + } // namespace utl -//........................................................................ + #endif // INCLUDED_UNOTOOLS_CONFIGNODE_HXX diff --git a/include/unotools/configpaths.hxx b/include/unotools/configpaths.hxx index c8a1f1b3b8a2..a4a937e8bc4b 100644 --- a/include/unotools/configpaths.hxx +++ b/include/unotools/configpaths.hxx @@ -23,10 +23,10 @@ #include <sal/types.h> #include <rtl/ustring.hxx> -//---------------------------------------------------------------------------- + namespace utl { -//---------------------------------------------------------------------------- + /** extract the local nodename and the parent nodepath from a configuration path. @@ -56,7 +56,7 @@ namespace utl OUString& _rsOutPath, OUString& _rsLocalName); -//---------------------------------------------------------------------------- + /** extract the first nodename from a configuration path. @param _sInPath @@ -77,7 +77,7 @@ namespace utl UNOTOOLS_DLLPUBLIC OUString extractFirstFromConfigurationPath( OUString const& _sInPath, OUString* _sOutPath = 0); -//---------------------------------------------------------------------------- + /** check whether a path is to a nested node with respect to a parent path. @param _sNestedPath @@ -101,7 +101,7 @@ namespace utl bool isPrefixOfConfigurationPath(OUString const& _sNestedPath, OUString const& _sPrefixPath); -//---------------------------------------------------------------------------- + /** get the relative path to a nested node with respect to a parent path. @param _sNestedPath @@ -126,7 +126,7 @@ namespace utl UNOTOOLS_DLLPUBLIC OUString dropPrefixFromConfigurationPath(OUString const& _sNestedPath, OUString const& _sPrefixPath); -//---------------------------------------------------------------------------- + /** Create a one-level relative configuration path from a set element name without a known set element type. @@ -141,7 +141,7 @@ namespace utl */ UNOTOOLS_DLLPUBLIC OUString wrapConfigurationElementName(OUString const& _sElementName); -//---------------------------------------------------------------------------- + /** Create a one-level relative configuration path from a set element name and a known set element type. @@ -161,9 +161,9 @@ namespace utl OUString wrapConfigurationElementName(OUString const& _sElementName, OUString const& _sTypeName); -//---------------------------------------------------------------------------- + } // namespace utl -//---------------------------------------------------------------------------- + #endif // INCLUDED_UNOTOOLS_CONFIGPATHS_HXX diff --git a/include/unotools/configvaluecontainer.hxx b/include/unotools/configvaluecontainer.hxx index 5e3b738f2e2b..14a9dfc7a4e1 100644 --- a/include/unotools/configvaluecontainer.hxx +++ b/include/unotools/configvaluecontainer.hxx @@ -23,10 +23,10 @@ #include <com/sun/star/uno/XComponentContext.hpp> #include <osl/mutex.hxx> -//......................................................................... + namespace utl { -//......................................................................... + #define CVC_READONLY_ACCESS 0x0000 #define CVC_UPDATE_ACCESS 0x0001 @@ -36,9 +36,9 @@ namespace utl struct OConfigurationValueContainerImpl; struct NodeValueAccessor; - //===================================================================== + //= OConfigurationValueContainer - //===================================================================== + /** allows simple access to static configuration structures. <p>The basic idea of this class is that it's clients (usually derived classes) simply register an @@ -64,7 +64,7 @@ namespace utl m_pImpl; protected: - //----------------------------------------------------------------- + // construction/destruction /** constructs the object @@ -94,7 +94,7 @@ namespace utl /// dtor ~OConfigurationValueContainer(); - //----------------------------------------------------------------- + // registering data containers /** registers a data accessor of an arbitrary type. @@ -174,9 +174,9 @@ namespace utl void implRegisterExchangeLocation( const NodeValueAccessor& _rAccessor ); }; -//......................................................................... + } // namespace utl -//......................................................................... + #endif // INCLUDED_UNOTOOLS_CONFIGVALUECONTAINER_HXX diff --git a/include/unotools/datetime.hxx b/include/unotools/datetime.hxx index cb34dbd8beb0..3887df2df5e2 100644 --- a/include/unotools/datetime.hxx +++ b/include/unotools/datetime.hxx @@ -31,10 +31,10 @@ class Date; class Time; class DateTime; -//......................................................................... + namespace utl { -//......................................................................... + namespace starutil = ::com::sun::star::util; @@ -49,9 +49,9 @@ namespace utl UNOTOOLS_DLLPUBLIC bool ISO8601parseDate(const ::rtl::OUString &i_rIn, starutil::Date& o_rDate); UNOTOOLS_DLLPUBLIC bool ISO8601parseTime(const ::rtl::OUString &i_rIn, starutil::Time& o_Time); -//......................................................................... + } // namespace utl -//......................................................................... + #endif // INCLUDED_UNOTOOLS_DATETIME_HXX diff --git a/include/unotools/desktopterminationobserver.hxx b/include/unotools/desktopterminationobserver.hxx index d817a1b8d7f8..4e9872ed2351 100644 --- a/include/unotools/desktopterminationobserver.hxx +++ b/include/unotools/desktopterminationobserver.hxx @@ -21,14 +21,14 @@ #ifndef INCLUDED_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX #define INCLUDED_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX -//........................................................................ + namespace utl { -//........................................................................ - //==================================================================== + + //= ITerminationListener - //==================================================================== + /** non-UNO version of the com.sun.star.frame::XTerminateListener */ class ITerminationListener @@ -41,9 +41,9 @@ namespace utl ~ITerminationListener() {} }; - //==================================================================== + //= DesktopTerminationObserver - //==================================================================== + /** a class which allows non-UNO components to observe the desktop (aka application) for it's shutdown */ @@ -63,9 +63,9 @@ namespace utl DesktopTerminationObserver(); // never implemented, only static methods }; -//........................................................................ + } // namespace utl -//........................................................................ + #endif // INCLUDED_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX diff --git a/include/unotools/dynamicmenuoptions.hxx b/include/unotools/dynamicmenuoptions.hxx index 864743eca9c5..7f057e5b8fcf 100644 --- a/include/unotools/dynamicmenuoptions.hxx +++ b/include/unotools/dynamicmenuoptions.hxx @@ -26,7 +26,7 @@ #include <com/sun/star/beans/PropertyValue.hpp> #include <unotools/options.hxx> -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr The method GetList() returns a list of property values. Use follow defines to separate values by names. *//*-*************************************************************************************************************/ @@ -35,7 +35,7 @@ #define DYNAMICMENU_PROPERTYNAME_IMAGEIDENTIFIER OUString("ImageIdentifier") #define DYNAMICMENU_PROPERTYNAME_TARGETNAME OUString("TargetName") -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr You can use these enum values to specify right menu if you call our interface methods. *//*-*************************************************************************************************************/ enum EDynamicMenuType @@ -45,7 +45,7 @@ enum EDynamicMenuType E_HELPBOOKMARKS = 2 }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -54,7 +54,7 @@ enum EDynamicMenuType class SvtDynamicMenuOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about dynamic menus @descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard". @@ -67,7 +67,7 @@ class SvtDynamicMenuOptions_Impl; class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtDynamicMenuOptions : public utl::detail::Options { public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -86,7 +86,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtDynamicMenuOptions : public utl::det SvtDynamicMenuOptions(); virtual ~SvtDynamicMenuOptions(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return complete specified list @descr Call it to get all entries of an dynamic menu. We return a list of all nodes with his names and properties. @@ -102,7 +102,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtDynamicMenuOptions : public utl::det ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > > GetMenu( EDynamicMenuType eMenu ) const; private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! diff --git a/include/unotools/eventlisteneradapter.hxx b/include/unotools/eventlisteneradapter.hxx index 394c910be956..88d5e29c8d89 100644 --- a/include/unotools/eventlisteneradapter.hxx +++ b/include/unotools/eventlisteneradapter.hxx @@ -22,15 +22,15 @@ #define INCLUDED_UNOTOOLS_EVENTLISTENERADAPTER_HXX #include <com/sun/star/lang/XComponent.hpp> -//......................................................................... + namespace utl { -//......................................................................... + struct OEventListenerAdapterImpl; - //===================================================================== + //= OEventListenerAdapter - //===================================================================== + /** base class for non-UNO dispose listeners */ class UNOTOOLS_DLLPUBLIC OEventListenerAdapter @@ -55,9 +55,9 @@ namespace utl virtual void _disposing( const ::com::sun::star::lang::EventObject& _rSource ) = 0; }; -//......................................................................... + } // namespace utl -//......................................................................... + #endif // INCLUDED_UNOTOOLS_EVENTLISTENERADAPTER_HXX diff --git a/include/unotools/extendedsecurityoptions.hxx b/include/unotools/extendedsecurityoptions.hxx index c75bb955cb90..8569c64ca2c1 100644 --- a/include/unotools/extendedsecurityoptions.hxx +++ b/include/unotools/extendedsecurityoptions.hxx @@ -26,7 +26,7 @@ #include <rtl/ustring.hxx> #include <unotools/options.hxx> -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -35,7 +35,7 @@ class SvtExtendedSecurityOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about security features @descr - @@ -58,7 +58,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtExtendedSecurityOptions : public utl OPEN_ALWAYS }; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -81,7 +81,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtExtendedSecurityOptions : public utl private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! @@ -97,9 +97,9 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtExtendedSecurityOptions : public utl UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetInitMutex(); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/include/unotools/fltrcfg.hxx b/include/unotools/fltrcfg.hxx index f2467835b104..b95242fe4b12 100644 --- a/include/unotools/fltrcfg.hxx +++ b/include/unotools/fltrcfg.hxx @@ -19,7 +19,7 @@ #ifndef INCLUDED_UNOTOOLS_FLTRCFG_HXX #define INCLUDED_UNOTOOLS_FLTRCFG_HXX -// ----------------------------------------------------------------------- + #include <unotools/unotoolsdllapi.h> #include <unotools/configitem.hxx> diff --git a/include/unotools/fontcvt.hxx b/include/unotools/fontcvt.hxx index 2a2310734669..a8974588b47d 100644 --- a/include/unotools/fontcvt.hxx +++ b/include/unotools/fontcvt.hxx @@ -24,9 +24,9 @@ #include <rtl/ustring.hxx> #include <tools/solar.h> -// ------------------ + // - FontToSubsFont - -// ------------------ + #define FONTTOSUBSFONT_IMPORT ((sal_uLong)0x00000001) #define FONTTOSUBSFONT_EXPORT ((sal_uLong)0x00000002) @@ -38,9 +38,9 @@ UNOTOOLS_DLLPUBLIC void DestroyFontToSubsFontConverter( F UNOTOOLS_DLLPUBLIC sal_Unicode ConvertFontToSubsFontChar( FontToSubsFontConverter hConverter, sal_Unicode c ); UNOTOOLS_DLLPUBLIC OUString GetFontToSubsFontName( FontToSubsFontConverter hConverter ); -// --------------------------- + // - StarSymbolToMSMultiFont - -// --------------------------- + class UNOTOOLS_DLLPUBLIC StarSymbolToMSMultiFont { diff --git a/include/unotools/fontdefs.hxx b/include/unotools/fontdefs.hxx index 68d35f06aba7..8bc32d04c495 100644 --- a/include/unotools/fontdefs.hxx +++ b/include/unotools/fontdefs.hxx @@ -30,9 +30,9 @@ namespace utl { struct FontNameAttr; } -// ---------------- + // - SubsFontName - -// ---------------- + #define SUBSFONT_ONLYONE ((sal_uLong)0x00000001) #define SUBSFONT_MS ((sal_uLong)0x00000002) @@ -45,9 +45,9 @@ UNOTOOLS_DLLPUBLIC void AddTokenFontName( OUString& rName, const OUString& rNewT struct UNOTOOLS_DLLPUBLIC FontNameHash { int operator()(const OUString&) const; }; -// --------------- + // - ConvertChar - -// --------------- + class UNOTOOLS_DLLPUBLIC ConvertChar { diff --git a/include/unotools/fontoptions.hxx b/include/unotools/fontoptions.hxx index 39c881f1dc88..c62f7dd34d66 100644 --- a/include/unotools/fontoptions.hxx +++ b/include/unotools/fontoptions.hxx @@ -25,7 +25,7 @@ #include <rtl/ustring.hxx> #include <unotools/options.hxx> -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -34,7 +34,7 @@ class SvtFontOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about font features @descr - @@ -47,7 +47,7 @@ class SvtFontOptions_Impl; class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtFontOptions : public utl::detail::Options { public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -66,7 +66,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtFontOptions : public utl::detail::Op SvtFontOptions(); virtual ~SvtFontOptions(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short interface methods to get and set value of config key "org.openoffice.Office.Common/Font" @descr These values defines different states of font handling. @@ -95,7 +95,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtFontOptions : public utl::detail::Op void EnableFontWYSIWYG ( bool bState ) ; private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class use his own static mutex to be threadsafe. We create a static mutex only for one ime and use at different times. diff --git a/include/unotools/historyoptions.hxx b/include/unotools/historyoptions.hxx index 1fdddf6dd54c..3aaff6e7ac2b 100644 --- a/include/unotools/historyoptions.hxx +++ b/include/unotools/historyoptions.hxx @@ -27,7 +27,7 @@ #include <rtl/ustring.hxx> #include <unotools/options.hxx> -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr The method GetList() returns a list of property values. Use follow defines to separate values by names. *//*-*************************************************************************************************************/ @@ -38,7 +38,7 @@ #define HISTORY_PROPERTYNAME_PASSWORD OUString("Password") #define HISTORY_PROPERTYNAME_THUMBNAIL OUString("Thumbnail") -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr You can use these enum values to specify right history if you call ouer interface methods. *//*-*************************************************************************************************************/ @@ -49,7 +49,7 @@ enum EHistoryType eHELPBOOKMARKS = 2 }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -58,7 +58,7 @@ enum EHistoryType class SvtHistoryOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about history features @descr - @@ -71,7 +71,7 @@ class SvtHistoryOptions_Impl; class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail::Options { public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -90,13 +90,13 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: SvtHistoryOptions(); virtual ~SvtHistoryOptions(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short interface methods to get and set value of config key "org.openoffice.Office.Common/History/..." @descr key "PickList" : The last used documents displayed in the file menu. key "History" : The last opened documents general. *//*-*****************************************************************************************************/ - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short set/get max size of specified history @descr Call this methods to get information about max. size of specified list. These value lay down the max count of items in these history. If a new one @@ -114,7 +114,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: sal_uInt32 GetSize( EHistoryType eHistory ) const ; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short clear complete sepcified list @descr Call this methods to clear the whole list. After that GetItemCount() will return 0 ... but GetSize() will return the old value! @@ -129,7 +129,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: void Clear( EHistoryType eHistory ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return complete sepcified list @descr If you will show the whole list call this method to get it completely. @@ -143,7 +143,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > > GetList( EHistoryType eHistory ) const ; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short append a new item to specified list @descr You can append items to a list only - removing isn't allowed for a special item! The oldest entry is deleted automaticly if max size arrived or you can call Clear() ... @@ -169,7 +169,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr Make these class threadsafe. diff --git a/include/unotools/idhelper.hxx b/include/unotools/idhelper.hxx index bbbe959b52a3..63e13ce002da 100644 --- a/include/unotools/idhelper.hxx +++ b/include/unotools/idhelper.hxx @@ -30,12 +30,12 @@ #include <cppuhelper/typeprovider.hxx> #include <tools/debug.hxx> -//......................................................................... + namespace utl { -//......................................................................... -//========================================================================= + + // to shorten some lines ... typedef ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > TypeSequence; @@ -74,11 +74,11 @@ public: typedef std::map<TypeSequence, ::cppu::OImplementationId, TypeSequenceLess> MapType2Id; -//......................................................................... + } // namespace utl -//......................................................................... -//========================================================================= + + /** defines a helper class for implementing the XTypeProvider::getImplementationId. it maps sequences of ::com::sun::star::uno::Type to implementation ids (which means sequences of bytes).<BR> diff --git a/include/unotools/itemholderbase.hxx b/include/unotools/itemholderbase.hxx index 7b153f637252..16d40fff9451 100644 --- a/include/unotools/itemholderbase.hxx +++ b/include/unotools/itemholderbase.hxx @@ -34,57 +34,57 @@ struct ItemHolderMutexBase enum EItem { E_ACCESSIBILITYOPTIONS , // 2 - E_ADDXMLTOSTORAGEOPTIONS , // + E_ADDXMLTOSTORAGEOPTIONS , E_APEARCFG , // 2 E_CJKOPTIONS , // 2 - E_CMDOPTIONS , // + E_CMDOPTIONS , E_COLORCFG , // 2 - E_COMPATIBILITY , // + E_COMPATIBILITY , E_CTLOPTIONS , // 2 - E_DEFAULTOPTIONS , // - E_DYNAMICMENUOPTIONS , // + E_DEFAULTOPTIONS , + E_DYNAMICMENUOPTIONS , - E_EVENTCFG , // - E_EXTENDEDSECURITYOPTIONS , // + E_EVENTCFG , + E_EXTENDEDSECURITYOPTIONS , - E_FLTRCFG , // - E_FONTOPTIONS , // + E_FLTRCFG , + E_FONTOPTIONS , E_FONTSUBSTCONFIG , // 2 E_HELPOPTIONS , // 2 - E_HISTORYOPTIONS , // + E_HISTORYOPTIONS , E_LANGUAGEOPTIONS , // 2 - E_LINGUCFG , // - E_LOCALISATIONOPTIONS , // + E_LINGUCFG , + E_LOCALISATIONOPTIONS , - E_MENUOPTIONS , // + E_MENUOPTIONS , E_MISCCFG , // 2 - E_MISCOPTIONS , // - E_MODULEOPTIONS , // + E_MISCOPTIONS , + E_MODULEOPTIONS , - E_OPTIONSDLGOPTIONS , // + E_OPTIONSDLGOPTIONS , - E_PATHOPTIONS , // + E_PATHOPTIONS , E_PRINTOPTIONS , // 2 E_PRINTFILEOPTIONS , // 2 - E_PRINTWARNINGOPTIONS , // + E_PRINTWARNINGOPTIONS , - E_REGOPTIONS , // + E_REGOPTIONS , - E_SAVEOPTIONS , // - E_SEARCHOPT , // - E_SECURITYOPTIONS , // + E_SAVEOPTIONS , + E_SEARCHOPT , + E_SECURITYOPTIONS , E_SYSLOCALEOPTIONS , // 2 E_USEROPTIONS , // 2 - E_VIEWOPTIONS_DIALOG , // - E_VIEWOPTIONS_TABDIALOG , // - E_VIEWOPTIONS_TABPAGE , // - E_VIEWOPTIONS_WINDOW // + E_VIEWOPTIONS_DIALOG , + E_VIEWOPTIONS_TABDIALOG , + E_VIEWOPTIONS_TABPAGE , + E_VIEWOPTIONS_WINDOW }; struct TItemInfo diff --git a/include/unotools/lingucfg.hxx b/include/unotools/lingucfg.hxx index 8ce4961c472c..1c5c76f479be 100644 --- a/include/unotools/lingucfg.hxx +++ b/include/unotools/lingucfg.hxx @@ -162,16 +162,16 @@ public: SvtLinguConfig(); virtual ~SvtLinguConfig(); - // + // borrowed from utl::ConfigItem - // + com::sun::star::uno::Sequence< OUString > GetNodeNames( const OUString &rNode ); - // + com::sun::star::uno::Sequence< com::sun::star::uno::Any > GetProperties( const com::sun::star::uno::Sequence< OUString > &rNames ); - // + bool ReplaceSetProperties( const OUString &rNode, @@ -196,7 +196,7 @@ public: //! linguistic configuration only //! bool GetElementNamesFor( const OUString &rNodeName, com::sun::star::uno::Sequence< OUString > &rElementNames ) const; - // + bool GetSupportedDictionaryFormatsFor( const OUString &rSetName, const OUString &rSetEntry, com::sun::star::uno::Sequence< OUString > &rFormatList ) const; bool GetDictionaryEntry( const OUString &rNodeName, SvtLinguConfigDictionaryEntry &rDicEntry ) const; diff --git a/include/unotools/localisationoptions.hxx b/include/unotools/localisationoptions.hxx index d359c374ee19..da77f65d68fb 100644 --- a/include/unotools/localisationoptions.hxx +++ b/include/unotools/localisationoptions.hxx @@ -24,7 +24,7 @@ #include <osl/mutex.hxx> #include <unotools/options.hxx> -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -33,7 +33,7 @@ class SvtLocalisationOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about localisation features @descr - @@ -46,7 +46,7 @@ class SvtLocalisationOptions_Impl; class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtLocalisationOptions : public utl::detail::Options { public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -65,7 +65,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtLocalisationOptions : public utl::de SvtLocalisationOptions(); virtual ~SvtLocalisationOptions(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short interface methods to get and set value of config key "org.openoffice.Office.Common/View/Localisation/AutoMnemonic" @descr These value specifies if shortcuts should be assigned automatically. @@ -79,7 +79,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtLocalisationOptions : public utl::de bool IsAutoMnemonic ( ) const ; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short interface methods to get and set value of config key "org.openoffice.Office.Common/View/Localisation/DialogScale" @descr These value specifies the factor for increasing controls. Value from [0..100] are allowed. @@ -100,7 +100,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtLocalisationOptions : public utl::de sal_Int32 GetDialogScale( ) const ; private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! diff --git a/include/unotools/mediadescriptor.hxx b/include/unotools/mediadescriptor.hxx index fc4864f0e29e..d3f2003914a5 100644 --- a/include/unotools/mediadescriptor.hxx +++ b/include/unotools/mediadescriptor.hxx @@ -50,7 +50,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap { public: - //--------------------------------------- + /** @short these methods can be used to get the different property names as static const OUString values. @@ -100,10 +100,10 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap static const OUString& PROP_VIEWONLY(); static const OUString& PROP_DOCUMENTBASEURL(); - //------------------------------------------- + // interface public: - //--------------------------------------- + /** @short these ctors do nothing - excepting that they forward the given parameters to the base class ctors. @@ -113,7 +113,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap MediaDescriptor(); MediaDescriptor(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& lSource); - //--------------------------------------- + /** @short it checks if the descriptor already has a valid InputStream item and creates a new one, if not. @@ -131,7 +131,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap */ bool addInputStream(); - //--------------------------------------- + /** @short it checks if the descriptor already has a valid InputStream item and creates a new one, if not. @@ -150,7 +150,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap */ bool addInputStreamOwnLock(); - //--------------------------------------- + /** @short it checks if the descriptor describes a readonly stream. @descr The descriptor itself isnt changed doing so. @@ -170,7 +170,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap */ bool isStreamReadOnly() const; - //--------------------------------------- + /** Returns a value from the sequence contained in the property 'ComponentData' of this media descriptor. @@ -185,7 +185,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap ::com::sun::star::uno::Any getComponentDataEntry( const OUString& rName ) const; - //--------------------------------------- + /** Inserts a value into the sequence contained in the property 'ComponentData' of the media descriptor. @@ -205,7 +205,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap const OUString& rName, const ::com::sun::star::uno::Any& rValue ); - //--------------------------------------- + /** Removes a value from the sequence contained in the property 'ComponentData' of the media descriptor. @@ -265,11 +265,11 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap comphelper::DocPasswordRequestType eRequestType, const ::std::vector< OUString >* pDefaultPasswords = 0 ); - //------------------------------------------- + // helper private: - //--------------------------------------- + /** @short tries to open a stream by using the given PostData stream. @descr The stream is used directly ... @@ -293,7 +293,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& _rxPostData ) throw(::com::sun::star::uno::RuntimeException); - //--------------------------------------- + /** @short tries to open a stream by using the given URL. @descr First it tries to open the content in r/w mode (if its @@ -320,7 +320,7 @@ class UNOTOOLS_DLLPUBLIC MediaDescriptor : public comphelper::SequenceAsHashMap bool bLockFile ) throw(::com::sun::star::uno::RuntimeException); - //--------------------------------------- + /** @short it checks if the descriptor already has a valid InputStream item and creates a new one, if not. diff --git a/include/unotools/moduleoptions.hxx b/include/unotools/moduleoptions.hxx index 4ef1236633ba..9dac7166bcc5 100644 --- a/include/unotools/moduleoptions.hxx +++ b/include/unotools/moduleoptions.hxx @@ -38,7 +38,7 @@ #define FEATUREFLAG_IMPRESS 0x00008000 #define FEATUREFLAG_INSIGHT 0x00010000 -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -46,7 +46,7 @@ *//*-*************************************************************************************************************/ class SvtModuleOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about installation state of modules @descr Use these class to get installation state of different office modules like writer, calc etc Further you can ask for additional information; e.g. name of standard template file, which @@ -118,21 +118,21 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtModuleOptions : public utl::detail:: void SetFactoryDefaultFilter ( EFactory eFactory , const OUString& sFilter ); - //_______________________________________ + /** @short return the corresponding application ID for the given document service name. */ static EFactory ClassifyFactoryByServiceName(const OUString& sName); - //_______________________________________ + /** @short return the corresponding application ID for the given short name. */ static EFactory ClassifyFactoryByShortName(const OUString& sName); - //_______________________________________ + /** @short return the corresponding application ID for the given properties. @@ -155,7 +155,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtModuleOptions : public utl::detail:: static EFactory ClassifyFactoryByURL(const OUString& sURL , const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& lMediaDescriptor); - //_______________________________________ + /** @short return the corresponding application ID for the given properties. diff --git a/include/unotools/printwarningoptions.hxx b/include/unotools/printwarningoptions.hxx index c83a1ed63260..d85094d88216 100644 --- a/include/unotools/printwarningoptions.hxx +++ b/include/unotools/printwarningoptions.hxx @@ -26,7 +26,7 @@ #include <rtl/ustring.hxx> #include <unotools/options.hxx> -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -35,7 +35,7 @@ class SvtPrintWarningOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about startup features @descr - @@ -48,7 +48,7 @@ class SvtPrintWarningOptions_Impl; class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtPrintWarningOptions : public utl::detail::Options { public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -67,7 +67,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtPrintWarningOptions : public utl::de SvtPrintWarningOptions(); virtual ~SvtPrintWarningOptions(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short interface methods to get and set value of config key "org.openoffice.Office.Common/Print/Warning..." @descr These options describe internal states to enable/disable features of installed office. @@ -86,7 +86,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtPrintWarningOptions : public utl::de private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class use his own static mutex to be threadsafe. We create a static mutex only for one ime and use at different times. diff --git a/include/unotools/searchopt.hxx b/include/unotools/searchopt.hxx index 6b05a2c6bbd0..0067b7da23ae 100644 --- a/include/unotools/searchopt.hxx +++ b/include/unotools/searchopt.hxx @@ -40,9 +40,9 @@ public: sal_Int32 GetTransliterationFlags() const; - // + // General Options - // + bool IsWholeWordsOnly() const; bool IsBackwards() const; @@ -61,9 +61,9 @@ public: void SetMatchCase( bool bVal ); // also Japanese search option void SetNotes( bool bVal); - // + // Japanese search options - // + bool IsMatchFullHalfWidthForms() const; bool IsMatchHiraganaKatakana() const; diff --git a/include/unotools/securityoptions.hxx b/include/unotools/securityoptions.hxx index 3e906b2c9624..df11b692197b 100644 --- a/include/unotools/securityoptions.hxx +++ b/include/unotools/securityoptions.hxx @@ -26,7 +26,7 @@ #include <rtl/ustring.hxx> #include <unotools/options.hxx> -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short forward declaration to our private date container implementation @descr We use these class as internal member to support small memory requirements. You can create the container if it is necessary. The class which use these mechanism @@ -35,7 +35,7 @@ class SvtSecurityOptions_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr These values present modes to handle StarOffice basic scripts. see GetBasicMode/SetBasicMode() for further information *//*-*************************************************************************************************************/ @@ -47,7 +47,7 @@ enum EBasicSecurityMode eALWAYS_EXECUTE = 2 }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about security features @descr - @@ -103,7 +103,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail */ public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will initialize an instance with default values. We implement these class with a refcount mechanism! Every instance of this class increase it @@ -122,7 +122,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail SvtSecurityOptions(); virtual ~SvtSecurityOptions(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short returns readonly state @descr It can be called to get information about the readonly state of a provided item. @seealso - @@ -135,7 +135,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail bool IsReadOnly( EOption eOption ) const ; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short interface methods to get and set value of config key "org.openoffice.Office.Common/Security/Scripting/SecureURL" @descr These value displays the list of all trustworthy URLs. zB.: file:/ => All scripts from the local file system including a LAN; @@ -156,7 +156,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail ::com::sun::star::uno::Sequence< OUString > GetSecureURLs( ) const ; void SetSecureURLs( const ::com::sun::star::uno::Sequence< OUString >& seqURLList ) ; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short interface methods to get and set value of config key "org.openoffice.Office.Common/Security/Scripting/StarOfficeBasic" @descr These value determines how StarOffice Basic scripts should be handled. It exist 3 different modes: @@ -218,13 +218,13 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail bool IsConfirmationEnabled() const; void SetConfirmationEnabled( bool bSet ); - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! @@ -240,9 +240,9 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetInitMutex(); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/include/unotools/sharedunocomponent.hxx b/include/unotools/sharedunocomponent.hxx index fe980db0fbd3..f4b3fc7fe056 100644 --- a/include/unotools/sharedunocomponent.hxx +++ b/include/unotools/sharedunocomponent.hxx @@ -31,14 +31,14 @@ namespace com { namespace sun { namespace star { class XComponent; } } } } -//............................................................................ + namespace utl { -//............................................................................ - //======================================================================== + + //= DisposableComponent - //======================================================================== + /** is a class which controls lifetime of an UNO component via ->XComponent::dispose You'll usually never use this class directly, but only as parameter for a @@ -71,9 +71,9 @@ namespace utl DisposableComponent& operator=( const DisposableComponent& ); // never implemented }; - //======================================================================== + //= CloseableComponent - //======================================================================== + class CloseableComponentImpl; /** is a class which controls lifetime of an UNO component via ->XCloseable::close @@ -113,9 +113,9 @@ namespace utl CloseableComponent& operator=( const CloseableComponent& ); // never implemented }; - //======================================================================== + //= SharedUNOComponent - //======================================================================== + /** is a helper class for sharing ownership of a UNO component If you need to share an UNO component, which normally needs a dedicated owner, @@ -236,14 +236,14 @@ namespace utl } }; - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > INTERFACE* SAL_CALL SharedUNOComponent< INTERFACE, COMPONENT >::operator->() const { return m_xTypedComponent.operator->(); } - //------------------------------------------------------------------------- + // assignments template < class INTERFACE, class COMPONENT > void SharedUNOComponent< INTERFACE, COMPONENT >::reset( const ::com::sun::star::uno::Reference< INTERFACE >& _rxComponent, AssignmentMode _eMode ) @@ -252,7 +252,7 @@ namespace utl m_xTypedComponent = _rxComponent; } - //------------------------------------------------------------------------- + // comparison operators template < class INTERFACE, class COMPONENT > bool operator==( const ::com::sun::star::uno::Reference< INTERFACE >& _rLHS, const SharedUNOComponent< INTERFACE, COMPONENT >& _rRHS ) @@ -266,7 +266,7 @@ namespace utl return _rLHS.getTyped() == _rRHS; } - //------------------------------------------------------------------------- + // conversion to Any template < class INTERFACE, class COMPONENT > inline void SAL_CALL operator <<= ( ::com::sun::star::uno::Any & rAny, const SharedUNOComponent< INTERFACE, COMPONENT >& value ) SAL_THROW(()) @@ -274,49 +274,49 @@ namespace utl rAny <<= value.getTyped(); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > inline ::com::sun::star::uno::Any SAL_CALL makeAny( const SharedUNOComponent< INTERFACE, COMPONENT >& value ) SAL_THROW(()) { return makeAny( value.getTyped() ); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > void SharedUNOComponent< INTERFACE, COMPONENT >::set( const ::com::sun::star::uno::XInterface* _pInterface, ::com::sun::star::uno::UnoReference_QueryThrow _queryThrow ) { reset( ::com::sun::star::uno::Reference< INTERFACE >( _pInterface, _queryThrow ), TakeOwnership ); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > void SharedUNOComponent< INTERFACE, COMPONENT >::set( const ::com::sun::star::uno::BaseReference & _rRef, ::com::sun::star::uno::UnoReference_QueryThrow _queryThrow ) { reset( ::com::sun::star::uno::Reference< INTERFACE >( _rRef, _queryThrow ), TakeOwnership ); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > void SharedUNOComponent< INTERFACE, COMPONENT >::set( const ::com::sun::star::uno::Any& _rAny, ::com::sun::star::uno::UnoReference_QueryThrow _queryThrow ) { reset( ::com::sun::star::uno::Reference< INTERFACE >( _rAny, _queryThrow ), TakeOwnership ); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > void SharedUNOComponent< INTERFACE, COMPONENT >::set( const INTERFACE* _pInterface, ::com::sun::star::uno::UnoReference_SetThrow _setThrow ) { reset( ::com::sun::star::uno::Reference< INTERFACE >( _pInterface, _setThrow ), TakeOwnership ); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > void SharedUNOComponent< INTERFACE, COMPONENT >::set( const ::com::sun::star::uno::Reference< INTERFACE >& _rRef, ::com::sun::star::uno::UnoReference_SetThrow _setThrow ) { reset( ::com::sun::star::uno::Reference< INTERFACE >( _rRef, _setThrow ), TakeOwnership ); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > void SharedUNOComponent< INTERFACE, COMPONENT >::set( const SharedUNOComponent& _rComp, ::com::sun::star::uno::UnoReference_SetThrow _setThrow ) { @@ -325,7 +325,7 @@ namespace utl m_xTypedComponent.set( m_xTypedComponent, _setThrow ); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > bool SharedUNOComponent< INTERFACE, COMPONENT >::set( ::com::sun::star::uno::XInterface* _pInterface, ::com::sun::star::uno::UnoReference_Query _query ) { @@ -333,7 +333,7 @@ namespace utl return is(); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > bool SharedUNOComponent< INTERFACE, COMPONENT >::set( const ::com::sun::star::uno::BaseReference& _rRef, ::com::sun::star::uno::UnoReference_Query _query ) { @@ -341,7 +341,7 @@ namespace utl return is(); } - //------------------------------------------------------------------------- + template < class INTERFACE, class COMPONENT > bool SharedUNOComponent< INTERFACE, COMPONENT >::set( const ::com::sun::star::uno::Any& _rAny, ::com::sun::star::uno::UnoReference_Query _query ) { @@ -349,9 +349,9 @@ namespace utl return is(); } -//............................................................................ + } // namespace utl -//............................................................................ + #endif // INCLUDED_UNOTOOLS_SHAREDUNOCOMPONENT_HXX diff --git a/include/unotools/streamwrap.hxx b/include/unotools/streamwrap.hxx index ddb5e1a070d7..fc0bc7e44903 100644 --- a/include/unotools/streamwrap.hxx +++ b/include/unotools/streamwrap.hxx @@ -37,9 +37,9 @@ namespace utl namespace stario = ::com::sun::star::io; namespace staruno = ::com::sun::star::uno; -//================================================================== + //= OInputStreamWrapper -//================================================================== + typedef ::cppu::WeakImplHelper1 < stario::XInputStream > InputStreamWrapper_Base; // needed for some compilers @@ -74,9 +74,9 @@ protected: void checkError() const; }; -//================================================================== + //= OSeekableInputStreamWrapper -//================================================================== + typedef ::cppu::ImplHelper1 < ::com::sun::star::io::XSeekable > OSeekableInputStreamWrapper_Base; /** helper class for wrapping an SvStream into an com.sun.star.io::XInputStream @@ -96,9 +96,9 @@ public: virtual sal_Int64 SAL_CALL getLength( ) throw (::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception); }; -//================================================================== + //= OOutputStreamWrapper -//================================================================== + typedef ::cppu::WeakImplHelper1<stario::XOutputStream> OutputStreamWrapper_Base; // needed for some compilers class OOutputStreamWrapper : public OutputStreamWrapper_Base @@ -121,9 +121,9 @@ protected: SvStream& rStream; }; -//================================================================== + //= OSeekableOutputStreamWrapper -//================================================================== + typedef ::cppu::ImplHelper1 < ::com::sun::star::io::XSeekable > OSeekableOutputStreamWrapper_Base; /** helper class for wrapping an SvStream into an com.sun.star.io::XOutputStream diff --git a/include/unotools/textsearch.hxx b/include/unotools/textsearch.hxx index 759343563e83..574070e0ba52 100644 --- a/include/unotools/textsearch.hxx +++ b/include/unotools/textsearch.hxx @@ -39,10 +39,10 @@ namespace com { } } -// ............................................................................ + namespace utl { -// ............................................................................ + // Utility class for searching class UNOTOOLS_DLLPUBLIC SearchParam @@ -58,7 +58,7 @@ private: bool m_bWordOnly : 1; // used by normal search bool m_bSrchInSel : 1; // search only in the selection - bool m_bCaseSense : 1; // + bool m_bCaseSense : 1; // values for the "weight Levenshtein-Distance" bool bLEV_Relaxed : 1; @@ -116,7 +116,7 @@ public: // - ordinary text (Bayer/Moore) // - regular expressions // - weighted Levenshtein distance -// + // This class allows forward and backward searching! class UNOTOOLS_DLLPUBLIC TextSearch @@ -173,9 +173,9 @@ public: }; -// ............................................................................ + } // namespace utl -// ............................................................................ + #endif diff --git a/include/unotools/viewoptions.hxx b/include/unotools/viewoptions.hxx index 89d2d20111e6..c5a4e676057d 100644 --- a/include/unotools/viewoptions.hxx +++ b/include/unotools/viewoptions.hxx @@ -29,13 +29,13 @@ #include <rtl/ustring.hxx> #include <unotools/options.hxx> -//_________________________________________________________________________________________________________________ + // forward declarations -//_________________________________________________________________________________________________________________ + class SvtViewOptionsBase_Impl; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr Use these enum values to specify right list in configuration in which your view data are saved. *//*-*************************************************************************************************************/ @@ -47,7 +47,7 @@ enum EViewType E_WINDOW = 3 }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short collect information about view features @descr We support different basetypes of views like dialogs, tab-dialogs, tab-pages and normal windows. You must specify your basetype by using right enum value and must give us a valid name for your @@ -105,17 +105,17 @@ enum EViewType class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Options { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short standard constructor and destructor @descr This will de-/initialize an instance with default values. You must give us the basic type of your view and a name which specify right entry @@ -134,7 +134,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op const OUString& sViewName ); virtual ~SvtViewOptions(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short support preload of these config item @descr Sometimes we need preloading of these configuration data without real using of it. @@ -149,11 +149,11 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op static void AcquireOptions(); static void ReleaseOptions(); - //--------------------------------------------------------------------------------------------------------- + // interface - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short use it to get information about existing entries in configuration @descr The methods to set/get the position or size will create a new entry automaticly if it not already exist and work with default values! @@ -167,7 +167,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op bool Exists() const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short use it to delete an entry of dynamic view set @descr You can use this method to delete anexisting node in configuration. But if you call a Set- or Get- method again on this instance @@ -183,7 +183,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op bool Delete(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short use it to set/get the window state of your view @descr These value describe position/size and some other states of a window. Use it with right vcl methods directly. Normaly it's not necessary to @@ -197,7 +197,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op OUString GetWindowState( ) const; void SetWindowState( const OUString& sState ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short use it to set/get the page number which was the last active one @descr It's only supported for: - tab-dialogs If you call it for other ones you will get an assertion in debug version. @@ -211,7 +211,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op sal_Int32 GetPageID( ) const; void SetPageID( sal_Int32 nID ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short use it to set/get the visual state of a window @descr It's only supported for: - windows If you call it for other ones you will get an assertion in debug version. @@ -232,7 +232,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op */ bool HasVisible() const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short use it to set/get the extended user data (consisting of a set of named scalar values) @descr It's supported for ALL types! Every view can handle its own user defined data set. @@ -244,7 +244,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > GetUserData( ) const; void SetUserData( const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >& lData ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short use it to set/get ONE special user data item directly @descr Normaly you can work on full user data list by using "Set/GetUserData()". With this function you have an access on special list entries directly without any @@ -258,13 +258,13 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op void SetUserItem( const OUString& sName , const ::com::sun::star::uno::Any& aValue ); - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return a reference to a static mutex @descr These class is threadsafe. We create a static mutex only for one time and use it to protect our refcount and container @@ -280,9 +280,9 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: |