LibreOffice Module svx (master)  1
fmtools.hxx
Go to the documentation of this file.
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/sdbcx/XColumnsSupplier.hpp>
25 #include <com/sun/star/sdbc/XResultSet.hpp>
26 #include <com/sun/star/sdbcx/XRowLocate.hpp>
27 #include <com/sun/star/lang/EventObject.hpp>
28 #include <com/sun/star/lang/XEventListener.hpp>
29 
30 #include <rtl/ref.hxx>
31 #include <cppuhelper/implbase.hxx>
32 
33 #include <set>
34 
35 namespace com::sun::star::beans { class XPropertySet; }
36 namespace com::sun::star::container { class XIndexAccess; }
37 namespace com::sun::star::container { class XNameAccess; }
38 namespace com::sun::star::lang { class XComponent; }
39 namespace com::sun::star::lang { class XServiceInfo; }
40 namespace com::sun::star::sdbc { class SQLException; }
41 namespace com::sun::star::sdbc { class XRowSet; }
42 namespace com::sun::star::sdb { class SQLContext; }
43 namespace com::sun::star::sdb { struct SQLErrorEvent; }
44 namespace vcl { class Window; }
45 
46 
47 // common types
48 
49 // displaying a database exception for the user
50 // display info about a simple css::sdbc::SQLException
51 void displayException(const css::sdbc::SQLException&, vcl::Window* _pParent);
52 SVX_DLLPUBLIC void displayException(const css::sdb::SQLContext&, vcl::Window* _pParent);
53 void displayException(const css::sdb::SQLErrorEvent&, vcl::Window* _pParent = nullptr);
54 void displayException(const css::uno::Any&, vcl::Window* _pParent = nullptr);
55 
56 sal_Int32 getElementPos(const css::uno::Reference< css::container::XIndexAccess>& xCont, const css::uno::Reference< css::uno::XInterface>& xElement);
57 
58 SVX_DLLPUBLIC OUString getLabelName(const css::uno::Reference< css::beans::XPropertySet>& xControlModel);
59 
60 
61 // = class CursorWrapper - a helper class which works in common with a css::uno::Reference<XDatabaseUpdateCursor>,
62 // XDatabaseBookmarkCursor and XDatabaseDirectCursor each
63 
64 
66 {
67 private:
68  css::uno::Reference< css::uno::XInterface> m_xGeneric;
69  css::uno::Reference< css::sdbc::XResultSet> m_xMoveOperations;
70  css::uno::Reference< css::sdbcx::XRowLocate> m_xBookmarkOperations;
71  css::uno::Reference< css::sdbcx::XColumnsSupplier> m_xColumnsSupplier;
72  css::uno::Reference< css::beans::XPropertySet> m_xPropertyAccess;
73 
74 public:
75  // Construction/Destruction
76  CursorWrapper(const css::uno::Reference< css::sdbc::XRowSet>& _rxCursor, bool bUseCloned = false);
77  SVX_DLLPUBLIC CursorWrapper(const css::uno::Reference< css::sdbc::XResultSet>& _rxCursor, bool bUseCloned = false);
78  // if bUseCloned == sal_True, the cursor is first doubled over the XCloneable interface (which it must implement)
79  // and then used
80 
81  friend bool operator==(const CursorWrapper& lhs, const CursorWrapper& rhs)
82  {
83  return lhs.m_xGeneric.get() == rhs.m_xGeneric.get();
84  }
85 
86  bool is() const { return m_xMoveOperations.is(); }
87  bool Is() const { return m_xMoveOperations.is(); }
88 
89  operator const css::uno::Reference< css::uno::XInterface>& () const{ return m_xGeneric; }
90 
91  // 'Conversions'
92  CursorWrapper& operator=(const css::uno::Reference< css::sdbc::XRowSet>& xCursor);
93  operator const css::uno::Reference< css::sdbc::XResultSet>& () const { return m_xMoveOperations; }
94 
95  const css::uno::Reference< css::beans::XPropertySet >& getPropertySet() const { return m_xPropertyAccess; }
96 
97  // css::uno::Reference< css::sdbcx::XRowLocate>
100  css::uno::Any getBookmark()
101  { return m_xBookmarkOperations->getBookmark(); }
104  bool moveToBookmark(const css::uno::Any& bookmark) { return m_xBookmarkOperations->moveToBookmark(bookmark); }
105 
106  // css::sdbc::XResultSet
107  bool isBeforeFirst() const { return m_xMoveOperations->isBeforeFirst(); }
108  bool isAfterLast() const { return m_xMoveOperations->isAfterLast(); }
109  bool isFirst() const { return m_xMoveOperations->isFirst(); }
110  bool isLast() const { return m_xMoveOperations->isLast(); }
111  void beforeFirst() { m_xMoveOperations->beforeFirst(); }
112  bool first() { return m_xMoveOperations->first(); }
113  bool last() { return m_xMoveOperations->last(); }
114  sal_Int32 getRow() const { return m_xMoveOperations->getRow(); }
115  bool absolute(sal_Int32 nPosition) { return m_xMoveOperations->absolute(nPosition); }
116  bool relative(sal_Int32 nCount) { return m_xMoveOperations->relative(nCount); }
117  bool previous() { return m_xMoveOperations->previous(); }
118  bool next() { return m_xMoveOperations->next(); }
119  void refreshRow() { m_xMoveOperations->refreshRow(); }
120  bool rowDeleted() { return m_xMoveOperations->rowDeleted(); }
121  // css::sdbcx::XColumnsSupplier
123  css::uno::Reference< css::container::XNameAccess> getColumns() const { return m_xColumnsSupplier->getColumns(); }
124 private:
125  void ImplConstruct(const css::uno::Reference< css::sdbc::XResultSet>& _rxCursor, bool bUseCloned);
126 };
127 
128 
131 {
132  friend class FmXDisposeMultiplexer;
133 
135  osl::Mutex m_aMutex;
136 
137 public:
138  virtual ~FmXDisposeListener();
139 
141  virtual void disposing(sal_Int16 _nId) = 0;
142 
143 protected:
144  void setAdapter(FmXDisposeMultiplexer* pAdapter);
145 };
146 
147 class SAL_WARN_UNUSED FmXDisposeMultiplexer : public cppu::WeakImplHelper< css::lang::XEventListener >
148 {
149  css::uno::Reference< css::lang::XComponent> m_xObject;
151 
152  virtual ~FmXDisposeMultiplexer() override;
153 public:
154  FmXDisposeMultiplexer(FmXDisposeListener* _pListener, const css::uno::Reference< css::lang::XComponent>& _rxObject);
155 
156 // css::lang::XEventListener
157  virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
158 
159  void dispose();
160 };
161 
162 sal_Int16 getControlTypeByObject(const css::uno::Reference< css::lang::XServiceInfo>& _rxObject);
163  // get the object type (OBJ_FM_...) from the services the object supports
164 
165 
166 bool isRowSetAlive(const css::uno::Reference< css::uno::XInterface>& _rxRowSet);
167  // checks if the css::sdbcx::XColumnsSupplier provided by _rxRowSet supplies any columns
168 
169 
170 typedef ::std::set< css::uno::Reference< css::uno::XInterface > > InterfaceBag;
171 
172 #endif // INCLUDED_SVX_FMTOOLS_HXX
173 
174 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
::std::set< css::uno::Reference< css::uno::XInterface > > InterfaceBag
Definition: fmtools.hxx:170
css::uno::Reference< css::sdbc::XResultSet > m_xMoveOperations
Definition: fmtools.hxx:69
sal_Int32 getElementPos(const css::uno::Reference< css::container::XIndexAccess > &xCont, const css::uno::Reference< css::uno::XInterface > &xElement)
bool next()
Definition: fmtools.hxx:118
sal_Int32 getRow() const
Definition: fmtools.hxx:114
css::uno::Reference< css::sdbcx::XRowLocate > m_xBookmarkOperations
Definition: fmtools.hxx:70
css::uno::Reference< css::beans::XPropertySet > m_xPropertyAccess
Definition: fmtools.hxx:72
const css::uno::Reference< css::beans::XPropertySet > & getPropertySet() const
Definition: fmtools.hxx:95
css::uno::Reference< css::container::XNameAccess > getColumns() const
Definition: fmtools.hxx:123
bool isFirst() const
Definition: fmtools.hxx:109
bool isLast() const
Definition: fmtools.hxx:110
#define SVX_DLLPUBLIC
Definition: svxdllapi.h:28
css::uno::Reference< css::uno::XInterface > m_xGeneric
Definition: fmtools.hxx:68
SVX_DLLPUBLIC OUString getLabelName(const css::uno::Reference< css::beans::XPropertySet > &xControlModel)
bool rowDeleted()
Definition: fmtools.hxx:120
rtl::Reference< FmXDisposeMultiplexer > m_pAdapter
Definition: fmtools.hxx:134
bool moveToBookmark(const css::uno::Any &bookmark)
Definition: fmtools.hxx:104
bool isRowSetAlive(const css::uno::Reference< css::uno::XInterface > &_rxRowSet)
css::uno::Reference< css::lang::XComponent > m_xObject
Definition: fmtools.hxx:149
class SAL_NO_VTABLE XPropertySet
Definition: xmlexchg.hxx:31
bool last()
Definition: fmtools.hxx:113
bool isAfterLast() const
Definition: fmtools.hxx:108
virtual void SAL_CALL disposing(const css::lang::EventObject &Source) override
Definition: fmtools.cxx:302
#define SAL_WARN_UNUSED
void displayException(const css::sdbc::SQLException &, vcl::Window *_pParent)
Definition: fmtools.cxx:144
void refreshRow()
Definition: fmtools.hxx:119
sal_Int16 getControlTypeByObject(const css::uno::Reference< css::lang::XServiceInfo > &_rxObject)
bool absolute(sal_Int32 nPosition)
Definition: fmtools.hxx:115
FmXDisposeListener * m_pListener
Definition: fmtools.hxx:150
bool Is() const
Definition: fmtools.hxx:87
bool isBeforeFirst() const
Definition: fmtools.hxx:107
void dispose()
friend bool operator==(const CursorWrapper &lhs, const CursorWrapper &rhs)
Definition: fmtools.hxx:81
css::uno::Any getBookmark()
Definition: fmtools.hxx:100
void beforeFirst()
Definition: fmtools.hxx:111
bool is() const
Definition: fmtools.hxx:86
osl::Mutex m_aMutex
Definition: fmtools.hxx:135
bool relative(sal_Int32 nCount)
Definition: fmtools.hxx:116
bool previous()
Definition: fmtools.hxx:117
bool first()
Definition: fmtools.hxx:112
css::uno::Reference< css::sdbcx::XColumnsSupplier > m_xColumnsSupplier
Definition: fmtools.hxx:71