1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef TOOLKIT_SORTABLEGRIDDATAMODEL_HXX 25*b1cdbd2cSJim Jagielski #define TOOLKIT_SORTABLEGRIDDATAMODEL_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "initguard.hxx" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski /** === begin UNO includes === **/ 30*b1cdbd2cSJim Jagielski #include <com/sun/star/awt/grid/XSortableMutableGridDataModel.hpp> 31*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XServiceInfo.hpp> 32*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XInitialization.hpp> 33*b1cdbd2cSJim Jagielski #include <com/sun/star/i18n/XCollator.hpp> 34*b1cdbd2cSJim Jagielski #include <com/sun/star/awt/grid/XGridDataListener.hpp> 35*b1cdbd2cSJim Jagielski /** === end UNO includes === **/ 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski #include <comphelper/componentcontext.hxx> 38*b1cdbd2cSJim Jagielski #include <cppuhelper/basemutex.hxx> 39*b1cdbd2cSJim Jagielski #include <cppuhelper/compbase3.hxx> 40*b1cdbd2cSJim Jagielski #include <cppuhelper/implbase1.hxx> 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski //...................................................................................................................... 43*b1cdbd2cSJim Jagielski namespace toolkit 44*b1cdbd2cSJim Jagielski { 45*b1cdbd2cSJim Jagielski //...................................................................................................................... 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski class SortableGridDataModel; 48*b1cdbd2cSJim Jagielski typedef InitGuard< SortableGridDataModel > MethodGuard; 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski //================================================================================================================== 51*b1cdbd2cSJim Jagielski //= SortableGridDataModel 52*b1cdbd2cSJim Jagielski //================================================================================================================== 53*b1cdbd2cSJim Jagielski typedef ::cppu::WeakComponentImplHelper3 < ::com::sun::star::awt::grid::XSortableMutableGridDataModel 54*b1cdbd2cSJim Jagielski , ::com::sun::star::lang::XServiceInfo 55*b1cdbd2cSJim Jagielski , ::com::sun::star::lang::XInitialization 56*b1cdbd2cSJim Jagielski > SortableGridDataModel_Base; 57*b1cdbd2cSJim Jagielski typedef ::cppu::ImplHelper1 < ::com::sun::star::awt::grid::XGridDataListener 58*b1cdbd2cSJim Jagielski > SortableGridDataModel_PrivateBase; 59*b1cdbd2cSJim Jagielski class SortableGridDataModel :public ::cppu::BaseMutex 60*b1cdbd2cSJim Jagielski ,public SortableGridDataModel_Base 61*b1cdbd2cSJim Jagielski ,public SortableGridDataModel_PrivateBase 62*b1cdbd2cSJim Jagielski { 63*b1cdbd2cSJim Jagielski public: 64*b1cdbd2cSJim Jagielski SortableGridDataModel( ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > const & i_factory ); 65*b1cdbd2cSJim Jagielski SortableGridDataModel( SortableGridDataModel const & i_copySource ); 66*b1cdbd2cSJim Jagielski isInitialized() const67*b1cdbd2cSJim Jagielski bool isInitialized() const { return m_isInitialized; } 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski #ifdef DBG_UTIL 70*b1cdbd2cSJim Jagielski const char* checkInvariants() const; 71*b1cdbd2cSJim Jagielski #endif 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski protected: 74*b1cdbd2cSJim Jagielski ~SortableGridDataModel(); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski public: 77*b1cdbd2cSJim Jagielski // XSortableGridData 78*b1cdbd2cSJim Jagielski virtual void SAL_CALL sortByColumn( ::sal_Int32 ColumnIndex, ::sal_Bool SortAscending ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 79*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeColumnSort( ) throw (::com::sun::star::uno::RuntimeException); 80*b1cdbd2cSJim Jagielski virtual ::com::sun::star::beans::Pair< ::sal_Int32, ::sal_Bool > SAL_CALL getCurrentSortOrder( ) throw (::com::sun::star::uno::RuntimeException); 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski // XMutableGridDataModel 83*b1cdbd2cSJim Jagielski virtual void SAL_CALL addRow( const ::com::sun::star::uno::Any& Heading, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& Data ) throw (::com::sun::star::uno::RuntimeException); 84*b1cdbd2cSJim Jagielski virtual void SAL_CALL addRows( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& Headings, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > >& Data ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException); 85*b1cdbd2cSJim Jagielski virtual void SAL_CALL insertRow( ::sal_Int32 i_index, const ::com::sun::star::uno::Any& i_heading, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& Data ) throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IndexOutOfBoundsException); 86*b1cdbd2cSJim Jagielski virtual void SAL_CALL insertRows( ::sal_Int32 i_index, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any>& Headings, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > >& Data ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 87*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeRow( ::sal_Int32 RowIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 88*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeAllRows( ) throw (::com::sun::star::uno::RuntimeException); 89*b1cdbd2cSJim Jagielski virtual void SAL_CALL updateCellData( ::sal_Int32 ColumnIndex, ::sal_Int32 RowIndex, const ::com::sun::star::uno::Any& Value ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 90*b1cdbd2cSJim Jagielski virtual void SAL_CALL updateRowData( const ::com::sun::star::uno::Sequence< ::sal_Int32 >& ColumnIndexes, ::sal_Int32 RowIndex, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& Values ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException); 91*b1cdbd2cSJim Jagielski virtual void SAL_CALL updateRowHeading( ::sal_Int32 RowIndex, const ::com::sun::star::uno::Any& Heading ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 92*b1cdbd2cSJim Jagielski virtual void SAL_CALL updateCellToolTip( ::sal_Int32 ColumnIndex, ::sal_Int32 RowIndex, const ::com::sun::star::uno::Any& Value ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 93*b1cdbd2cSJim Jagielski virtual void SAL_CALL updateRowToolTip( ::sal_Int32 RowIndex, const ::com::sun::star::uno::Any& Value ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 94*b1cdbd2cSJim Jagielski virtual void SAL_CALL addGridDataListener( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::grid::XGridDataListener >& Listener ) throw (::com::sun::star::uno::RuntimeException); 95*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeGridDataListener( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::grid::XGridDataListener >& Listener ) throw (::com::sun::star::uno::RuntimeException); 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski // XGridDataModel 98*b1cdbd2cSJim Jagielski virtual ::sal_Int32 SAL_CALL getRowCount() throw (::com::sun::star::uno::RuntimeException); 99*b1cdbd2cSJim Jagielski virtual ::sal_Int32 SAL_CALL getColumnCount() throw (::com::sun::star::uno::RuntimeException); 100*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Any SAL_CALL getCellData( ::sal_Int32 Column, ::sal_Int32 RowIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 101*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Any SAL_CALL getCellToolTip( ::sal_Int32 Column, ::sal_Int32 RowIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 102*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Any SAL_CALL getRowHeading( ::sal_Int32 RowIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 103*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > SAL_CALL getRowData( ::sal_Int32 RowIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski // OComponentHelper 106*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing(); 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski // XCloneable 109*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Reference< ::com::sun::star::util::XCloneable > SAL_CALL createClone( ) throw (::com::sun::star::uno::RuntimeException); 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski // XServiceInfo 112*b1cdbd2cSJim Jagielski virtual ::rtl::OUString SAL_CALL getImplementationName( ) throw (::com::sun::star::uno::RuntimeException); 113*b1cdbd2cSJim Jagielski virtual ::sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw (::com::sun::star::uno::RuntimeException); 114*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames( ) throw (::com::sun::star::uno::RuntimeException); 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski // XInitialization 117*b1cdbd2cSJim Jagielski virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException); 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski // XGridDataListener 120*b1cdbd2cSJim Jagielski virtual void SAL_CALL rowsInserted( const ::com::sun::star::awt::grid::GridDataEvent& Event ) throw (::com::sun::star::uno::RuntimeException); 121*b1cdbd2cSJim Jagielski virtual void SAL_CALL rowsRemoved( const ::com::sun::star::awt::grid::GridDataEvent& Event ) throw (::com::sun::star::uno::RuntimeException); 122*b1cdbd2cSJim Jagielski virtual void SAL_CALL dataChanged( const ::com::sun::star::awt::grid::GridDataEvent& Event ) throw (::com::sun::star::uno::RuntimeException); 123*b1cdbd2cSJim Jagielski virtual void SAL_CALL rowHeadingChanged( const ::com::sun::star::awt::grid::GridDataEvent& Event ) throw (::com::sun::star::uno::RuntimeException); 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski // XEventListener 126*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& i_event ) throw (::com::sun::star::uno::RuntimeException); 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski // XInterface 129*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType ) throw (::com::sun::star::uno::RuntimeException); 130*b1cdbd2cSJim Jagielski virtual void SAL_CALL acquire( ) throw (); 131*b1cdbd2cSJim Jagielski virtual void SAL_CALL release( ) throw (); 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski // XTypeProvider 134*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes( ) throw (::com::sun::star::uno::RuntimeException); 135*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Sequence< ::sal_Int8 > SAL_CALL getImplementationId( ) throw (::com::sun::star::uno::RuntimeException); 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski private: 138*b1cdbd2cSJim Jagielski /** translates the given public index into one to be passed to our delegator 139*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 140*b1cdbd2cSJim Jagielski if the given index does not denote a valid row 141*b1cdbd2cSJim Jagielski */ 142*b1cdbd2cSJim Jagielski ::sal_Int32 impl_getPrivateRowIndex_throw( ::sal_Int32 const i_publicRowIndex ) const; 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski /** translates the given private row index to a public one 145*b1cdbd2cSJim Jagielski */ 146*b1cdbd2cSJim Jagielski ::sal_Int32 impl_getPublicRowIndex_nothrow( ::sal_Int32 const i_privateRowIndex ) const; 147*b1cdbd2cSJim Jagielski impl_isSorted_nothrow() const148*b1cdbd2cSJim Jagielski inline bool impl_isSorted_nothrow() const 149*b1cdbd2cSJim Jagielski { 150*b1cdbd2cSJim Jagielski return m_currentSortColumn >= 0; 151*b1cdbd2cSJim Jagielski } 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski /** rebuilds the index translation structure. 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski Neither <member>m_currentSortColumn</member> nor <member>m_sortAscending</member> are touched by this method. 156*b1cdbd2cSJim Jagielski Also, the given column index is not checked, this is the responsibility of the caller. 157*b1cdbd2cSJim Jagielski */ 158*b1cdbd2cSJim Jagielski bool impl_reIndex_nothrow( ::sal_Int32 const i_columnIndex, sal_Bool const i_sortAscending ); 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski /** translates the given event, obtained from our delegator, to a version which can be broadcasted to our own 161*b1cdbd2cSJim Jagielski clients. 162*b1cdbd2cSJim Jagielski */ 163*b1cdbd2cSJim Jagielski ::com::sun::star::awt::grid::GridDataEvent 164*b1cdbd2cSJim Jagielski impl_createPublicEvent( ::com::sun::star::awt::grid::GridDataEvent const & i_originalEvent ) const; 165*b1cdbd2cSJim Jagielski 166*b1cdbd2cSJim Jagielski /** broadcasts the given event to our registered XGridDataListeners 167*b1cdbd2cSJim Jagielski */ 168*b1cdbd2cSJim Jagielski void impl_broadcast( 169*b1cdbd2cSJim Jagielski void ( SAL_CALL ::com::sun::star::awt::grid::XGridDataListener::*i_listenerMethod )( const ::com::sun::star::awt::grid::GridDataEvent & ), 170*b1cdbd2cSJim Jagielski ::com::sun::star::awt::grid::GridDataEvent const & i_publicEvent, 171*b1cdbd2cSJim Jagielski MethodGuard& i_instanceLock 172*b1cdbd2cSJim Jagielski ); 173*b1cdbd2cSJim Jagielski 174*b1cdbd2cSJim Jagielski /** rebuilds our indexes, notifying row removal and row addition events 175*b1cdbd2cSJim Jagielski 176*b1cdbd2cSJim Jagielski First, a rowsRemoved event is notified to our registered listeners. Then, the index translation tables are 177*b1cdbd2cSJim Jagielski rebuilt, and a rowsInserted event is notified. 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski Only to be called when we're sorted. 180*b1cdbd2cSJim Jagielski */ 181*b1cdbd2cSJim Jagielski void impl_rebuildIndexesAndNotify( MethodGuard& i_instanceLock ); 182*b1cdbd2cSJim Jagielski 183*b1cdbd2cSJim Jagielski /** removes the current sorting, and notifies a change of all data 184*b1cdbd2cSJim Jagielski */ 185*b1cdbd2cSJim Jagielski void impl_removeColumnSort( MethodGuard& i_instanceLock ); 186*b1cdbd2cSJim Jagielski 187*b1cdbd2cSJim Jagielski /** removes the current sorting, without any broadcast 188*b1cdbd2cSJim Jagielski */ 189*b1cdbd2cSJim Jagielski void impl_removeColumnSort_noBroadcast(); 190*b1cdbd2cSJim Jagielski 191*b1cdbd2cSJim Jagielski private: 192*b1cdbd2cSJim Jagielski ::comphelper::ComponentContext m_context; 193*b1cdbd2cSJim Jagielski bool m_isInitialized; 194*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::awt::grid::XMutableGridDataModel > m_delegator; 195*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::i18n::XCollator > m_collator; 196*b1cdbd2cSJim Jagielski ::sal_Int32 m_currentSortColumn; 197*b1cdbd2cSJim Jagielski ::sal_Bool m_sortAscending; 198*b1cdbd2cSJim Jagielski ::std::vector< ::sal_Int32 > m_publicToPrivateRowIndex; 199*b1cdbd2cSJim Jagielski ::std::vector< ::sal_Int32 > m_privateToPublicRowIndex; 200*b1cdbd2cSJim Jagielski }; 201*b1cdbd2cSJim Jagielski 202*b1cdbd2cSJim Jagielski //...................................................................................................................... 203*b1cdbd2cSJim Jagielski } // namespace toolkit 204*b1cdbd2cSJim Jagielski //...................................................................................................................... 205*b1cdbd2cSJim Jagielski 206*b1cdbd2cSJim Jagielski #endif // TOOLKIT_SORTABLEGRIDDATAMODEL_HXX 207