include/vcl/FilterConfigItem.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
  21 #ifndef _FILTER_CONFIG_ITEM_HXX_
  22 #define _FILTER_CONFIG_ITEM_HXX_
  23
  24 #include <vcl/dllapi.h>
  25
  26 #include <tools/string.hxx>
  27 #include <com/sun/star/awt/Size.hpp>
  28 #include <com/sun/star/uno/Any.h>
  29 #include <com/sun/star/uno/Reference.h>
  30 #include <com/sun/star/uno/XInterface.hpp>
  31 #include <com/sun/star/beans/XPropertySet.hpp>
  32 #include <com/sun/star/beans/XPropertyAccess.hpp>
  33 #include <com/sun/star/task/XStatusIndicator.hpp>
  34
  35 class VCL_DLLPUBLIC FilterConfigItem
  36 {
  37     ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > xUpdatableView;
  38     ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > xPropSet;
  39     ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > aFilterData;
  40
  41     sal_Bool    bModified;
  42
  43     sal_Bool ImplGetPropertyValue( ::com::sun::star::uno::Any& rAny,
  44                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rXPropSet,
  45                         const OUString& rPropName,
  46                             sal_Bool bTestPropertyAvailability );
  47
  48     void     ImpInitTree( const String& rTree );
  49
  50
  51     static ::com::sun::star::beans::PropertyValue* GetPropertyValue(
  52                 ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rPropSeq,
  53                     const OUString& rName );
  54     static  sal_Bool WritePropertyValue(
  55                 ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rPropSeq,
  56                     const ::com::sun::star::beans::PropertyValue& rPropValue );
  57
  58 public :
  59
  60     FilterConfigItem( const OUString& rSubTree );
  61     FilterConfigItem( ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >* pFilterData );
  62     FilterConfigItem( const OUString& rSubTree, ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >* pFilterData );
  63     ~FilterConfigItem();
  64
  65     // all read methods are trying to return values in following order:
  66     // 1. FilterData PropertySequence
  67     // 2. configuration
  68     // 3. given default
  69     sal_Bool    ReadBool( const OUString& rKey, sal_Bool bDefault );
  70     sal_Int32   ReadInt32( const OUString& rKey, sal_Int32 nDefault );
  71     OUString
  72                 ReadString( const OUString& rKey, const OUString& rDefault );
  73
  74     // try to store to configuration
  75     // and always stores into the FilterData sequence
  76     void        WriteBool( const OUString& rKey, sal_Bool bValue );
  77     void        WriteInt32( const OUString& rKey, sal_Int32 nValue );
  78
  79     ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > GetFilterData() const;
  80
  81     // GetStatusIndicator is returning the "StatusIndicator" property of the FilterData sequence
  82     ::com::sun::star::uno::Reference< ::com::sun::star::task::XStatusIndicator > GetStatusIndicator() const;
  83 };
  84
  85 #endif  // _FILTER_CONFIG_ITEM_HXX_
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */