include/svx/fmtools.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 #ifndef INCLUDED_SVX_FMTOOLS_HXX
  20 #define INCLUDED_SVX_FMTOOLS_HXX
  21
  22 #include <svx/svxdllapi.h>
  23
  24 #include <com/sun/star/sdb/SQLContext.hpp>
  25 #include <com/sun/star/sdb/XSQLQueryComposerFactory.hpp>
  26 #include <com/sun/star/sdbcx/Privilege.hpp>
  27 #include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
  28 #include <com/sun/star/sdbcx/XDataDescriptorFactory.hpp>
  29 #include <com/sun/star/sdbc/XRowSet.hpp>
  30 #include <com/sun/star/sdbc/XDatabaseMetaData.hpp>
  31 #include <com/sun/star/sdb/XColumn.hpp>
  32 #include <com/sun/star/sdb/XColumnUpdate.hpp>
  33 #include <com/sun/star/sdb/SQLErrorEvent.hpp>
  34 #include <com/sun/star/sdbc/XConnection.hpp>
  35 #include <com/sun/star/sdbc/XResultSet.hpp>
  36 #include <com/sun/star/sdbc/XResultSetUpdate.hpp>
  37 #include <com/sun/star/sdbcx/XRowLocate.hpp>
  38 #include <com/sun/star/sdbc/XDataSource.hpp>
  39 #include <com/sun/star/beans/XPropertySet.hpp>
  40 #include <com/sun/star/frame/XDispatchProviderInterception.hpp>
  41 #include <com/sun/star/frame/XDispatchProviderInterceptor.hpp>
  42 #include <com/sun/star/container/XIndexContainer.hpp>
  43 #include <com/sun/star/frame/XDispatch.hpp>
  44 #include <com/sun/star/frame/XStatusListener.hpp>
  45 #include <com/sun/star/frame/FeatureStateEvent.hpp>
  46 #include <com/sun/star/frame/XModel.hpp>
  47 #include <com/sun/star/script/ScriptEventDescriptor.hpp>
  48 #include <com/sun/star/container/XNameAccess.hpp>
  49 #include <com/sun/star/container/XEnumeration.hpp>
  50 #include <com/sun/star/container/XIndexAccess.hpp>
  51 #include <com/sun/star/awt/XControlModel.hpp>
  52 #include <com/sun/star/awt/XControl.hpp>
  53 #include <com/sun/star/awt/FontSlant.hpp>
  54 #include <com/sun/star/awt/FontDescriptor.hpp>
  55 #include <com/sun/star/awt/FontUnderline.hpp>
  56 #include <com/sun/star/awt/FontStrikeout.hpp>
  57 #include <com/sun/star/util/XNumberFormatsSupplier.hpp>
  58 #include <com/sun/star/lang/XServiceInfo.hpp>
  59 #include <com/sun/star/io/XObjectInputStream.hpp>
  60 #include <com/sun/star/io/XObjectOutputStream.hpp>
  61 #include <com/sun/star/io/XPersistObject.hpp>
  62 #include <com/sun/star/util/XNumberFormatter.hpp>
  63 #include <com/sun/star/util/XNumberFormats.hpp>
  64
  65 #include <rtl/ref.hxx>
  66 #include <tools/wintypes.hxx>
  67 #include <cppuhelper/weakref.hxx>
  68 #include <comphelper/uno3.hxx>
  69 #include <comphelper/stl_types.hxx>
  70 #include <cppuhelper/implbase.hxx>
  71
  72 #include <set>
  73
  74 namespace vcl { class Window; }
  75
  76
  77 // common types
  78
  79 // displaying a database exception for the user
  80 // display info about a simple css::sdbc::SQLException
  81 void displayException(const css::sdbc::SQLException&, vcl::Window* _pParent);
  82 SVX_DLLPUBLIC void displayException(const css::sdb::SQLContext&, vcl::Window* _pParent);
  83 void displayException(const css::sdb::SQLErrorEvent&);
  84 void displayException(const css::uno::Any&, vcl::Window* _pParent = nullptr);
  85
  86 sal_Int32 getElementPos(const css::uno::Reference< css::container::XIndexAccess>& xCont, const css::uno::Reference< css::uno::XInterface>& xElement);
  87
  88 SVX_DLLPUBLIC OUString getLabelName(const css::uno::Reference< css::beans::XPropertySet>& xControlModel);
  89
  90
  91 // = class CursorWrapper - a helper class which works in common with a css::uno::Reference<XDatabaseUpdateCursor>,
  92 //                          XDatabaseBookmarkCursor and XDatabaseDirectCursor each
  93
  94
  95 class SAL_WARN_UNUSED CursorWrapper
  96 {
  97 private:
  98     css::uno::Reference< css::uno::XInterface>                m_xGeneric;
  99     css::uno::Reference< css::sdbc::XResultSet>               m_xMoveOperations;
 100     css::uno::Reference< css::sdbcx::XRowLocate>              m_xBookmarkOperations;
 101     css::uno::Reference< css::sdbcx::XColumnsSupplier>        m_xColumnsSupplier;
 102     css::uno::Reference< css::beans::XPropertySet>            m_xPropertyAccess;
 103
 104 public:
 105     // Construction/Destruction
 106     CursorWrapper(const css::uno::Reference< css::sdbc::XRowSet>& _rxCursor, bool bUseCloned = false);
 107     SVX_DLLPUBLIC CursorWrapper(const css::uno::Reference< css::sdbc::XResultSet>& _rxCursor, bool bUseCloned = false);
 108         // if bUseCloned == sal_True, the cursor is first doubled over the XCloneable interface (which it must implement)
 109         // and then used
 110
 111     friend bool operator==(const CursorWrapper& lhs, const CursorWrapper& rhs)
 112     {
 113         return lhs.m_xGeneric.get() == rhs.m_xGeneric.get();
 114     }
 115
 116     bool is() const { return m_xMoveOperations.is(); }
 117     bool Is() const { return m_xMoveOperations.is(); }
 118
 119     operator const css::uno::Reference< css::uno::XInterface>& () const{ return m_xGeneric; }
 120
 121     // 'Conversions'
 122     CursorWrapper& operator=(const css::uno::Reference< css::sdbc::XRowSet>& xCursor);
 123     operator const css::uno::Reference< css::sdbc::XResultSet>& () const          { return m_xMoveOperations; }
 124
 125     const css::uno::Reference< css::beans::XPropertySet >&        getPropertySet() const      { return m_xPropertyAccess; }
 126
 127     // css::uno::Reference< css::sdbcx::XRowLocate>
 128     /// @throws css::sdbc::SQLException
 129     /// @throws css::uno::RuntimeException
 130     css::uno::Any getBookmark()
 131     { return m_xBookmarkOperations->getBookmark(); }
 132     /// @throws css::sdbc::SQLException
 133     /// @throws css::uno::RuntimeException
 134     bool moveToBookmark(const css::uno::Any& bookmark) { return m_xBookmarkOperations->moveToBookmark(bookmark); }
 135
 136     // css::sdbc::XResultSet
 137     bool isBeforeFirst() const              { return m_xMoveOperations->isBeforeFirst(); }
 138     bool isAfterLast() const                { return m_xMoveOperations->isAfterLast(); }
 139     bool isFirst() const                    { return m_xMoveOperations->isFirst(); }
 140     bool isLast() const                     { return m_xMoveOperations->isLast(); }
 141     void beforeFirst()                          { m_xMoveOperations->beforeFirst(); }
 142     bool first()                            { return m_xMoveOperations->first(); }
 143     bool last()                             { return m_xMoveOperations->last(); }
 144     sal_Int32 getRow() const                    { return m_xMoveOperations->getRow(); }
 145     bool absolute(sal_Int32 nPosition)          { return m_xMoveOperations->absolute(nPosition); }
 146     bool relative(sal_Int32 nCount)             { return m_xMoveOperations->relative(nCount); }
 147     bool previous()                         { return m_xMoveOperations->previous(); }
 148     bool next()                             { return m_xMoveOperations->next(); }
 149     void refreshRow()                       { m_xMoveOperations->refreshRow(); }
 150     bool rowDeleted()                       { return m_xMoveOperations->rowDeleted(); }
 151     // css::sdbcx::XColumnsSupplier
 152     /// @throws css::uno::RuntimeException
 153     css::uno::Reference< css::container::XNameAccess> getColumns() const { return m_xColumnsSupplier->getColumns(); }
 154 private:
 155     void ImplConstruct(const css::uno::Reference< css::sdbc::XResultSet>& _rxCursor, bool bUseCloned);
 156 };
 157
 158
 159 class FmXDisposeMultiplexer;
 160 class SAL_WARN_UNUSED FmXDisposeListener
 161 {
 162     friend class FmXDisposeMultiplexer;
 163
 164     rtl::Reference<FmXDisposeMultiplexer> m_pAdapter;
 165     osl::Mutex   m_aMutex;
 166
 167 public:
 168     virtual ~FmXDisposeListener();
 169
 170     /// @throws css::uno::RuntimeException
 171     virtual void disposing(const css::lang::EventObject& _rEvent, sal_Int16 _nId) = 0;
 172
 173 protected:
 174     void setAdapter(FmXDisposeMultiplexer* pAdapter);
 175 };
 176
 177 class SAL_WARN_UNUSED FmXDisposeMultiplexer : public cppu::WeakImplHelper< css::lang::XEventListener >
 178 {
 179     css::uno::Reference< css::lang::XComponent>       m_xObject;
 180     FmXDisposeListener* m_pListener;
 181
 182     virtual ~FmXDisposeMultiplexer() override;
 183 public:
 184     FmXDisposeMultiplexer(FmXDisposeListener* _pListener, const css::uno::Reference< css::lang::XComponent>& _rxObject);
 185
 186 // css::lang::XEventListener
 187     virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
 188
 189     void dispose();
 190 };
 191
 192 sal_Int16       getControlTypeByObject(const css::uno::Reference< css::lang::XServiceInfo>& _rxObject);
 193     // get the object type (OBJ_FM_...) from the services the object supports
 194
 195
 196 bool isRowSetAlive(const css::uno::Reference< css::uno::XInterface>& _rxRowSet);
 197     // checks if the css::sdbcx::XColumnsSupplier provided by _rxRowSet supplies any columns
 198
 199
 200 typedef ::std::set  < css::uno::Reference< css::uno::XInterface >
 201                     , ::comphelper::OInterfaceCompare< css::uno::XInterface >
 202                     > InterfaceBag;
 203
 204 #endif // INCLUDED_SVX_FMTOOLS_HXX
 205
 206 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */