chart2/source/controller/dialogs/tp_RangeChooser.cxx

   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: tp_RangeChooser.cxx,v $
  10  * $Revision: 1.5.44.2 $
  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
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_chart2.hxx"
  33
  34 #include "tp_RangeChooser.hxx"
  35 #include "tp_RangeChooser.hrc"
  36 #include "Strings.hrc"
  37 #include "ResId.hxx"
  38 #include "macros.hxx"
  39 #include "NoWarningThisInCTOR.hxx"
  40 #include "DataSourceHelper.hxx"
  41 #include "DiagramHelper.hxx"
  42 #include "ChartTypeTemplateProvider.hxx"
  43 #include "DialogModel.hxx"
  44 #include "RangeSelectionHelper.hxx"
  45 #include <com/sun/star/awt/XTopWindow.hpp>
  46 #include <com/sun/star/embed/EmbedStates.hpp>
  47 #include <com/sun/star/embed/XComponentSupplier.hpp>
  48
  49 namespace
  50 {
  51 void lcl_ShowChooserButton(
  52     ::chart::RangeSelectionButton & rChooserButton,
  53     Edit & rEditField,
  54     BOOL bShow )
  55 {
  56     if( rChooserButton.IsVisible() != bShow )
  57     {
  58         rChooserButton.Show( bShow );
  59         sal_Int32 nWidhtDiff = 10 + 2;
  60         if( bShow )
  61             nWidhtDiff = -nWidhtDiff;
  62         Size aSize = rChooserButton.PixelToLogic( rEditField.GetSizePixel(), MAP_APPFONT );
  63         aSize.setWidth( aSize.getWidth() + nWidhtDiff );
  64         rEditField.SetSizePixel( rChooserButton.LogicToPixel( aSize, MAP_APPFONT ));
  65     }
  66 }
  67 void lcl_enableRangeChoosing( bool bEnable, Dialog * pDialog )
  68 {
  69     if( pDialog )
  70     {
  71         pDialog->Show( bEnable ? FALSE : TRUE );
  72         pDialog->SetModalInputMode( bEnable ? FALSE : TRUE );
  73     }
  74 }
  75 void lcl_shiftControlY( Control & rControl, long nYOffset )
  76 {
  77     Point aPos( rControl.GetPosPixel());
  78     aPos.setY( aPos.getY() + nYOffset );
  79     rControl.SetPosPixel( aPos );
  80 }
  81 } // anonymous namespace
  82
  83 //.............................................................................
  84 namespace chart
  85 {
  86 //.............................................................................
  87 using namespace ::com::sun::star;
  88 using namespace ::com::sun::star::chart2;
  89
  90 using ::com::sun::star::uno::Reference;
  91 using ::com::sun::star::uno::Sequence;
  92
  93
  94 RangeChooserTabPage::RangeChooserTabPage( Window* pParent
  95         , DialogModel & rDialogModel
  96         , ChartTypeTemplateProvider* pTemplateProvider
  97         , Dialog * pParentDialog
  98         , bool bHideDescription /* = false */ )
  99
 100         : OWizardPage( pParent, SchResId(TP_RANGECHOOSER) )
 101
 102         , m_aFT_Caption( this, SchResId( FT_CAPTION_FOR_WIZARD ) )
 103         , m_aFT_Range( this, SchResId( FT_RANGE ) )
 104         , m_aED_Range( this, SchResId( ED_RANGE ) )
 105         , m_aIB_Range( this, SchResId( IB_RANGE ) )
 106         , m_aRB_Rows( this, SchResId( RB_DATAROWS ) )
 107         , m_aRB_Columns( this, SchResId( RB_DATACOLS ) )
 108         , m_aCB_FirstRowAsLabel( this, SchResId( CB_FIRST_ROW_ASLABELS ) )
 109         , m_aCB_FirstColumnAsLabel( this, SchResId( CB_FIRST_COLUMN_ASLABELS ) )
 110         , m_nChangingControlCalls(0)
 111         , m_bIsDirty(false)
 112         , m_xDataProvider( 0 )
 113         , m_aLastValidRangeString()
 114         , m_xCurrentChartTypeTemplate(0)
 115         , m_pTemplateProvider(pTemplateProvider)
 116         , m_rDialogModel( rDialogModel )
 117         , m_pParentDialog( pParentDialog )
 118         , m_pTabPageNotifiable( dynamic_cast< TabPageNotifiable * >( pParentDialog ))
 119 {
 120     FreeResource();
 121
 122     if( bHideDescription )
 123     {
 124         // note: the offset should be a negative value for shifting upwards, the
 125         // 4 is for the offset difference between a wizard page and a tab-page
 126         long nYOffset = - ( m_aFT_Range.GetPosPixel().getY() - m_aFT_Caption.GetPosPixel().getY() + 4 );
 127         m_aFT_Caption.Hide();
 128
 129         // shift all controls by the offset space saved by hiding the caption
 130         lcl_shiftControlY( m_aFT_Range, nYOffset );
 131         lcl_shiftControlY( m_aED_Range, nYOffset );
 132         lcl_shiftControlY( m_aIB_Range, nYOffset );
 133         lcl_shiftControlY( m_aRB_Rows, nYOffset );
 134         lcl_shiftControlY( m_aRB_Columns, nYOffset );
 135         lcl_shiftControlY( m_aCB_FirstRowAsLabel, nYOffset );
 136         lcl_shiftControlY( m_aCB_FirstColumnAsLabel, nYOffset );
 137     }
 138     else
 139     {
 140         // make font of caption bold
 141         Font aFont( m_aFT_Caption.GetControlFont() );
 142         aFont.SetWeight( WEIGHT_BOLD );
 143         m_aFT_Caption.SetControlFont( aFont );
 144
 145         // no mnemonic
 146         m_aFT_Caption.SetStyle( m_aFT_Caption.GetStyle() | WB_NOLABEL );
 147     }
 148
 149     this->SetText( String(SchResId(STR_PAGE_DATA_RANGE)) );
 150     m_aIB_Range.SetQuickHelpText( String(SchResId(STR_TIP_SELECT_RANGE)) );
 151
 152     // set defaults as long as DetectArguments does not work
 153     m_aRB_Columns.Check();
 154     m_aCB_FirstColumnAsLabel.Check();
 155     m_aCB_FirstRowAsLabel.Check();
 156
 157     // BM: Note, that the range selection is not available, if there is no view.
 158     // This happens for charts having their own embedded spreadsheet.  If you
 159     // force to get the range selection here, this would mean when entering this
 160     // page the calc view would be created in this case.  So, I enable the
 161     // button here, and in the worst case nothing happens when it is pressed.
 162     // Not nice, but I see no better solution for the moment.
 163     m_aIB_Range.SetClickHdl( LINK( this, RangeChooserTabPage, ChooseRangeHdl ));
 164     m_aED_Range.SetKeyInputHdl( LINK( this, RangeChooserTabPage, ChooseRangeHdl ));
 165
 166     // #i75179# enable setting the background to a different color
 167     m_aED_Range.SetStyle( m_aED_Range.GetStyle() | WB_FORCECTRLBACKGROUND );
 168
 169     m_aED_Range.SetUpdateDataHdl( LINK( this, RangeChooserTabPage, ControlChangedHdl ));
 170     m_aED_Range.SetModifyHdl( LINK( this, RangeChooserTabPage, ControlEditedHdl ));
 171     m_aRB_Rows.SetToggleHdl( LINK( this, RangeChooserTabPage, ControlChangedHdl ) );
 172     m_aCB_FirstRowAsLabel.SetToggleHdl( LINK( this, RangeChooserTabPage, ControlChangedHdl ) );
 173     m_aCB_FirstColumnAsLabel.SetToggleHdl( LINK( this, RangeChooserTabPage, ControlChangedHdl ) );
 174 }
 175
 176 RangeChooserTabPage::~RangeChooserTabPage()
 177 {
 178 }
 179
 180 void RangeChooserTabPage::ActivatePage()
 181 {
 182     OWizardPage::ActivatePage();
 183     initControlsFromModel();
 184 }
 185
 186 void RangeChooserTabPage::initControlsFromModel()
 187 {
 188     m_nChangingControlCalls++;
 189
 190     if(m_pTemplateProvider)
 191     {
 192         m_xCurrentChartTypeTemplate = m_pTemplateProvider->getCurrentTemplate();
 193     }
 194
 195     bool bUseColumns = ! m_aRB_Rows.IsChecked();
 196     bool bFirstCellAsLabel = bUseColumns ? m_aCB_FirstRowAsLabel.IsChecked() : m_aCB_FirstColumnAsLabel.IsChecked();
 197     bool bHasCategories = bUseColumns ? m_aCB_FirstColumnAsLabel.IsChecked() : m_aCB_FirstRowAsLabel.IsChecked();
 198
 199     bool bIsValid = m_rDialogModel.allArgumentsForRectRangeDetected();
 200     if( bIsValid )
 201         m_rDialogModel.detectArguments(
 202             m_aLastValidRangeString, bUseColumns, bFirstCellAsLabel, bHasCategories );
 203     else
 204         m_aLastValidRangeString = String::EmptyString();
 205
 206     m_aED_Range.SetText( m_aLastValidRangeString );
 207
 208     m_aRB_Rows.Check( !bUseColumns );
 209     m_aRB_Columns.Check(  bUseColumns );
 210
 211     m_aCB_FirstRowAsLabel.Check( m_aRB_Rows.IsChecked()?bHasCategories:bFirstCellAsLabel  );
 212     m_aCB_FirstColumnAsLabel.Check( m_aRB_Columns.IsChecked()?bHasCategories:bFirstCellAsLabel  );
 213
 214     isValid();
 215
 216     m_nChangingControlCalls--;
 217 }
 218
 219 void RangeChooserTabPage::DeactivatePage()
 220 {
 221     commitPage();
 222     svt::OWizardPage::DeactivatePage();
 223 }
 224
 225 void RangeChooserTabPage::commitPage()
 226 {
 227     commitPage(eFinish);
 228 }
 229
 230 sal_Bool RangeChooserTabPage::commitPage( CommitPageReason /*eReason*/ )
 231 {
 232     //ranges may have been edited in the meanwhile (dirty is true in that case here)
 233     if( isValid() )
 234     {
 235         changeDialogModelAccordingToControls();
 236         return sal_True;//return false if this page should not be left
 237     }
 238     else
 239         return sal_False;
 240 }
 241
 242 void RangeChooserTabPage::changeDialogModelAccordingToControls()
 243 {
 244     if(m_nChangingControlCalls>0)
 245         return;
 246
 247     if( !m_xCurrentChartTypeTemplate.is() )
 248     {
 249         if(m_pTemplateProvider)
 250             m_xCurrentChartTypeTemplate.set( m_pTemplateProvider->getCurrentTemplate());
 251         if( !m_xCurrentChartTypeTemplate.is())
 252         {
 253             OSL_ENSURE( false, "Need a template to change data source" );
 254             return;
 255         }
 256     }
 257
 258     if( m_bIsDirty )
 259     {
 260         sal_Bool bFirstCellAsLabel = ( m_aCB_FirstColumnAsLabel.IsChecked() && !m_aRB_Columns.IsChecked() )
 261             || ( m_aCB_FirstRowAsLabel.IsChecked()    && !m_aRB_Rows.IsChecked() );
 262         sal_Bool bHasCategories = ( m_aCB_FirstColumnAsLabel.IsChecked() && m_aRB_Columns.IsChecked() )
 263             || ( m_aCB_FirstRowAsLabel.IsChecked()    && m_aRB_Rows.IsChecked() );
 264
 265         Sequence< beans::PropertyValue > aArguments(
 266             DataSourceHelper::createArguments(
 267                 m_aRB_Columns.IsChecked(), bFirstCellAsLabel, bHasCategories ) );
 268
 269         // only if range is valid
 270         if( m_aLastValidRangeString.equals( m_aED_Range.GetText()))
 271         {
 272             m_rDialogModel.setTemplate( m_xCurrentChartTypeTemplate );
 273             aArguments.realloc( aArguments.getLength() + 1 );
 274             aArguments[aArguments.getLength() - 1] =
 275                 beans::PropertyValue( C2U("CellRangeRepresentation"), -1,
 276                                       uno::makeAny( m_aLastValidRangeString ),
 277                                       beans::PropertyState_DIRECT_VALUE );
 278             m_rDialogModel.setData( aArguments );
 279             m_bIsDirty = false;
 280         }
 281
 282         //@todo warn user that the selected range is not valid
 283         //@todo better: disable OK-Button if range is invalid
 284     }
 285 }
 286
 287 bool RangeChooserTabPage::isValid()
 288 {
 289     ::rtl::OUString aRange( m_aED_Range.GetText());
 290     sal_Bool bFirstCellAsLabel = ( m_aCB_FirstColumnAsLabel.IsChecked() && !m_aRB_Columns.IsChecked() )
 291         || ( m_aCB_FirstRowAsLabel.IsChecked()    && !m_aRB_Rows.IsChecked() );
 292     sal_Bool bHasCategories = ( m_aCB_FirstColumnAsLabel.IsChecked() && m_aRB_Columns.IsChecked() )
 293         || ( m_aCB_FirstRowAsLabel.IsChecked()    && m_aRB_Rows.IsChecked() );
 294     bool bIsValid = ( aRange.getLength() == 0 ) ||
 295         m_rDialogModel.getRangeSelectionHelper()->verifyArguments(
 296             DataSourceHelper::createArguments(
 297                 aRange, Sequence< sal_Int32 >(), m_aRB_Columns.IsChecked(), bFirstCellAsLabel, bHasCategories ));
 298
 299     if( bIsValid )
 300     {
 301         m_aED_Range.SetControlForeground();
 302         m_aED_Range.SetControlBackground();
 303         if( m_pTabPageNotifiable )
 304             m_pTabPageNotifiable->setValidPage( this );
 305         m_aLastValidRangeString = aRange;
 306     }
 307     else
 308     {
 309         m_aED_Range.SetControlBackground( RANGE_SELECTION_INVALID_RANGE_BACKGROUND_COLOR );
 310         m_aED_Range.SetControlForeground( RANGE_SELECTION_INVALID_RANGE_FOREGROUND_COLOR );
 311         if( m_pTabPageNotifiable )
 312             m_pTabPageNotifiable->setInvalidPage( this );
 313     }
 314
 315     // enable/disable controls
 316     // #i79531# if the range is valid but an action of one of these buttons
 317     // would render it invalid, the button should be disabled
 318     if( bIsValid )
 319     {
 320         bool bDataInColumns = m_aRB_Columns.IsChecked();
 321         bool bIsSwappedRangeValid = m_rDialogModel.getRangeSelectionHelper()->verifyArguments(
 322             DataSourceHelper::createArguments(
 323                 aRange, Sequence< sal_Int32 >(), ! bDataInColumns, bHasCategories, bFirstCellAsLabel ));
 324         m_aRB_Rows.Enable( bIsSwappedRangeValid );
 325         m_aRB_Columns.Enable( bIsSwappedRangeValid );
 326
 327         m_aCB_FirstRowAsLabel.Enable(
 328             m_rDialogModel.getRangeSelectionHelper()->verifyArguments(
 329                 DataSourceHelper::createArguments(
 330                     aRange, Sequence< sal_Int32 >(), m_aRB_Columns.IsChecked(),
 331                     bDataInColumns ? ! bFirstCellAsLabel : bFirstCellAsLabel,
 332                     bDataInColumns ? bHasCategories : ! bHasCategories )));
 333         m_aCB_FirstColumnAsLabel.Enable(
 334             m_rDialogModel.getRangeSelectionHelper()->verifyArguments(
 335                 DataSourceHelper::createArguments(
 336                     aRange, Sequence< sal_Int32 >(), m_aRB_Columns.IsChecked(),
 337                     bDataInColumns ? bFirstCellAsLabel : ! bFirstCellAsLabel,
 338                     bDataInColumns ? ! bHasCategories : bHasCategories )));
 339     }
 340     else
 341     {
 342         m_aRB_Rows.Enable( bIsValid );
 343         m_aRB_Columns.Enable( bIsValid );
 344         m_aCB_FirstRowAsLabel.Enable( bIsValid );
 345         m_aCB_FirstColumnAsLabel.Enable( bIsValid );
 346 }
 347     BOOL bShowIB = m_rDialogModel.getRangeSelectionHelper()->hasRangeSelection();
 348     lcl_ShowChooserButton( m_aIB_Range, m_aED_Range, bShowIB );
 349
 350     return bIsValid;
 351 }
 352
 353 IMPL_LINK( RangeChooserTabPage, ControlEditedHdl, void*, EMPTYARG )
 354 {
 355     setDirty();
 356     isValid();
 357     return 0;
 358 }
 359
 360 IMPL_LINK( RangeChooserTabPage, ControlChangedHdl, void*, EMPTYARG )
 361 {
 362     setDirty();
 363     if( isValid())
 364         changeDialogModelAccordingToControls();
 365     return 0;
 366 }
 367
 368 IMPL_LINK( RangeChooserTabPage, ChooseRangeHdl, void *, EMPTYARG )
 369 {
 370     rtl::OUString aRange = m_aED_Range.GetText();
 371     // using assignment for broken gcc 3.3
 372     rtl::OUString aTitle = ::rtl::OUString( String( SchResId( STR_PAGE_DATA_RANGE ) ));
 373
 374     lcl_enableRangeChoosing( true, m_pParentDialog );
 375     m_rDialogModel.getRangeSelectionHelper()->chooseRange( aRange, aTitle, *this );
 376
 377     return 0;
 378 }
 379
 380
 381 void RangeChooserTabPage::listeningFinished( const ::rtl::OUString & rNewRange )
 382 {
 383     //user has selected a new range
 384
 385     rtl::OUString aRange( rNewRange );
 386
 387     m_rDialogModel.startControllerLockTimer();
 388
 389     // stop listening
 390     m_rDialogModel.getRangeSelectionHelper()->stopRangeListening();
 391
 392     //update dialog state
 393     ToTop();
 394     GrabFocus();
 395     m_aED_Range.SetText( String( aRange ) );
 396     m_aED_Range.GrabFocus();
 397
 398     setDirty();
 399     if( isValid())
 400         changeDialogModelAccordingToControls();
 401
 402     lcl_enableRangeChoosing( false, m_pParentDialog );
 403 }
 404 void RangeChooserTabPage::disposingRangeSelection()
 405 {
 406     m_rDialogModel.getRangeSelectionHelper()->stopRangeListening( false );
 407 }
 408
 409 void RangeChooserTabPage::setDirty()
 410 {
 411     if( m_nChangingControlCalls == 0 )
 412         m_bIsDirty = true;
 413 }
 414
 415 //.............................................................................
 416 } //namespace chart
 417 //.............................................................................