diff options
Diffstat (limited to 'include/unotools/localisationoptions.hxx')
-rw-r--r-- | include/unotools/localisationoptions.hxx | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/include/unotools/localisationoptions.hxx b/include/unotools/localisationoptions.hxx new file mode 100644 index 000000000000..931d59f1980d --- /dev/null +++ b/include/unotools/localisationoptions.hxx @@ -0,0 +1,136 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef INCLUDED_unotools_LOCALISATIONOPTIONS_HXX +#define INCLUDED_unotools_LOCALISATIONOPTIONS_HXX + +#include <sal/types.h> +#include "unotools/unotoolsdllapi.h" +#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 neccessary. The class which use these mechanism + is faster and smaller then a complete implementation! +*//*-*************************************************************************************************************/ + +class SvtLocalisationOptions_Impl; + +/*-************************************************************************************************************//** + @short collect information about localisation features + @descr - + + @implements - + @base - + + @devstatus ready to use +*//*-*************************************************************************************************************/ + +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 + at create and decrease it at delete time - but all instances use the same data container! + He is implemented as a static member ... + + @seealso member m_nRefCount + @seealso member m_pDataContainer + + @param - + @return - + + @onerror - + *//*-*****************************************************************************************************/ + + 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. + + @seealso - + + @param "bState", new value to set it in configuration. + @return The value which represent current state of internal variable. + + @onerror No error should occurre! + *//*-*****************************************************************************************************/ + + sal_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. + + @ATTENTION These methods don't check for valid or invalid values! + Our configuration server can do it ... but these implementation don't get any notifications + about wrong commits ...! + => If you set an invalid value - nothing will be changed. The information will lost. + + @seealso baseclass ConfigItem + + @param "nScale" new value to set it in configuration. + @return The value which represent current state of internal variable. + + @onerror No error should occurre! + *//*-*****************************************************************************************************/ + + 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! + We create a static mutex only for one ime and use at different times. + + @seealso - + + @param - + @return A reference to a static mutex member. + + @onerror - + *//*-*****************************************************************************************************/ + + UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); + + private: + + /*Attention + + Don't initialize these static member in these header! + a) Double dfined symbols will be detected ... + b) and unresolved externals exist at linking time. + Do it in your source only. + */ + + static SvtLocalisationOptions_Impl* m_pDataContainer ; /// impl. data container as dynamic pointer for smaller memory requirements! + static sal_Int32 m_nRefCount ; /// internal ref count mechanism + +}; // class SvtLocalisationOptions + +#endif // #ifndef INCLUDED_unotools_LOCALISATIONOPTIONS_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |