svx/inc/svx/gridctrl.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: gridctrl.hxx,v $
  10  * $Revision: 1.4 $
  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_GRIDCTRL_HXX
  31 #define _SVX_GRIDCTRL_HXX
  32
  33 #include <tools/list.hxx>
  34 #include <com/sun/star/sdbc/XRowSet.hpp>
  35 #include <com/sun/star/beans/PropertyChangeEvent.hpp>
  36 #include <com/sun/star/util/XNumberFormatter.hpp>
  37 #include <com/sun/star/util/Date.hpp>
  38 #include <com/sun/star/container/XIndexAccess.hpp>
  39 #include <vcl/fixed.hxx>
  40 #include <vcl/field.hxx>
  41
  42 #ifndef _SV_BUTTON_HXX //autogen
  43 #include <vcl/button.hxx>
  44 #endif
  45 #include <tools/date.hxx>
  46 #include <tools/ref.hxx>
  47 #include <svtools/editbrowsebox.hxx>
  48 #include <vos/mutex.hxx>
  49 #include <comphelper/propmultiplex.hxx>
  50 #include <svtools/transfer.hxx>
  51 #include "svx/svxdllapi.h"
  52
  53 class DbGridControl;
  54 class CursorWrapper;
  55
  56 sal_Bool CompareBookmark(const ::com::sun::star::uno::Any& aLeft, const ::com::sun::star::uno::Any& aRight);
  57
  58 namespace svxform
  59 {
  60     class DataColumn;
  61 }
  62 DECLARE_LIST(DbDataColumns, ::svxform::DataColumn*)
  63
  64 enum GridRowStatus
  65 {
  66     GRS_CLEAN,
  67     GRS_MODIFIED,
  68     GRS_DELETED,
  69     GRS_INVALID
  70 };
  71
  72 //==================================================================
  73 // DbGridRow, Zeilenbeschreibung
  74 //==================================================================
  75
  76 class DbGridRow : public SvRefBase
  77 {
  78     ::com::sun::star::uno::Any                                          m_aBookmark;            // ::com::sun::star::text::Bookmark der Zeile, kann gesetzt sein
  79     DbDataColumns                               m_aVariants;
  80     GridRowStatus                               m_eStatus;
  81     sal_Bool                                            m_bIsNew;
  82                                                     // Zeile ist nicht mehr gueltig,
  83                                                     // wird bei der naechsten positionierung entfernt
  84 public:
  85     DbGridRow():m_eStatus(GRS_CLEAN), m_bIsNew(sal_True) { }
  86     DbGridRow(CursorWrapper* pCur, sal_Bool bPaintCursor);
  87     void SetState(CursorWrapper* pCur, sal_Bool bPaintCursor);
  88
  89     ~DbGridRow();
  90
  91     // da GetField auf Geschwindigkeit getuned ist vorher immer noch hasField verwenden
  92     sal_Bool HasField(sal_uInt32 nPos) const {return nPos < m_aVariants.Count();}
  93     const ::svxform::DataColumn& GetField(sal_uInt32 nPos) const { return *m_aVariants.GetObject(nPos); }
  94
  95     void                        SetStatus(GridRowStatus _eStat) { m_eStatus = _eStat; }
  96     GridRowStatus       GetStatus() const                               { return m_eStatus; }
  97     void                        SetNew(sal_Bool _bNew)                          { m_bIsNew = _bNew; }
  98     sal_Bool                    IsNew() const                                   { return m_bIsNew; }
  99
 100     const ::com::sun::star::uno::Any& GetBookmark() const { return m_aBookmark; }
 101
 102     sal_Bool    IsValid() const { return m_eStatus == GRS_CLEAN || m_eStatus == GRS_MODIFIED; }
 103     sal_Bool    IsModified() const { return m_eStatus == GRS_MODIFIED; }
 104 };
 105
 106 SV_DECL_REF(DbGridRow)
 107
 108 //==================================================================
 109 // DbGridControl
 110 //==================================================================
 111 class DbGridColumn;
 112 DECLARE_LIST(DbGridColumns, DbGridColumn*)
 113
 114 //==================================================================
 115 class FmGridListener
 116 {
 117 public:
 118     virtual void selectionChanged() = 0;
 119     virtual void columnChanged() = 0;
 120 };
 121
 122 #define GRID_COLUMN_NOT_FOUND   ((sal_uInt16)-1)
 123
 124 //==================================================================
 125 // InitWindowFacet, describing which aspect of a column's Window to (re-)initialize
 126 //==================================================================
 127 enum InitWindowFacet
 128 {
 129     InitFont        = 0x01,
 130     InitForeground  = 0x02,
 131     InitBackground  = 0x04,
 132     InitWritingMode = 0x08,
 133     InitAll         = 0xFF
 134 };
 135
 136 //==================================================================
 137 class FmXGridSourcePropListener;
 138 class DisposeListenerGridBridge;
 139 typedef ::svt::EditBrowseBox    DbGridControl_Base;
 140 class SVX_DLLPUBLIC DbGridControl : public DbGridControl_Base
 141 {
 142     friend class FmXGridSourcePropListener;
 143     friend class GridFieldValueListener;
 144     friend class DisposeListenerGridBridge;
 145
 146 public:
 147     //==================================================================
 148     // NavigationBar
 149     //==================================================================
 150     class NavigationBar: public Control
 151     {
 152         class AbsolutePos : public NumericField
 153         {
 154         public:
 155             AbsolutePos(Window* pParent, WinBits nStyle = 0);
 156
 157             virtual void KeyInput(const KeyEvent& rEvt);
 158             virtual void LoseFocus();
 159         };
 160
 161         friend class NavigationBar::AbsolutePos;
 162
 163         //      zusaetzliche Controls
 164         FixedText               m_aRecordText;
 165         AbsolutePos             m_aAbsolute;                    // AbsolutePositionierung
 166         FixedText               m_aRecordOf;
 167         FixedText               m_aRecordCount;
 168
 169         ImageButton             m_aFirstBtn;                    // ImageButton fuer 'gehe zum ersten Datensatz'
 170         ImageButton             m_aPrevBtn;                     // ImageButton fuer 'gehe zum vorhergehenden Datensatz'
 171         ImageButton             m_aNextBtn;                     // ImageButton fuer 'gehe zum naechsten Datensatz'
 172         ImageButton             m_aLastBtn;                     // ImageButton fuer 'gehe zum letzten Datensatz'
 173         ImageButton             m_aNewBtn;                      // ImageButton fuer 'gehe zum neuen Datensatz'
 174         sal_uInt16              m_nDefaultWidth;
 175         sal_Int32               m_nCurrentPos;
 176
 177         sal_Bool                        m_bPositioning;         // protect PositionDataSource against recursion
 178
 179     public:
 180         //      StatusIds fuer Controls der Bar
 181         //  wichtig fuers Invalidieren
 182         enum State
 183         {
 184             RECORD_TEXT = 1,
 185             RECORD_ABSOLUTE,
 186             RECORD_OF,
 187             RECORD_COUNT,
 188             RECORD_FIRST,
 189             RECORD_NEXT,
 190             RECORD_PREV,
 191             RECORD_LAST,
 192             RECORD_NEW
 193         };
 194
 195         NavigationBar(Window* pParent, WinBits nStyle = 0);
 196
 197         // Status Methoden fuer Controls
 198         void InvalidateAll(sal_Int32 nCurrentPos = -1, sal_Bool bAll = sal_False);
 199         void InvalidateState(sal_uInt16 nWhich) {SetState(nWhich);}
 200         void SetState(sal_uInt16 nWhich);
 201         sal_Bool GetState(sal_uInt16 nWhich) const;
 202         sal_uInt16 GetDefaultWidth() const {return m_nDefaultWidth;}
 203
 204     protected:
 205         virtual void Resize();
 206         virtual void Paint(const Rectangle& rRect);
 207         virtual void StateChanged( StateChangedType nType );
 208
 209     private:
 210         DECL_LINK(OnClick, Button*);
 211         sal_uInt16 ArrangeControls();
 212
 213         void PositionDataSource(sal_Int32 nRecord);
 214     };
 215
 216     friend class DbGridControl::NavigationBar;
 217
 218 public:
 219     // diese Optionen werden verodert und geben an, welche der einzelnen feature
 220     // freigegeben werden koennen, default ist readonly also 0
 221     enum Option
 222     {
 223         OPT_READONLY    = 0x00,
 224         OPT_INSERT              = 0x01,
 225         OPT_UPDATE              = 0x02,
 226         OPT_DELETE              = 0x04
 227     };
 228
 229 private:
 230     Font                        m_aDefaultFont;
 231     Link                        m_aMasterStateProvider;
 232     Link                        m_aMasterSlotExecutor;
 233
 234     ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >                m_xFormatter;
 235     ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >    m_xServiceFactory;
 236
 237     DbGridColumns       m_aColumns;                     // Spaltenbeschreibung
 238     NavigationBar       m_aBar;
 239     DbGridRowRef        m_xDataRow;                     // Zeile die modifiziert werden kann
 240                                         // kommt vom DatenCursor
 241     DbGridRowRef        m_xSeekRow,                     // Zeile die von Iterator gesetzt wird
 242                                         // kommt vom DatenCursor
 243
 244                     m_xEmptyRow;                // Datensatz zum einfuegen
 245
 246     sal_uInt32                  m_nAsynAdjustEvent;
 247
 248     // if we modify the row for the new record, we automatically insert a "new new row".
 249     // But if somebody else inserts a new record into the data source, we have to do the same.
 250     // For that reason we have to listen to some properties of our data source.
 251     ::comphelper::OPropertyChangeMultiplexer*           m_pDataSourcePropMultiplexer;
 252     FmXGridSourcePropListener*                                          m_pDataSourcePropListener;
 253
 254     void*                                                                                       m_pFieldListeners;
 255         // property listeners for field values
 256
 257     DisposeListenerGridBridge*                                          m_pCursorDisposeListener;
 258         // need to know about the diposing of the seek cursor
 259         // construct analogous to the data source proplistener/multiplexer above :
 260         // DisposeListenerGridBridge is a bridge from FmXDisposeListener which I don't want to be derived from
 261
 262     FmGridListener*                                 m_pGridListener;
 263
 264 protected:
 265     CursorWrapper*      m_pDataCursor;          // Cursor fuer Updates
 266     CursorWrapper*  m_pSeekCursor;              // Cursor zum Seeken
 267
 268 private:
 269     // dieses sind Laufvariablen
 270     DbGridRowRef                m_xCurrentRow;          // Row an der aktuellen Zeile
 271     DbGridRowRef                m_xPaintRow;            // Row die gerade drgestellt werden soll
 272     sal_Int32                   m_nSeekPos;                     // Position des SeekCursors
 273     sal_Int32                   m_nTotalCount;          // wird gesetzt, wenn der DatenCursor mit dem Zählen der
 274                                             // Datensätze fertig ist
 275                                             // initial Wert ist -1
 276     osl::Mutex                  m_aDestructionSafety;
 277     osl::Mutex                  m_aAdjustSafety;
 278
 279     com::sun::star::util::Date
 280                         m_aNullDate;            // NullDate of the Numberformatter;
 281
 282     BrowserMode                 m_nMode;
 283     sal_Int32                   m_nCurrentPos;          // Aktuelle Position;
 284     sal_uInt32                  m_nDeleteEvent;         // EventId fuer asychrone Loeschen von Zeilen
 285     sal_uInt16                  m_nOptions;                     // Was kann das Control (Insert, Update, Delete)
 286                                         // default readonly
 287     sal_uInt16                  m_nOptionMask;          // the mask of options to be enabled in setDataSource
 288                                         // (with respect to the data source capabilities)
 289                                         // defaults to (insert | update | delete)
 290     USHORT              m_nLastColId;
 291     long                m_nLastRowId;
 292
 293     sal_Bool                    m_bDesignMode : 1;              // default = sal_False
 294     sal_Bool                    m_bRecordCountFinal : 1;
 295     sal_Bool                    m_bMultiSelection   : 1;
 296     sal_Bool                    m_bNavigationBar          : 1;
 297
 298     sal_Bool                    m_bSynchDisplay : 1;
 299     sal_Bool                    m_bForceROController : 1;
 300     sal_Bool                    m_bHandle : 1;
 301     sal_Bool                    m_bFilterMode : 1;
 302     sal_Bool                    m_bWantDestruction : 1;
 303     sal_Bool                    m_bInAdjustDataSource : 1;
 304     sal_Bool                    m_bPendingAdjustRows : 1;       // if an async adjust is pending, is it for AdjustRows or AdjustDataSource ?
 305     sal_Bool            m_bHideScrollbars : 1;
 306
 307 protected:
 308     sal_Bool                    m_bUpdating : 1;                        // werden gerade updates durchgefuehrt
 309
 310 protected:
 311     virtual sal_Bool SeekRow(long nRow);
 312     virtual void VisibleRowsChanged( long nNewTopRow, sal_uInt16 nNumRows);
 313     virtual void PaintStatusCell(OutputDevice& rDev, const Rectangle& rRect) const;
 314     virtual void PaintCell(OutputDevice& rDev, const Rectangle& rRect, sal_uInt16 nColId) const;
 315     virtual RowStatus GetRowStatus(long nRow) const;
 316     virtual sal_Bool CursorMoving(long nNewRow, sal_uInt16 nNewCol);
 317     virtual void CursorMoved();
 318     virtual void ArrangeControls(sal_uInt16& nX, sal_uInt16 nY);
 319     virtual sal_uInt32 GetTotalCellWidth(long nRow, sal_uInt16 nColId);
 320     virtual void Command(const CommandEvent& rEvt);
 321     virtual long PreNotify(NotifyEvent& rEvt);
 322     virtual void KeyInput(const KeyEvent& rEvt);
 323     virtual void StateChanged( StateChangedType nType );
 324     virtual void DataChanged( const DataChangedEvent& rDCEvt );
 325     virtual void Select();
 326
 327     virtual ::svt::CellController* GetController(long nRow, sal_uInt16 nCol);
 328
 329     virtual void CellModified();
 330     virtual sal_Bool SaveModified();
 331     virtual sal_Bool IsModified() const;
 332
 333     virtual sal_uInt16 AppendColumn(const String& rName, sal_uInt16 nWidth = 0, sal_uInt16 nPos = HEADERBAR_APPEND, sal_uInt16 nId = (sal_uInt16)-1);
 334     virtual void RemoveColumn(sal_uInt16 nId);
 335     virtual DbGridColumn* CreateColumn(sal_uInt16 nId) const;
 336     virtual void ColumnMoved(sal_uInt16 nId);
 337     virtual sal_Bool SaveRow();
 338     virtual sal_Bool IsTabAllowed(sal_Bool bForward) const;
 339
 340     /// hide a column
 341     virtual void        HideColumn(sal_uInt16 nId);
 342     /// show a column
 343     virtual void        ShowColumn(sal_uInt16 nId);
 344
 345     /** This is called before executing a context menu for a row. rMenu contains the initial entries
 346         handled by this base class' method (which always has to be called).
 347         Derived classes may alter the menu in any way and handle any additional entries in
 348         PostExecuteColumnContextMenu.
 349         All disabled entries will be removed before executing the menu, so be careful with separators
 350         near entries you probably wish to disable ...
 351     */
 352     virtual void PreExecuteRowContextMenu(sal_uInt16 nRow, PopupMenu& rMenu);
 353     /** After executing the context menu for a row this method is called.
 354     */
 355     virtual void PostExecuteRowContextMenu(sal_uInt16 nRow, const PopupMenu& rMenu, sal_uInt16 nExecutionResult);
 356
 357     virtual void DataSourcePropertyChanged(const ::com::sun::star::beans::PropertyChangeEvent& evt) throw(::com::sun::star::uno::RuntimeException);
 358
 359     virtual void FieldValueChanged(sal_uInt16 _nId, const ::com::sun::star::beans::PropertyChangeEvent& _evt);
 360     virtual void FieldListenerDisposing(sal_uInt16 _nId);
 361
 362     virtual void disposing(sal_uInt16 _nId, const ::com::sun::star::lang::EventObject& _rEvt);
 363
 364     // own overridables
 365     /// called when the current row changed
 366     virtual void onRowChange();
 367     /// called when the current column changed
 368     virtual void onColumnChange();
 369
 370     // DragSourceHelper overridables
 371     virtual void StartDrag( sal_Int8 nAction, const Point& rPosPixel );
 372
 373     void        executeRowContextMenu( long _nRow, const Point& _rPreferredPos );
 374
 375 public:
 376     DbGridControl(
 377         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >,
 378         Window* pParent,
 379         WinBits nBits = WB_BORDER);
 380
 381     virtual ~DbGridControl();
 382
 383     virtual void Init();
 384     virtual void InitColumnsByFields(const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& xFields) = 0;
 385     virtual void RemoveRows();
 386
 387     /** GetCellText returns the text at the given position
 388         @param  _nRow
 389             the number of the row
 390         @param  _nColId
 391             the ID of the column
 392         @return
 393             the text out of the cell
 394     */
 395     virtual String      GetCellText(long _nRow, USHORT _nColId) const;
 396
 397     void RemoveRows(sal_Bool bNewCursor);
 398
 399     void InvalidateStatus();
 400
 401     const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& getNumberFormatter() const {return m_xFormatter;}
 402
 403     // die Datenquelle
 404     // die Optionen koennen die Updatefaehigkeiten noch einschraenken, nicht erweitern
 405     virtual void setDataSource(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet >& rCursor,
 406         sal_uInt16 nOpts = OPT_INSERT | OPT_UPDATE | OPT_DELETE);
 407     virtual void Dispatch(sal_uInt16 nId);
 408
 409     CursorWrapper* getDataSource() const {return m_pDataCursor;}
 410     const DbGridColumns& GetColumns() const {return m_aColumns;}
 411
 412     void EnableHandle(sal_Bool bEnable);
 413     sal_Bool HasHandle() const {return m_bHandle;}
 414     void InsertHandleColumn();
 415
 416     /// welche Position hat die Spalte mit der Id in der ::com::sun::star::sdbcx::View, die Handle-Column zahelt nicht mit
 417     sal_uInt16 GetViewColumnPos( sal_uInt16 nId ) const { sal_uInt16 nPos = GetColumnPos(nId); return (nPos==(sal_uInt16)-1) ? GRID_COLUMN_NOT_FOUND : nPos-1; }
 418
 419     /** welche Position hat die Spalte mit der Id in m_aColumns, also dem von GetColumns gelieferten ::com::sun::star::sdbcx::Container ?
 420         (unterscheidet sich u.U. von der von GetViewColumnPos gelieferten, wenn es versteckt Spalten gibt)
 421     */
 422     sal_uInt16 GetModelColumnPos( sal_uInt16 nId ) const;
 423
 424     /// Anzahl der Spalten im Model
 425     sal_uInt16 GetViewColCount() const { return ColCount() - 1; }
 426     sal_uInt16 GetModelColCount() const { return (sal_uInt16)m_aColumns.Count(); }
 427     /// umgekehrt zu GetViewColumnPos : Id zu Position, die erste Nicht-Handle-Column hat die Position 0
 428     sal_uInt16 GetColumnIdFromViewPos( sal_uInt16 nPos ) const { return GetColumnId(nPos + 1); }
 429     sal_uInt16 GetColumnIdFromModelPos( sal_uInt16 nPos ) const;
 430
 431     virtual void SetDesignMode(sal_Bool bMode);
 432     sal_Bool IsDesignMode() const {return m_bDesignMode;}
 433     sal_Bool IsOpen() const {return m_pSeekCursor != NULL;}
 434
 435     virtual void SetFilterMode(sal_Bool bMode);
 436     sal_Bool IsFilterMode() const {return m_bFilterMode;}
 437     sal_Bool IsFilterRow(long nRow) const {return m_bFilterMode && nRow == 0;}
 438
 439     void EnableNavigationBar(sal_Bool bEnable);
 440     sal_Bool HasNavigationBar() const {return m_bNavigationBar;}
 441
 442     sal_uInt16 GetOptions() const {return m_nOptions;}
 443     NavigationBar& GetNavigationBar() {return m_aBar;}
 444     sal_uInt16 SetOptions(sal_uInt16 nOpt);
 445         // The new options are interpreted with respect to the current data source. If it is unable
 446         // to update, to insert or to restore, the according options are ignored. If the grid isn't
 447         // connected to a data source, all options except OPT_READONLY are ignored.
 448
 449     void SetMultiSelection(sal_Bool bMulti);
 450     sal_Bool GetMultiSelection() const {return m_bMultiSelection;}
 451
 452     const com::sun::star::util::Date&   getNullDate() const {return m_aNullDate;}
 453
 454     // Positionierung
 455     void MoveToPosition(sal_uInt32 nPos);
 456     void MoveToFirst();
 457     void MoveToNext();
 458     void MoveToPrev();
 459     void MoveToLast();
 460     void AppendNew();
 461
 462     // Abgleich der Cursor falls von außen der DatenCursor verschoben wurde
 463     // Flag bedeutet ob ein Abgleich es Rowcounts vorgenommen werden soll
 464     void AdjustDataSource(sal_Bool bFull = sal_False);
 465     void Undo();
 466
 467     virtual void BeginCursorAction();
 468     virtual void EndCursorAction();
 469
 470     // wird die aktuelle Zeile neu gesetzt
 471     sal_Bool IsUpdating() const {return m_bUpdating;}
 472
 473     virtual void RowRemoved( long nRow, long nNumRows = 1, sal_Bool bDoPaint = sal_True );
 474     virtual void RowInserted( long nRow, long nNumRows = 1, sal_Bool bDoPaint = sal_True, sal_Bool bKeepSelection = sal_False );
 475     virtual void RowModified( long nRow, sal_uInt16 nColId = USHRT_MAX );
 476
 477     void resetCurrentRow();
 478
 479     sal_Bool getDisplaySynchron() const { return m_bSynchDisplay; }
 480     void setDisplaySynchron(sal_Bool bSync);
 481     void forceSyncDisplay();
 482         // wenn das auf sal_False gesetzt wird, laeuft die Anzeige nicht mehr mit der aktuellen Cursor-Position synchron
 483         // (soll heissen, in AdjustDataSource wird nicht in die zur CursorPosition gehoerenden Zeile gesprungen)
 484         // wer das benutzt, sollte bitte wissen, was er tut, da zum Beispiel die Eingabe von Daten in einer Zeile auf der Anzeige,
 485         // die gar nicht mit der Position des Cursors synchron ist, ziemlich kritisch sein koennte
 486
 487     sal_Bool isForcedROController() const { return m_bForceROController; }
 488     void forceROController(sal_Bool bForce);
 489         // Setzt man das auf sal_True, hat das GridControl immer einen ::com::sun::star::frame::Controller, der allerdings read-only ist. Ausserdem
 490         // wird die Edit-Zeile des Controllers so eingestellt, dass sie ihre Selektion bei Fokus-Verlust weiterhin anzeigt.
 491
 492     const DbGridRowRef& GetCurrentRow() const {return m_xCurrentRow;}
 493
 494     void SetStateProvider(const Link& rProvider) { m_aMasterStateProvider = rProvider; }
 495         // if this link is set the given provider will be asked for the state of my items.
 496         // the return values are interpreted as follows :
 497         // <0 -> not specified (use default mechanism to determine the state)
 498         // ==0 -> the item is disabled
 499         // >0 -> the item is enabled
 500     void SetSlotExecutor(const Link& rExecutor) { m_aMasterSlotExecutor = rExecutor; }
 501         // analogous : if this link is set, all nav-bar slots will be routed through it when executed
 502         // if the handler returns nonzero, no further handling of the slot occurs
 503
 504     void EnablePermanentCursor(sal_Bool bEnable);
 505     sal_Bool IsPermanentCursorEnabled() const;
 506
 507     /** forces both scrollbars to be hidden
 508
 509         For the horizontal srollbar, this is overruled by enabling the navigation bar: A navigation
 510         bar <b>always</b> implies a horizontal scroll bar
 511         @seealso EnableNavigationBar
 512     */
 513     void        ForceHideScrollbars( sal_Bool _bForce );
 514     sal_Bool    IsForceHideScrollbars() const;
 515
 516     ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
 517         getServiceManager() const { return m_xServiceFactory; }
 518
 519     /// returns <TRUE/> if the text of the given cell can be copied into the clipboard
 520     sal_Bool    canCopyCellText(sal_Int32 _nRow, sal_Int16 _nColId);
 521     /// copies the text of the given cell into the clipboard
 522     void                copyCellText(sal_Int32 _nRow, sal_Int16 _nColId);
 523
 524     // selectin listener handling
 525     FmGridListener*             getGridListener() const { return m_pGridListener; }
 526     void                        setGridListener( FmGridListener* _pListener ) { m_pGridListener = _pListener; }
 527
 528     // helper class to grant access to selected methods from within the DbCellControl class
 529     struct GrantCellControlAccess
 530     {
 531         friend class DbCellControl;
 532     protected:
 533         GrantCellControlAccess() { }
 534     };
 535
 536     /// called when a controller needs to be re-initialized
 537     void refreshController(sal_uInt16 _nColId, GrantCellControlAccess _aAccess);
 538
 539     /**
 540         @return
 541             The count of additional controls of the control area.
 542     */
 543     virtual sal_Int32 GetAccessibleControlCount() const;
 544
 545     /** Creates the accessible object of an additional control.
 546         @param _nIndex
 547             The 0-based index of the control.
 548         @return
 549             The XAccessible interface of the specified control.
 550     */
 551     virtual ::com::sun::star::uno::Reference<
 552         ::com::sun::star::accessibility::XAccessible >
 553     CreateAccessibleControl( sal_Int32 _nIndex );
 554
 555     // IAccessibleTableProvider
 556     /** Creates the accessible object of a data table cell.
 557         @param nRow  The row index of the cell.
 558         @param nColumnId  The column ID of the cell.
 559         @return  The XAccessible interface of the specified cell. */
 560     virtual ::com::sun::star::uno::Reference<
 561         ::com::sun::star::accessibility::XAccessible >
 562     CreateAccessibleCell( sal_Int32 nRow, sal_uInt16 nColumnId );
 563
 564 protected:
 565     void RecalcRows(long nNewTopRow, sal_uInt16 nLinesOnScreen, sal_Bool bUpdateCursor);
 566     sal_Bool SeekCursor(long nRow, sal_Bool bAbsolute = sal_False);
 567     void RemoveColumns();               // aufraeumen eigener strukturen
 568     void AdjustRows();
 569     sal_Int32 AlignSeekCursor();
 570     sal_Bool SetCurrent(long nNewRow);
 571
 572     String GetCurrentRowCellText(DbGridColumn* pCol,const DbGridRowRef& _rRow) const;
 573     virtual void DeleteSelectedRows();
 574     sal_Bool IsValid(const DbGridRowRef& _xRow) const {return _xRow && _xRow->IsValid();}
 575
 576     // Zeile an der gerade eingefuegt wird
 577     sal_Bool IsCurrentAppending() const;
 578
 579     // Leerzeile zum Einfuegen
 580     sal_Bool IsInsertionRow(long nRow) const;
 581
 582     void  SetSeekPos(sal_Int32 nPos) {m_nSeekPos = nPos;}
 583     sal_Int32 GetCurrentPos() const {return m_nCurrentPos;}
 584     sal_Int32 GetSeekPos() const {return m_nSeekPos;}
 585     sal_Int32 GetTotalCount() const {return m_nTotalCount;}
 586
 587     const DbGridRowRef& GetEmptyRow() const {return m_xEmptyRow;}
 588     const DbGridRowRef& GetSeekRow() const {return m_xSeekRow;}
 589     CursorWrapper* GetSeekCursor() const {return m_pSeekCursor;}
 590
 591     void ConnectToFields();
 592     void DisconnectFromFields();
 593
 594     void implAdjustInSolarThread(sal_Bool _bRows);
 595         // calls AdjustRows or AdjustDataSource, synchron if the caller is running in the solar thread, else asynchron
 596
 597 protected:
 598     virtual void InitController(::svt::CellControllerRef& rController, long nRow, sal_uInt16 nCol);
 599     void Construct();
 600     void ImplInitWindow( const InitWindowFacet _eInitWhat );
 601     DECL_LINK(OnDelete, void*);
 602
 603     DECL_LINK(OnAsyncAdjust, void*);
 604         // if the param is != NULL, AdjustRows will be called, else AdjustDataSource
 605
 606 private:
 607     using BrowseBox::InsertHandleColumn;
 608 };
 609
 610
 611 SV_IMPL_REF(DbGridRow);
 612
 613
 614 #endif // _SVX_GRIDCTRL_HXX
 615