sc/source/ui/dbgui/csvtablebox.cxx

   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
  20 #include "csvtablebox.hxx"
  21 #include <vcl/builderfactory.hxx>
  22 #include <vcl/lstbox.hxx>
  23 #include <vcl/settings.hxx>
  24 #include "editutil.hxx"
  25 #include "AccessibleCsvControl.hxx"
  26
  27 ScCsvTableBox::ScCsvTableBox( vcl::Window* pParent, WinBits nBits ) :
  28     ScCsvControl( pParent, maData, nBits ),
  29     maRuler( VclPtr<ScCsvRuler>::Create(*this) ),
  30     maGrid( VclPtr<ScCsvGrid>::Create(*this) ),
  31     maHScroll( VclPtr<ScrollBar>::Create( this, WB_HORZ | WB_DRAG ) ),
  32     maVScroll( VclPtr<ScrollBar>::Create( this, WB_VERT | WB_DRAG ) ),
  33     maScrollBox( VclPtr<ScrollBarBox>::Create(this) )
  34 {
  35     mbFixedMode = false;
  36     mnFixedWidth = 1;
  37
  38     maHScroll->EnableRTL( false ); // RTL
  39     maHScroll->SetLineSize( 1 );
  40     maVScroll->SetLineSize( 1 );
  41
  42     Link<ScCsvControl&,void> aLink = LINK( this, ScCsvTableBox, CsvCmdHdl );
  43     SetCmdHdl( aLink );
  44     maRuler->SetCmdHdl( aLink );
  45     maGrid->SetCmdHdl( aLink );
  46
  47     Link<ScrollBar*,void> aLink2 = LINK( this, ScCsvTableBox, ScrollHdl );
  48     maHScroll->SetScrollHdl( aLink2 );
  49     maVScroll->SetScrollHdl( aLink2 );
  50
  51     aLink2 = LINK( this, ScCsvTableBox, ScrollEndHdl );
  52     maHScroll->SetEndScrollHdl( aLink2 );
  53     maVScroll->SetEndScrollHdl( aLink2 );
  54
  55     InitControls();
  56 }
  57
  58 ScCsvTableBox::~ScCsvTableBox()
  59 {
  60     disposeOnce();
  61 }
  62
  63 void ScCsvTableBox::dispose()
  64 {
  65     maRuler.disposeAndClear();
  66     maGrid.disposeAndClear();
  67     maHScroll.disposeAndClear();
  68     maVScroll.disposeAndClear();
  69     maScrollBox.disposeAndClear();
  70     ScCsvControl::dispose();
  71 }
  72
  73 VCL_BUILDER_FACTORY_ARGS(ScCsvTableBox, WB_BORDER)
  74
  75 Size ScCsvTableBox::GetOptimalSize() const
  76 {
  77     Size aDefault(LogicToPixel(Size(243, 82), MapMode(MAP_APPFONT)));
  78     return aDefault;
  79 }
  80
  81 // common table box handling --------------------------------------------------
  82
  83 void ScCsvTableBox::SetSeparatorsMode()
  84 {
  85     if( mbFixedMode )
  86     {
  87         // rescue data for fixed width mode
  88         mnFixedWidth = GetPosCount();
  89         maFixColStates = maGrid->GetColumnStates();
  90         // switch to separators mode
  91         mbFixedMode = false;
  92         // reset and reinitialize controls
  93         DisableRepaint();
  94         Execute( CSVCMD_SETLINEOFFSET, 0 );
  95         Execute( CSVCMD_SETPOSCOUNT, 1 );
  96         Execute( CSVCMD_NEWCELLTEXTS );
  97         maGrid->SetColumnStates( maSepColStates );
  98         InitControls();
  99         EnableRepaint();
 100     }
 101 }
 102
 103 void ScCsvTableBox::SetFixedWidthMode()
 104 {
 105     if( !mbFixedMode )
 106     {
 107         // rescue data for separators mode
 108         maSepColStates = maGrid->GetColumnStates();
 109         // switch to fixed width mode
 110         mbFixedMode = true;
 111         // reset and reinitialize controls
 112         DisableRepaint();
 113         Execute( CSVCMD_SETLINEOFFSET, 0 );
 114         Execute( CSVCMD_SETPOSCOUNT, mnFixedWidth );
 115         maGrid->SetSplits( maRuler->GetSplits() );
 116         maGrid->SetColumnStates( maFixColStates );
 117         InitControls();
 118         EnableRepaint();
 119     }
 120 }
 121
 122 void ScCsvTableBox::Init()
 123 {
 124     maGrid->Init();
 125 }
 126
 127 void ScCsvTableBox::InitControls()
 128 {
 129     maGrid->UpdateLayoutData();
 130
 131     long nScrollBarSize = GetSettings().GetStyleSettings().GetScrollBarSize();
 132     Size aWinSize = CalcOutputSize( GetSizePixel() );
 133     long nDataWidth = aWinSize.Width() - nScrollBarSize;
 134     long nDataHeight = aWinSize.Height() - nScrollBarSize;
 135
 136     maData.mnWinWidth = nDataWidth;
 137     maData.mnWinHeight = nDataHeight;
 138
 139     if( mbFixedMode )
 140     {
 141         // ruler sets height internally
 142         maRuler->setPosSizePixel( 0, 0, nDataWidth, 0 );
 143         sal_Int32 nY = maRuler->GetSizePixel().Height();
 144         maData.mnWinHeight -= nY;
 145         maGrid->setPosSizePixel( 0, nY, nDataWidth, maData.mnWinHeight );
 146     }
 147     else
 148         maGrid->setPosSizePixel( 0, 0, nDataWidth, nDataHeight );
 149     maGrid->Show();
 150     maRuler->Show( mbFixedMode );
 151
 152     // scrollbars always visible
 153     maHScroll->setPosSizePixel( 0, nDataHeight, nDataWidth, nScrollBarSize );
 154     InitHScrollBar();
 155     maHScroll->Show();
 156
 157     // scrollbars always visible
 158     maVScroll->setPosSizePixel( nDataWidth, 0, nScrollBarSize, nDataHeight );
 159     InitVScrollBar();
 160     maVScroll->Show();
 161
 162     bool bScrBox = maHScroll->IsVisible() && maVScroll->IsVisible();
 163     if( bScrBox )
 164         maScrollBox->setPosSizePixel( nDataWidth, nDataHeight, nScrollBarSize, nScrollBarSize );
 165     maScrollBox->Show( bScrBox );
 166
 167     // let the controls self-adjust to visible area
 168     Execute( CSVCMD_SETPOSOFFSET, GetFirstVisPos() );
 169     Execute( CSVCMD_SETLINEOFFSET, GetFirstVisLine() );
 170 }
 171
 172 void ScCsvTableBox::InitHScrollBar()
 173 {
 174     maHScroll->SetRange( Range( 0, GetPosCount() + 2 ) );
 175     maHScroll->SetVisibleSize( GetVisPosCount() );
 176     maHScroll->SetPageSize( GetVisPosCount() * 3 / 4 );
 177     maHScroll->SetThumbPos( GetFirstVisPos() );
 178 }
 179
 180 void ScCsvTableBox::InitVScrollBar()
 181 {
 182     maVScroll->SetRange( Range( 0, GetLineCount() + 1 ) );
 183     maVScroll->SetVisibleSize( GetVisLineCount() );
 184     maVScroll->SetPageSize( GetVisLineCount() - 2 );
 185     maVScroll->SetThumbPos( GetFirstVisLine() );
 186 }
 187
 188 void ScCsvTableBox::MakePosVisible( sal_Int32 nPos )
 189 {
 190     if( (0 <= nPos) && (nPos < GetPosCount()) )
 191     {
 192         if( nPos - CSV_SCROLL_DIST + 1 <= GetFirstVisPos() )
 193             Execute( CSVCMD_SETPOSOFFSET, nPos - CSV_SCROLL_DIST );
 194         else if( nPos + CSV_SCROLL_DIST >= GetLastVisPos() )
 195             Execute( CSVCMD_SETPOSOFFSET, nPos - GetVisPosCount() + CSV_SCROLL_DIST );
 196     }
 197 }
 198
 199 // cell contents --------------------------------------------------------------
 200
 201 void ScCsvTableBox::SetUniStrings(
 202         const OUString* pTextLines, const OUString& rSepChars,
 203         sal_Unicode cTextSep, bool bMergeSep )
 204 {
 205     // assuming that pTextLines is a string array with size CSV_PREVIEW_LINES
 206     // -> will be dynamic sometime
 207     DisableRepaint();
 208     sal_Int32 nEndLine = GetFirstVisLine() + CSV_PREVIEW_LINES;
 209     const OUString* pString = pTextLines;
 210     for( sal_Int32 nLine = GetFirstVisLine(); nLine < nEndLine; ++nLine, ++pString )
 211     {
 212         if( mbFixedMode )
 213             maGrid->ImplSetTextLineFix( nLine, *pString );
 214         else
 215             maGrid->ImplSetTextLineSep( nLine, *pString, rSepChars, cTextSep, bMergeSep );
 216     }
 217     EnableRepaint();
 218 }
 219
 220 // column settings ------------------------------------------------------------
 221
 222 void ScCsvTableBox::InitTypes( const ListBox& rListBox )
 223 {
 224     const sal_Int32 nTypeCount = rListBox.GetEntryCount();
 225     std::vector<OUString> aTypeNames( nTypeCount );
 226     for( sal_Int32 nIndex = 0; nIndex < nTypeCount; ++nIndex )
 227         aTypeNames[ nIndex ] = rListBox.GetEntry( nIndex );
 228     maGrid->SetTypeNames( aTypeNames );
 229 }
 230
 231 void ScCsvTableBox::FillColumnData( ScAsciiOptions& rOptions ) const
 232 {
 233     if( mbFixedMode )
 234         maGrid->FillColumnDataFix( rOptions );
 235     else
 236         maGrid->FillColumnDataSep( rOptions );
 237 }
 238
 239 // event handling -------------------------------------------------------------
 240
 241 void ScCsvTableBox::Resize()
 242 {
 243     ScCsvControl::Resize();
 244     InitControls();
 245 }
 246
 247 void ScCsvTableBox::DataChanged( const DataChangedEvent& rDCEvt )
 248 {
 249     if( (rDCEvt.GetType() == DataChangedEventType::SETTINGS) && (rDCEvt.GetFlags() & AllSettingsFlags::STYLE) )
 250         InitControls();
 251     ScCsvControl::DataChanged( rDCEvt );
 252 }
 253
 254 IMPL_LINK_TYPED( ScCsvTableBox, CsvCmdHdl, ScCsvControl&, rCtrl, void )
 255 {
 256     const ScCsvCmd& rCmd = rCtrl.GetCmd();
 257     ScCsvCmdType eType = rCmd.GetType();
 258     sal_Int32 nParam1 = rCmd.GetParam1();
 259     sal_Int32 nParam2 = rCmd.GetParam2();
 260
 261     bool bFound = true;
 262     switch( eType )
 263     {
 264         case CSVCMD_REPAINT:
 265             if( !IsNoRepaint() )
 266             {
 267                 maGrid->ImplRedraw();
 268                 maRuler->ImplRedraw();
 269                 InitHScrollBar();
 270                 InitVScrollBar();
 271             }
 272         break;
 273         case CSVCMD_MAKEPOSVISIBLE:
 274             MakePosVisible( nParam1 );
 275         break;
 276
 277         case CSVCMD_NEWCELLTEXTS:
 278             if( mbFixedMode )
 279                 Execute( CSVCMD_UPDATECELLTEXTS );
 280             else
 281             {
 282                 DisableRepaint();
 283                 ScCsvColStateVec aStates( maGrid->GetColumnStates() );
 284                 sal_Int32 nPos = GetFirstVisPos();
 285                 Execute( CSVCMD_SETPOSCOUNT, 1 );
 286                 Execute( CSVCMD_UPDATECELLTEXTS );
 287                 Execute( CSVCMD_SETPOSOFFSET, nPos );
 288                 maGrid->SetColumnStates( aStates );
 289                 EnableRepaint();
 290             }
 291         break;
 292         case CSVCMD_UPDATECELLTEXTS:
 293             maUpdateTextHdl.Call( *this );
 294         break;
 295         case CSVCMD_SETCOLUMNTYPE:
 296             maGrid->SetSelColumnType( nParam1 );
 297         break;
 298         case CSVCMD_EXPORTCOLUMNTYPE:
 299             maColTypeHdl.Call( *this );
 300         break;
 301         case CSVCMD_SETFIRSTIMPORTLINE:
 302             maGrid->SetFirstImportedLine( nParam1 );
 303         break;
 304
 305         case CSVCMD_INSERTSPLIT:
 306             OSL_ENSURE( mbFixedMode, "ScCsvTableBox::CsvCmdHdl::InsertSplit - invalid call" );
 307             if( maRuler->GetSplitCount() + 1 < sal::static_int_cast<sal_uInt32>(CSV_MAXCOLCOUNT) )
 308             {
 309                 maRuler->InsertSplit( nParam1 );
 310                 maGrid->InsertSplit( nParam1 );
 311             }
 312         break;
 313         case CSVCMD_REMOVESPLIT:
 314             OSL_ENSURE( mbFixedMode, "ScCsvTableBox::CsvCmdHdl::RemoveSplit - invalid call" );
 315             maRuler->RemoveSplit( nParam1 );
 316             maGrid->RemoveSplit( nParam1 );
 317         break;
 318         case CSVCMD_TOGGLESPLIT:
 319             Execute( maRuler->HasSplit( nParam1 ) ? CSVCMD_REMOVESPLIT : CSVCMD_INSERTSPLIT, nParam1 );
 320         break;
 321         case CSVCMD_MOVESPLIT:
 322             OSL_ENSURE( mbFixedMode, "ScCsvTableBox::CsvCmdHdl::MoveSplit - invalid call" );
 323             maRuler->MoveSplit( nParam1, nParam2 );
 324             maGrid->MoveSplit( nParam1, nParam2 );
 325         break;
 326         case CSVCMD_REMOVEALLSPLITS:
 327             OSL_ENSURE( mbFixedMode, "ScCsvTableBox::CsvCmdHdl::RemoveAllSplits - invalid call" );
 328             maRuler->RemoveAllSplits();
 329             maGrid->RemoveAllSplits();
 330         break;
 331         default:
 332             bFound = false;
 333     }
 334     if( bFound )
 335         return;
 336
 337     const ScCsvLayoutData aOldData( maData );
 338     switch( eType )
 339     {
 340         case CSVCMD_SETPOSCOUNT:
 341             maData.mnPosCount = std::max( nParam1, sal_Int32( 1 ) );
 342             ImplSetPosOffset( GetFirstVisPos() );
 343         break;
 344         case CSVCMD_SETPOSOFFSET:
 345             ImplSetPosOffset( nParam1 );
 346         break;
 347         case CSVCMD_SETHDRWIDTH:
 348             maData.mnHdrWidth = std::max( nParam1, sal_Int32( 0 ) );
 349             ImplSetPosOffset( GetFirstVisPos() );
 350         break;
 351         case CSVCMD_SETCHARWIDTH:
 352             maData.mnCharWidth = std::max( nParam1, sal_Int32( 1 ) );
 353             ImplSetPosOffset( GetFirstVisPos() );
 354         break;
 355         case CSVCMD_SETLINECOUNT:
 356             maData.mnLineCount = std::max( nParam1, sal_Int32( 1 ) );
 357             ImplSetLineOffset( GetFirstVisLine() );
 358         break;
 359         case CSVCMD_SETLINEOFFSET:
 360             ImplSetLineOffset( nParam1 );
 361         break;
 362         case CSVCMD_SETHDRHEIGHT:
 363             maData.mnHdrHeight = std::max( nParam1, sal_Int32( 0 ) );
 364             ImplSetLineOffset( GetFirstVisLine() );
 365         break;
 366         case CSVCMD_SETLINEHEIGHT:
 367             maData.mnLineHeight = std::max( nParam1, sal_Int32( 1 ) );
 368             ImplSetLineOffset( GetFirstVisLine() );
 369         break;
 370         case CSVCMD_MOVERULERCURSOR:
 371             maData.mnPosCursor = IsVisibleSplitPos( nParam1 ) ? nParam1 : CSV_POS_INVALID;
 372         break;
 373         case CSVCMD_MOVEGRIDCURSOR:
 374             maData.mnColCursor = ((0 <= nParam1) && (nParam1 < GetPosCount())) ? nParam1 : CSV_POS_INVALID;
 375         break;
 376         default:
 377         {
 378             // added to avoid warnings
 379         }
 380     }
 381
 382     if( maData != aOldData )
 383     {
 384         DisableRepaint();
 385         maRuler->ApplyLayout( aOldData );
 386         maGrid->ApplyLayout( aOldData );
 387         EnableRepaint();
 388     }
 389 }
 390
 391 IMPL_LINK_TYPED( ScCsvTableBox, ScrollHdl, ScrollBar*, pScrollBar, void )
 392 {
 393     OSL_ENSURE( pScrollBar, "ScCsvTableBox::ScrollHdl - missing sender" );
 394
 395     if( pScrollBar == maHScroll.get() )
 396         Execute( CSVCMD_SETPOSOFFSET, pScrollBar->GetThumbPos() );
 397     else if( pScrollBar == maVScroll.get() )
 398         Execute( CSVCMD_SETLINEOFFSET, pScrollBar->GetThumbPos() );
 399 }
 400
 401 IMPL_LINK_TYPED( ScCsvTableBox, ScrollEndHdl, ScrollBar*, pScrollBar, void )
 402 {
 403     OSL_ENSURE( pScrollBar, "ScCsvTableBox::ScrollEndHdl - missing sender" );
 404
 405     if( pScrollBar == maHScroll.get() )
 406     {
 407         if( GetRulerCursorPos() != CSV_POS_INVALID )
 408             Execute( CSVCMD_MOVERULERCURSOR, maRuler->GetNoScrollPos( GetRulerCursorPos() ) );
 409         if( GetGridCursorPos() != CSV_POS_INVALID )
 410             Execute( CSVCMD_MOVEGRIDCURSOR, maGrid->GetNoScrollCol( GetGridCursorPos() ) );
 411     }
 412 }
 413
 414 // accessibility --------------------------------------------------------------
 415
 416 css::uno::Reference< css::accessibility::XAccessible > ScCsvTableBox::CreateAccessible()
 417 {
 418     // do not use the ScCsvControl mechanism, return default accessible object
 419     return Control::CreateAccessible();
 420 }
 421
 422 rtl::Reference<ScAccessibleCsvControl> ScCsvTableBox::ImplCreateAccessible()
 423 {
 424     return rtl::Reference<ScAccessibleCsvControl>();    // not used, see CreateAccessible()
 425 }
 426
 427 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */