Line data    Source code

       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 INCLUDED_VCL_FILTERCONFIGITEM_HXX
      22             : #define INCLUDED_VCL_FILTERCONFIGITEM_HXX
      23             : 
      24             : #include <vcl/dllapi.h>
      25             : 
      26             : #include <rtl/ustring.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             :     bool    bModified;
      42             : 
      43             :     static 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             :                             bool bTestPropertyAvailability );
      47             : 
      48             :     void     ImpInitTree( const OUString& 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  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             :     /// Writes config in destructor
      64             :     ~FilterConfigItem();
      65             :     /// Writes config and sets unmodified state again.
      66             :     void WriteModifiedConfig();
      67             : 
      68             :     // all read methods are trying to return values in following order:
      69             :     // 1. FilterData PropertySequence
      70             :     // 2. configuration
      71             :     // 3. given default
      72             :     bool    ReadBool( const OUString& rKey, bool bDefault );
      73             :     sal_Int32   ReadInt32( const OUString& rKey, sal_Int32 nDefault );
      74             :     OUString
      75             :                 ReadString( const OUString& rKey, const OUString& rDefault );
      76             : 
      77             :     // try to store to configuration
      78             :     // and always stores into the FilterData sequence
      79             :     void        WriteBool( const OUString& rKey, bool bValue );
      80             :     void        WriteInt32( const OUString& rKey, sal_Int32 nValue );
      81             : 
      82           0 :     ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > GetFilterData() const { return aFilterData;}
      83             : 
      84             :     // GetStatusIndicator is returning the "StatusIndicator" property of the FilterData sequence
      85             :     ::com::sun::star::uno::Reference< ::com::sun::star::task::XStatusIndicator > GetStatusIndicator() const;
      86             : };
      87             : 
      88             : #endif // INCLUDED_VCL_FILTERCONFIGITEM_HXX
      89             : 
      90             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */