include/linguistic/lngprophelp.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_LINGUISTIC_LNGPROPHELP_HXX
  21 #define INCLUDED_LINGUISTIC_LNGPROPHELP_HXX
  22
  23 #include <cppuhelper/implbase.hxx>
  24 #include <comphelper/interfacecontainer2.hxx>
  25 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  26 #include <com/sun/star/beans/PropertyValues.hpp>
  27 #include <com/sun/star/linguistic2/XLinguProperties.hpp>
  28 #include <com/sun/star/linguistic2/XLinguServiceEventBroadcaster.hpp>
  29 #include <linguistic/lngdllapi.h>
  30
  31 namespace com { namespace sun { namespace star { namespace beans {
  32     class   XPropertySet;
  33 }}}}
  34
  35 namespace com { namespace sun { namespace star { namespace linguistic2 {
  36     struct  LinguServiceEvent;
  37 }}}}
  38
  39
  40 namespace linguistic
  41 {
  42
  43 // PropertyChgHelper
  44 // Base class for all XPropertyChangeListener members of the
  45 // various lingu services.
  46
  47
  48 // Flags for type of events allowed to be launched
  49 #define AE_SPELLCHECKER 1
  50 #define AE_HYPHENATOR   2
  51
  52 typedef cppu::WeakImplHelper
  53 <
  54     css::beans::XPropertyChangeListener,
  55     css::linguistic2::XLinguServiceEventBroadcaster
  56 > PropertyChgHelperBase;
  57
  58 class PropertyChgHelper :
  59     public PropertyChgHelperBase
  60 {
  61     css::uno::Sequence< OUString >                      aPropNames;
  62     css::uno::Reference< css::uno::XInterface >         xMyEvtObj;
  63     ::comphelper::OInterfaceContainerHelper2                   aLngSvcEvtListeners;
  64     css::uno::Reference< css::beans::XPropertySet >     xPropSet;
  65
  66     int     nEvtFlags;  // flags for event types allowed to be launched
  67
  68     // default values
  69     bool    bIsIgnoreControlCharacters;
  70     bool    bIsUseDictionaryList;
  71
  72     // return values, will be set to default value or current temporary value
  73     bool    bResIsIgnoreControlCharacters;
  74     bool    bResIsUseDictionaryList;
  75
  76     PropertyChgHelper( const PropertyChgHelper & ) = delete;
  77     PropertyChgHelper & operator = ( const PropertyChgHelper & ) = delete;
  78
  79 protected:
  80     virtual void    SetDefaultValues();
  81     virtual void    GetCurrentValues();
  82
  83     css::uno::Sequence< OUString > &
  84             GetPropNames()  { return aPropNames; }
  85     css::uno::Reference<
  86         css::beans::XPropertySet > &
  87             GetPropSet()    { return xPropSet; }
  88
  89     void    AddPropNames( const char *pNewNames[], sal_Int32 nCount );
  90
  91     virtual bool    propertyChange_Impl( const css::beans::PropertyChangeEvent& rEvt );
  92
  93 public:
  94     PropertyChgHelper(
  95             const css::uno::Reference< css::uno::XInterface > &rxSource,
  96             css::uno::Reference< css::linguistic2::XLinguProperties > &rxPropSet,
  97             int nAllowedEvents );
  98     virtual ~PropertyChgHelper() override;
  99
 100     virtual void    SetTmpPropVals( const css::beans::PropertyValues &rPropVals );
 101
 102     // XEventListener
 103     virtual void SAL_CALL
 104         disposing( const css::lang::EventObject& rSource ) override;
 105
 106     // XPropertyChangeListener
 107     virtual void SAL_CALL
 108         propertyChange( const css::beans::PropertyChangeEvent& rEvt ) override;
 109
 110     // XLinguServiceEventBroadcaster
 111     virtual sal_Bool SAL_CALL
 112         addLinguServiceEventListener(
 113                 const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >& rxListener ) override;
 114     virtual sal_Bool SAL_CALL
 115         removeLinguServiceEventListener(
 116                 const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >& rxListener ) override;
 117
 118     // non-UNO functions
 119     void    LNG_DLLPUBLIC AddAsPropListener();
 120     void    LNG_DLLPUBLIC RemoveAsPropListener();
 121     void    LaunchEvent( const css::linguistic2::LinguServiceEvent& rEvt );
 122
 123     const css::uno::Sequence< OUString > &
 124             GetPropNames() const    { return aPropNames; }
 125     const css::uno::Reference< css::beans::XPropertySet > &
 126             GetPropSet() const      { return xPropSet; }
 127     const css::uno::Reference< css::uno::XInterface > &
 128             GetEvtObj() const       { return xMyEvtObj; }
 129 };
 130
 131
 132 class PropertyHelper_Thes :
 133     public PropertyChgHelper
 134 {
 135     PropertyHelper_Thes( const PropertyHelper_Thes & ) = delete;
 136     PropertyHelper_Thes & operator = ( const PropertyHelper_Thes & ) = delete;
 137
 138 public:
 139     PropertyHelper_Thes(
 140             const css::uno::Reference< css::uno::XInterface > &rxSource,
 141             css::uno::Reference< css::linguistic2::XLinguProperties > &rxPropSet );
 142     virtual ~PropertyHelper_Thes() override;
 143
 144     // XPropertyChangeListener
 145     virtual void SAL_CALL
 146         propertyChange( const css::beans::PropertyChangeEvent& rEvt ) override;
 147 };
 148
 149 class LNG_DLLPUBLIC PropertyHelper_Thesaurus
 150 {
 151     PropertyHelper_Thes* pInst;
 152     css::uno::Reference< css::beans::XPropertyChangeListener >    xPropHelper;
 153
 154     // disallow use of copy-constructor and assignment-operator
 155     PropertyHelper_Thesaurus( const PropertyHelper_Thes & ) = delete;
 156     PropertyHelper_Thesaurus & operator = ( const PropertyHelper_Thes & ) = delete;
 157
 158 public:
 159     PropertyHelper_Thesaurus(
 160             const css::uno::Reference< css::uno::XInterface > &rxSource,
 161             css::uno::Reference< css::linguistic2::XLinguProperties > &rxPropSet );
 162     ~PropertyHelper_Thesaurus();
 163     void    AddAsPropListener();
 164     void    RemoveAsPropListener();
 165     void SetTmpPropVals( const css::beans::PropertyValues &rPropVals );
 166 };
 167
 168
 169 class LNG_DLLPUBLIC PropertyHelper_Spell :
 170     public PropertyChgHelper
 171 {
 172     // default values
 173     bool        bIsSpellUpperCase;
 174     bool        bIsSpellWithDigits;
 175     bool        bIsSpellCapitalization;
 176
 177     // return values, will be set to default value or current temporary value
 178     sal_Int16   nResMaxNumberOfSuggestions; // special value that is not part of the property set and thus needs to be handled differently
 179     bool        bResIsSpellUpperCase;
 180     bool        bResIsSpellWithDigits;
 181     bool        bResIsSpellCapitalization;
 182
 183     PropertyHelper_Spell( const PropertyHelper_Spell & ) = delete;
 184     PropertyHelper_Spell & operator = ( const PropertyHelper_Spell & ) = delete;
 185
 186 protected:
 187     // PropertyChgHelper
 188     virtual void    SetDefaultValues() override;
 189     virtual void    GetCurrentValues() override;
 190     virtual bool    propertyChange_Impl(
 191                             const css::beans::PropertyChangeEvent& rEvt ) override;
 192
 193 public:
 194     PropertyHelper_Spell(
 195             const css::uno::Reference< css::uno::XInterface > &rxSource,
 196             css::uno::Reference< css::linguistic2::XLinguProperties > &rxPropSet );
 197     virtual ~PropertyHelper_Spell() override;
 198
 199     virtual void    SetTmpPropVals( const css::beans::PropertyValues &rPropVals ) override;
 200
 201     // XPropertyChangeListener
 202     virtual void SAL_CALL
 203         propertyChange( const css::beans::PropertyChangeEvent& rEvt ) override;
 204
 205     static sal_Int16 GetDefaultNumberOfSuggestions() { return 16; }
 206
 207     bool        IsSpellUpperCase() const            { return bResIsSpellUpperCase; }
 208     bool        IsSpellWithDigits() const           { return bResIsSpellWithDigits; }
 209     bool        IsSpellCapitalization() const       { return bResIsSpellCapitalization; }
 210 };
 211
 212
 213 class LNG_DLLPUBLIC PropertyHelper_Spelling
 214 {
 215     PropertyHelper_Spell* pInst;
 216     css::uno::Reference< css::beans::XPropertyChangeListener >    xPropHelper;
 217
 218     // disallow use of copy-constructor and assignment-operator
 219     PropertyHelper_Spelling( const PropertyHelper_Spell & ) = delete;
 220     PropertyHelper_Spelling & operator = ( const PropertyHelper_Spell & ) = delete;
 221
 222 public:
 223     PropertyHelper_Spelling(
 224             const css::uno::Reference< css::uno::XInterface > &rxSource,
 225             css::uno::Reference< css::linguistic2::XLinguProperties > &rxPropSet );
 226     ~PropertyHelper_Spelling();
 227
 228     void    AddAsPropListener();
 229     void    RemoveAsPropListener();
 230     void    SetTmpPropVals( const css::beans::PropertyValues &rPropVals );
 231     bool    IsSpellUpperCase() const;
 232     bool    IsSpellWithDigits() const;
 233     bool    IsSpellCapitalization() const;
 234     /// @throws css::uno::RuntimeException
 235     bool addLinguServiceEventListener(
 236                 const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >& rxListener );
 237     /// @throws css::uno::RuntimeException
 238     bool removeLinguServiceEventListener(
 239                 const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >& rxListener );
 240 };
 241
 242
 243 class PropertyHelper_Hyphen :
 244     public PropertyChgHelper
 245 {
 246     // default values
 247     sal_Int16   nHyphMinLeading,
 248             nHyphMinTrailing,
 249             nHyphMinWordLength;
 250
 251     // return values, will be set to default value or current temporary value
 252     sal_Int16   nResHyphMinLeading,
 253             nResHyphMinTrailing,
 254             nResHyphMinWordLength;
 255
 256     PropertyHelper_Hyphen( const PropertyHelper_Hyphen & ) = delete;
 257     PropertyHelper_Hyphen & operator = ( const PropertyHelper_Hyphen & ) = delete;
 258
 259 protected:
 260     // PropertyChgHelper
 261     virtual void    SetDefaultValues() override;
 262     virtual void    GetCurrentValues() override;
 263     virtual bool    propertyChange_Impl(
 264                             const css::beans::PropertyChangeEvent& rEvt ) override;
 265
 266 public:
 267     PropertyHelper_Hyphen(
 268             const css::uno::Reference< css::uno::XInterface > &rxSource,
 269             css::uno::Reference< css::linguistic2::XLinguProperties > &rxPropSet);
 270     virtual ~PropertyHelper_Hyphen() override;
 271
 272     virtual void    SetTmpPropVals( const css::beans::PropertyValues &rPropVals ) override;
 273
 274     // XPropertyChangeListener
 275     virtual void SAL_CALL
 276         propertyChange( const css::beans::PropertyChangeEvent& rEvt ) override;
 277
 278     sal_Int16   GetMinLeading() const               { return nResHyphMinLeading; }
 279     sal_Int16   GetMinTrailing() const              { return nResHyphMinTrailing; }
 280     sal_Int16   GetMinWordLength() const            { return nResHyphMinWordLength; }
 281 };
 282
 283 class LNG_DLLPUBLIC PropertyHelper_Hyphenation
 284 {
 285     PropertyHelper_Hyphen* pInst;
 286     css::uno::Reference< css::beans::XPropertyChangeListener >    xPropHelper;
 287
 288     // disallow use of copy-constructor and assignment-operator
 289     PropertyHelper_Hyphenation( const PropertyHelper_Hyphen & ) = delete;
 290     PropertyHelper_Hyphenation & operator = ( const PropertyHelper_Hyphen & ) = delete;
 291
 292 public:
 293     PropertyHelper_Hyphenation(
 294             const css::uno::Reference< css::uno::XInterface > &rxSource,
 295             css::uno::Reference< css::linguistic2::XLinguProperties > &rxPropSet);
 296     ~PropertyHelper_Hyphenation();
 297
 298     void    AddAsPropListener();
 299     void    RemoveAsPropListener();
 300     void SetTmpPropVals( const css::beans::PropertyValues &rPropVals );
 301     sal_Int16   GetMinLeading() const;
 302     sal_Int16   GetMinTrailing() const;
 303     sal_Int16   GetMinWordLength() const;
 304     /// @throws css::uno::RuntimeException
 305     bool addLinguServiceEventListener(
 306                 const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >& rxListener );
 307     /// @throws css::uno::RuntimeException
 308     bool removeLinguServiceEventListener(
 309                 const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >& rxListener );
 310 };
 311
 312 }   // namespace linguistic
 313
 314 #endif
 315
 316 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */