diff options
Diffstat (limited to 'unotools/inc/unotools/viewoptions.hxx')
| -rw-r--r-- | unotools/inc/unotools/viewoptions.hxx | 144 |
1 files changed, 72 insertions, 72 deletions
diff --git a/unotools/inc/unotools/viewoptions.hxx b/unotools/inc/unotools/viewoptions.hxx index 34c00590dc0a..07fefb26868d 100644 --- a/unotools/inc/unotools/viewoptions.hxx +++ b/unotools/inc/unotools/viewoptions.hxx @@ -2,7 +2,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,7 +29,7 @@ #define INCLUDED_unotools_VIEWOPTIONS_HXX //_________________________________________________________________________________________________________________ -// includes +// includes //_________________________________________________________________________________________________________________ #include "unotools/unotoolsdllapi.h" @@ -43,29 +43,29 @@ #include <unotools/options.hxx> //_________________________________________________________________________________________________________________ -// forward declarations +// forward declarations //_________________________________________________________________________________________________________________ class SvtViewOptionsBase_Impl; //_________________________________________________________________________________________________________________ -// declarations +// declarations //_________________________________________________________________________________________________________________ /*-************************************************************************************************************//** - @descr Use these enum values to specify right list in configuration in which your view data are saved. + @descr Use these enum values to specify right list in configuration in which your view data are saved. *//*-*************************************************************************************************************/ enum EViewType { - E_DIALOG = 0, - E_TABDIALOG = 1, - E_TABPAGE = 2, - E_WINDOW = 3 + E_DIALOG = 0, + E_TABDIALOG = 1, + E_TABPAGE = 2, + E_WINDOW = 3 }; /*-************************************************************************************************************//** - @short collect informations about view features + @short collect informations 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 subkey in registry! We support some fix features for some bastypes and user data as string for all! @@ -89,35 +89,35 @@ enum EViewType structure of configuration: - org.openoffice.Office.Views [package] - /Dialogs [set] - /Dialog_FileOpen [DialogType] - /Dialog_ImportGraphics [DialogType] + org.openoffice.Office.Views [package] + /Dialogs [set] + /Dialog_FileOpen [DialogType] + /Dialog_ImportGraphics [DialogType] ... - /Dialog_<YourName> [DialogType] + /Dialog_<YourName> [DialogType] - /TabDialogs [set] - /TabDialog_001 [TabDialogType] - /TabDialog_Blubber [TabDialogType] + /TabDialogs [set] + /TabDialog_001 [TabDialogType] + /TabDialog_Blubber [TabDialogType] ... - /TabDialog_<YourName> [TabDialogType] + /TabDialog_<YourName> [TabDialogType] - /TabPages [set] - /TabPage_XXX [TabPageType] - /TabPage_Date [TabPageType] + /TabPages [set] + /TabPage_XXX [TabPageType] + /TabPage_Date [TabPageType] ... - /TabPage_<YourName> [TabPageType] + /TabPage_<YourName> [TabPageType] - /Windows [set] - /Window_User [WindowType] - /Window_Options [WindowType] + /Windows [set] + /Window_User [WindowType] + /Window_Options [WindowType] ... - /Window_<YourName> [WindowType] + /Window_<YourName> [WindowType] - @implements - - @base - + @implements - + @base - - @devstatus ready to use + @devstatus ready to use *//*-*************************************************************************************************************/ class UNOTOOLS_DLLPUBLIC SvtViewOptions: public utl::detail::Options @@ -145,28 +145,28 @@ class UNOTOOLS_DLLPUBLIC SvtViewOptions: public utl::detail::Options */ //------------------------------------------------------------------------------------------------------------- - // public methods + // public methods //------------------------------------------------------------------------------------------------------------- public: //--------------------------------------------------------------------------------------------------------- - // constructor / destructor + // constructor / destructor //--------------------------------------------------------------------------------------------------------- /*-****************************************************************************************************//** - @short standard constructor and destructor - @descr This will de-/initialize an instance with default values. + @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 in dynamical configuration list. If entry not exist, we create a new one! - @seealso enum EViewType + @seealso enum EViewType - @param "eType" specify type of your view and is used to use right data container! - @param "sViewName" specify the name of your view and is the key name in data list too. - @return - + @param "eType" specify type of your view and is used to use right data container! + @param "sViewName" specify the name of your view and is the key name in data list too. + @return - - @onerror An assertion is thrown in debug version. Otherwise we do nothing! + @onerror An assertion is thrown in debug version. Otherwise we do nothing! *//*-*****************************************************************************************************/ SvtViewOptions( EViewType eType , @@ -180,7 +180,7 @@ class UNOTOOLS_DLLPUBLIC SvtViewOptions: public utl::detail::Options @seealso - @param - - @return - + @return - @onerror - *//*-*****************************************************************************************************/ @@ -189,35 +189,35 @@ class UNOTOOLS_DLLPUBLIC SvtViewOptions: public utl::detail::Options static void ReleaseOptions(); //--------------------------------------------------------------------------------------------------------- - // interface + // 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 + @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! If this a problem for you - you MUST call these method before and you must make up your own mind about that. @seealso - - @onerror No error should occure. + @onerror No error should occure. *//*-*****************************************************************************************************/ sal_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. + @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 the item is created again! If you do nothing after this call your view will die relay in configuration ... - @seealso method Exist() + @seealso method Exist() - @return True if delete OK, False otherwise. + @return True if delete OK, False otherwise. - @onerror We return sal_False. + @onerror We return sal_False. *//*-*****************************************************************************************************/ sal_Bool Delete(); @@ -237,41 +237,41 @@ class UNOTOOLS_DLLPUBLIC SvtViewOptions: public utl::detail::Options void SetWindowState( const ::rtl::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 + @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. In a product version we do nothing! - @seealso - + @seealso - - @onerror An assertion is thrown in debug version. Otherwise we do nothing! + @onerror An assertion is thrown in debug version. Otherwise we do nothing! *//*-*****************************************************************************************************/ 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 + @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. In a product version we do nothing! - @seealso - + @seealso - - @onerror An assertion is thrown in debug version. Otherwise we do nothing! + @onerror An assertion is thrown in debug version. Otherwise we do nothing! *//*-*****************************************************************************************************/ sal_Bool IsVisible ( ) const; void SetVisible( sal_Bool bState ); /*-****************************************************************************************************//** - @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! + @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. @seealso - - @onerror In the non-product version, an assertion is made. In a product version, errors are silently ignored. + @onerror In the non-product version, an assertion is made. In a product version, errors are silently ignored. *//*-*****************************************************************************************************/ /* #ifdef TF_OLDVIEW @@ -289,7 +289,7 @@ class UNOTOOLS_DLLPUBLIC SvtViewOptions: public utl::detail::Options @seealso - - @onerror In the non-product version, an assertion is made. In a product version, errors are silently ignored. + @onerror In the non-product version, an assertion is made. In a product version, errors are silently ignored. *//*-*****************************************************************************************************/ ::com::sun::star::uno::Any GetUserItem( const ::rtl::OUString& sName ) const; @@ -297,37 +297,37 @@ class UNOTOOLS_DLLPUBLIC SvtViewOptions: public utl::detail::Options const ::com::sun::star::uno::Any& aValue ); //------------------------------------------------------------------------------------------------------------- - // private methods + // private methods //------------------------------------------------------------------------------------------------------------- private: /*-****************************************************************************************************//** - @short return a reference to a static mutex - @descr These class is threadsafe. + @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 member! - @seealso - + @seealso - - @param - - @return A reference to a static mutex member. + @param - + @return A reference to a static mutex member. - @onerror - + @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); //------------------------------------------------------------------------------------------------------------- - // private member + // private member //------------------------------------------------------------------------------------------------------------- private: /// specify which list of views in configuration is used! This can't be a static value!!! /// ... because we need this value to work with right static data container. - EViewType m_eViewType ; - ::rtl::OUString m_sViewName ; + EViewType m_eViewType ; + ::rtl::OUString m_sViewName ; /// - impl. data container as dynamic pointer for smaller memory requirements! /// - internal ref count mechanism @@ -349,7 +349,7 @@ class UNOTOOLS_DLLPUBLIC SvtViewOptions: public utl::detail::Options static SvtViewOptionsBase_Impl* m_pDataContainer_Windows ; /// hold data for all windows static sal_Int32 m_nRefCount_Windows ; -}; // class SvtViewOptions +}; // class SvtViewOptions #endif // #ifndef INCLUDED_unotools_VIEWOPTIONS_HXX |