include/connectivity/sdbcx/VDescriptor.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_CONNECTIVITY_SDBCX_VDESCRIPTOR_HXX
  21 #define INCLUDED_CONNECTIVITY_SDBCX_VDESCRIPTOR_HXX
  22
  23 #include <comphelper/propertycontainer.hxx>
  24 #include <comphelper/stl_types.hxx>
  25 #include <connectivity/dbtoolsdllapi.hxx>
  26
  27 namespace connectivity::sdbcx
  28     {
  29
  30         // = ODescriptor
  31
  32         typedef ::comphelper::OPropertyContainer ODescriptor_PBASE;
  33         class OOO_DLLPUBLIC_DBTOOLS ODescriptor
  34                     :public ODescriptor_PBASE
  35         {
  36         protected:
  37             OUString         m_Name;
  38
  39             /** helper for derived classes to implement OPropertyArrayUsageHelper::createArrayHelper
  40
  41                 This method just calls describeProperties, and flags all properties as READONLY if and
  42                 only if we do *not* act as descriptor, but as final object.
  43
  44                 @seealso    isNew
  45             */
  46             ::cppu::IPropertyArrayHelper*   doCreateArrayHelper() const;
  47
  48         private:
  49             comphelper::UStringMixEqual m_aCase;
  50             bool                        m_bNew;
  51
  52         public:
  53             ODescriptor(::cppu::OBroadcastHelper& _rBHelper, bool _bCase, bool _bNew = false);
  54
  55             virtual ~ODescriptor() override;
  56
  57             bool     isNew()  const         { return m_bNew;    }
  58             void     setNew(bool _bNew);
  59
  60             bool     isCaseSensitive() const { return m_aCase.isCaseSensitive(); }
  61
  62             virtual void construct();
  63
  64             /// @throws css::uno::RuntimeException
  65             virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  );
  66
  67             // retrieves the ODescriptor implementation of a given UNO component, and returns its ->isNew flag
  68             static bool isNew( const css::uno::Reference< css::uno::XInterface >& _rxDescriptor );
  69         };
  70
  71 }
  72
  73 #endif // INCLUDED_CONNECTIVITY_SDBCX_VDESCRIPTOR_HXX
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */