binfilter/inc/bf_svx/fmgridcl.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: fmgridcl.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _SVX_FMGRIDCL_HXX
  31 #define _SVX_FMGRIDCL_HXX
  32
  33 #ifndef _COM_SUN_STAR_CONTAINER_XINDEXCONTAINER_HPP_
  34 #include <com/sun/star/container/XIndexContainer.hpp>
  35 #endif
  36
  37 #ifndef _COM_SUN_STAR_FORM_XINDEXCONTAINER_HPP_
  38 #include <com/sun/star/container/XIndexContainer.hpp>
  39 #endif
  40 #ifndef _COM_SUN_STAR_CONTAINER_XNAMECONTAINER_HPP_
  41 #include <com/sun/star/container/XNameContainer.hpp>
  42 #endif
  43
  44 // alles nur fuer stl
  45 #ifndef _SVX_GRIDCTRL_HXX
  46 #include <bf_svx/gridctrl.hxx>
  47 #endif
  48 #ifndef _TRANSFER_HXX
  49 #include <svtools/transfer.hxx>
  50 #endif
  51 namespace binfilter {
  52
  53 //==================================================================
  54 // FmGridHeader
  55 //==================================================================
  56 struct FmGridHeaderData;
  57 class FmGridHeader
  58             :public EditBrowserHeader
  59             ,public DropTargetHelper
  60 {
  61 protected:
  62     FmGridHeaderData*           m_pImpl;
  63
  64     // trigger context menu execution
  65     void        triggerColumnContextMenu( const ::Point& _rPreferredPos );
  66
  67 public:
  68     FmGridHeader( BrowseBox* pParent, WinBits nWinBits = WB_STDHEADERBAR | WB_DRAG );
  69     ~FmGridHeader();
  70
  71 public:
  72     struct AccessControl { friend class FmGridControl; private: AccessControl() { } };
  73
  74     inline      void    triggerColumnContextMenu( const ::Point& _rPreferredPos, const AccessControl& )
  75     {
  76         triggerColumnContextMenu( _rPreferredPos );
  77     }
  78
  79 protected:
  80     virtual void Command( const CommandEvent& rCEvt );
  81     virtual void RequestHelp( const HelpEvent& rHEvt );
  82     virtual void Select();
  83
  84     /** the value returned by GetItemPos is meaningless for the grid model if there are hidden columns,
  85         so use GetModelColumnPos instead
  86     */
  87     sal_uInt16 GetModelColumnPos(sal_uInt16 nId) const;
  88
  89     /** This is called before executing a context menu for a column. rMenu contains the initial entries
  90         handled by this base class' method (which always has to be called).
  91         Derived classes may alter the menu in any way and handle any additional entries in
  92         PostExecuteColumnContextMenu.
  93         All disabled entries will be removed before executing the menu, so be careful with separators
  94         near entries you probably wish to disable ...
  95     */
  96     virtual void        PreExecuteColumnContextMenu(sal_uInt16 nColId, PopupMenu& rMenu);
  97     /** After executing the context menu for a column this method is called.
  98     */
  99     virtual     void    PostExecuteColumnContextMenu(sal_uInt16 nColId, const PopupMenu& rMenu, sal_uInt16 nExecutionResult);
 100
 101     // DropTargetHelper
 102     virtual sal_Int8    AcceptDrop( const AcceptDropEvent& rEvt );
 103     virtual sal_Int8    ExecuteDrop( const ExecuteDropEvent& rEvt );
 104
 105     /** selects the column at the selection supplier.
 106         @param  nColumnId
 107             The column id.
 108     */
 109     void notifyColumnSelect(sal_uInt16 nColumnId);
 110 private:
 111     DECL_LINK( OnAsyncExecuteDrop, void* );
 112 };
 113
 114 //==================================================================
 115 // FmGridControl
 116 //==================================================================
 117 class FmGridControl : public DbGridControl
 118
 119 {
 120     friend class FmGridHeader;
 121     friend class FmXGridPeer;
 122
 123     FmXGridPeer*                m_pPeer;
 124     sal_Int32                   m_nCurrentSelectedColumn;       // this is the column model (not the view) posisition ...
 125     sal_uInt16                  m_nMarkedColumnId;
 126     sal_Bool                    m_bSelecting;
 127     sal_Bool                    m_bInColumnMove : 1;
 128
 129 public:
 130     FmGridControl(
 131         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >,
 132         Window* pParent,
 133         FmXGridPeer* _pPeer,
 134         WinBits nBits);
 135
 136     // Window
 137     virtual void KeyInput( const KeyEvent& rKEvt );
 138
 139     // ::com::sun::star::beans::XPropertyChangeListener
 140     void SAL_CALL propertyChange(const ::com::sun::star::beans::PropertyChangeEvent& evt);
 141
 142     // ::com::sun::star::form::XPositioningListener
 143     void positioned(const ::com::sun::star::lang::EventObject& rEvent);
 144
 145     // XBound
 146     sal_Bool commit();
 147
 148     // ::com::sun::star::form::XInsertListener
 149     void inserted(const ::com::sun::star::lang::EventObject& rEvent);
 150
 151     // ::com::sun::star::form::XRestoreListener
 152     void restored(const ::com::sun::star::lang::EventObject& rEvent);
 153
 154     void markColumn(sal_uInt16 nId);
 155     sal_Bool isColumnMarked(sal_uInt16 nId) const;
 156
 157     sal_Int32   GetSelectedColumn() const;
 158
 159     /** return the name of the specified object.
 160         @param  eObjType
 161             The type to ask for
 162         @param  _nPosition
 163             The position of a tablecell (index position), header bar  colum/row cell
 164         @return
 165             The name of the specified object.
 166     */
 167     virtual ::rtl::OUString GetAccessibleName( AccessibleBrowseBoxObjType eObjType,sal_Int32 _nPosition = -1) const;
 168
 169     /** return the description of the specified object.
 170         @param  eObjType
 171             The type to ask for
 172         @param  _nPosition
 173             The position of a tablecell (index position), header bar  colum/row cell
 174         @return
 175             The description of the specified object.
 176     */
 177     virtual ::rtl::OUString GetAccessibleDescription( AccessibleBrowseBoxObjType eObjType,sal_Int32 _nPosition = -1) const;
 178
 179 protected:
 180     virtual void Command(const CommandEvent& rEvt);
 181
 182     virtual BrowserHeader* imp_CreateHeaderBar(BrowseBox* pParent);
 183     virtual void ColumnResized(sal_uInt16 nId);
 184     virtual void ColumnMoved(sal_uInt16 nId);
 185     virtual void DeleteSelectedRows();
 186     virtual void SetDesignMode(sal_Bool bMode);
 187     virtual void CellModified();
 188     virtual void HideColumn(sal_uInt16 nId);
 189     virtual void ShowColumn(sal_uInt16 nId);
 190
 191     sal_Bool    IsInColumnMove() const {return m_bInColumnMove;}
 192
 193     virtual void BeginCursorAction();
 194     virtual void EndCursorAction();
 195     virtual void Select();
 196
 197     // Initialisieren der Spalten
 198     // a.) nur ueber Spaltenbeschreibung
 199     virtual void InitColumnsByModels(const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexContainer >& xColumns);
 200     // b.) im alivemode ueber Datenbankfelder
 201     virtual void InitColumnsByFields(const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& xFields);
 202
 203             // some kind of impl version (for one single column) of our version of InitColumnsByFields
 204             void InitColumnByField(
 205                     DbGridColumn* _pColumn,
 206                     const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxColumnModel,
 207                     const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& _rxFieldsByNames,
 208                     const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& _rxFieldsByIndex
 209                 );
 210
 211     FmXGridPeer* GetPeer() const {return m_pPeer;}
 212
 213     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any>
 214             getSelectionBookmarks();
 215     sal_Bool selectBookmarks(const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any>& _rBookmarks);
 216
 217     /** returns if a column is selected
 218         @param  nColumnId
 219             The column id.
 220         @param  _pColumn
 221             The column to compare with.
 222         @return
 223             <TRUE/> if the column is selected, otherwise <FALSE/>
 224     */
 225     sal_Bool isColumnSelected(sal_uInt16 nColumnId,DbGridColumn* _pColumn);
 226 };
 227
 228 }//end of namespace binfilter
 229 #endif // _SVX_FMGRIDCL_HXX
 230