Coverage Report

Created: 2025-11-16 09:57

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libreoffice/chart2/source/controller/dialogs/tp_RangeChooser.cxx
Line
Count
Source
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 "tp_RangeChooser.hxx"
21
#include <DataSourceHelper.hxx>
22
#include <ChartTypeTemplateProvider.hxx>
23
#include <ChartTypeTemplate.hxx>
24
#include "DialogModel.hxx"
25
#include <RangeSelectionHelper.hxx>
26
#include <TabPageNotifiable.hxx>
27
#include <com/sun/star/beans/PropertyState.hpp>
28
#include <com/sun/star/beans/PropertyValue.hpp>
29
#include <officecfg/Office/Common.hxx>
30
#include <osl/diagnose.h>
31
32
namespace
33
{
34
    void lcl_ShowChooserButton(
35
        weld::Button& rChooserButton,
36
        bool bShow)
37
0
    {
38
0
        if( rChooserButton.get_visible() != bShow )
39
0
        {
40
0
            rChooserButton.set_visible( bShow );
41
0
        }
42
0
    }
43
44
} // anonymous namespace
45
46
namespace chart
47
{
48
using namespace ::com::sun::star;
49
using namespace ::com::sun::star::chart2;
50
51
using ::com::sun::star::uno::Sequence;
52
53
RangeChooserTabPage::RangeChooserTabPage(weld::Container* pPage, weld::DialogController* pController, DialogModel & rDialogModel,
54
                                         ChartTypeTemplateProvider* pTemplateProvider,
55
                                         bool bHideDescription /* = false */)
56
0
    : OWizardPage(pPage, pController, u"modules/schart/ui/tp_RangeChooser.ui"_ustr, u"tp_RangeChooser"_ustr)
57
0
    , m_nChangingControlCalls(0)
58
0
    , m_bIsDirty(false)
59
0
    , m_pTemplateProvider(pTemplateProvider)
60
0
    , m_rDialogModel( rDialogModel )
61
0
    , m_pTabPageNotifiable(dynamic_cast<TabPageNotifiable*>(pController))
62
0
    , m_xFT_Caption(m_xBuilder->weld_label(u"FT_CAPTION_FOR_WIZARD"_ustr))
63
0
    , m_xED_Range(m_xBuilder->weld_entry(u"ED_RANGE"_ustr))
64
0
    , m_xIB_Range(m_xBuilder->weld_button(u"IB_RANGE"_ustr))
65
0
    , m_xRB_Rows(m_xBuilder->weld_radio_button(u"RB_DATAROWS"_ustr))
66
0
    , m_xRB_Columns(m_xBuilder->weld_radio_button(u"RB_DATACOLS"_ustr))
67
0
    , m_xCB_FirstRowAsLabel(m_xBuilder->weld_check_button(u"CB_FIRST_ROW_ASLABELS"_ustr))
68
0
    , m_xCB_FirstColumnAsLabel(m_xBuilder->weld_check_button(u"CB_FIRST_COLUMN_ASLABELS"_ustr))
69
0
    , m_xFTTitle(m_xBuilder->weld_label(u"STR_PAGE_DATA_RANGE"_ustr))
70
0
    , m_xFL_TimeBased(m_xBuilder->weld_widget(u"separator1"_ustr))
71
0
    , m_xCB_TimeBased(m_xBuilder->weld_check_button(u"CB_TIME_BASED"_ustr))
72
0
    , m_xFT_TimeStart(m_xBuilder->weld_label(u"label1"_ustr))
73
0
    , m_xEd_TimeStart(m_xBuilder->weld_entry(u"ED_TIME_BASED_START"_ustr))
74
0
    , m_xFT_TimeEnd(m_xBuilder->weld_label(u"label2"_ustr))
75
0
    , m_xEd_TimeEnd(m_xBuilder->weld_entry(u"ED_TIME_BASED_END"_ustr))
76
0
{
77
0
    m_xFT_Caption->set_visible(!bHideDescription);
78
79
0
    SetPageTitle(m_xFTTitle->get_label());// OH:remove later with dialog
80
81
    // set defaults as long as DetectArguments does not work
82
0
    m_xRB_Columns->set_active(true);
83
0
    m_xCB_FirstColumnAsLabel->set_active(true);
84
0
    m_xCB_FirstRowAsLabel->set_active(true);
85
86
    // BM: Note, that the range selection is not available, if there is no view.
87
    // This happens for charts having their own embedded spreadsheet.  If you
88
    // force to get the range selection here, this would mean when entering this
89
    // page the calc view would be created in this case.  So, I enable the
90
    // button here, and in the worst case nothing happens when it is pressed.
91
    // Not nice, but I see no better solution for the moment.
92
0
    m_xIB_Range->connect_clicked( LINK( this, RangeChooserTabPage, ChooseRangeHdl ));
93
94
0
    m_xED_Range->connect_changed( LINK( this, RangeChooserTabPage, ControlEditedHdl ));
95
0
    m_xRB_Rows->connect_toggled( LINK( this, RangeChooserTabPage, ControlChangedRadioHdl ) );
96
0
    m_xCB_FirstRowAsLabel->connect_toggled( LINK( this, RangeChooserTabPage, ControlChangedCheckBoxHdl ) );
97
0
    m_xCB_FirstColumnAsLabel->connect_toggled( LINK( this, RangeChooserTabPage, ControlChangedCheckBoxHdl ) );
98
0
    m_xCB_TimeBased->connect_toggled( LINK( this, RangeChooserTabPage, ControlChangedCheckBoxHdl ) );
99
0
    m_xEd_TimeStart->connect_changed( LINK( this, RangeChooserTabPage, ControlChangedHdl ) );
100
0
    m_xEd_TimeEnd->connect_changed( LINK( this, RangeChooserTabPage, ControlChangedHdl ) );
101
102
0
    if ( !officecfg::Office::Common::Misc::ExperimentalMode::get() )
103
0
    {
104
0
        m_xFL_TimeBased->hide();
105
0
        m_xCB_TimeBased->hide();
106
0
        m_xFT_TimeStart->hide();
107
0
        m_xEd_TimeStart->hide();
108
0
        m_xFT_TimeEnd->hide();
109
0
        m_xEd_TimeEnd->hide();
110
0
    }
111
0
}
112
113
RangeChooserTabPage::~RangeChooserTabPage()
114
0
{
115
0
}
116
117
void RangeChooserTabPage::Activate()
118
0
{
119
0
    OWizardPage::Activate();
120
0
    initControlsFromModel();
121
0
    m_xED_Range->grab_focus();
122
0
}
123
124
void RangeChooserTabPage::initControlsFromModel()
125
0
{
126
0
    m_nChangingControlCalls++;
127
128
0
    if(m_pTemplateProvider)
129
0
        m_xCurrentChartTypeTemplate = m_pTemplateProvider->getCurrentTemplate();
130
131
0
    bool bUseColumns = !m_xRB_Rows->get_active();
132
0
    bool bFirstCellAsLabel = bUseColumns ? m_xCB_FirstRowAsLabel->get_active() : m_xCB_FirstColumnAsLabel->get_active();
133
0
    bool bHasCategories = bUseColumns ? m_xCB_FirstColumnAsLabel->get_active() : m_xCB_FirstRowAsLabel->get_active();
134
135
0
    bool bIsValid = m_rDialogModel.allArgumentsForRectRangeDetected();
136
0
    if( bIsValid )
137
0
        m_rDialogModel.detectArguments(m_aLastValidRangeString, bUseColumns, bFirstCellAsLabel, bHasCategories );
138
0
    else
139
0
        m_aLastValidRangeString.clear();
140
141
0
    m_xED_Range->set_text( m_aLastValidRangeString );
142
143
0
    m_xRB_Rows->set_active( !bUseColumns );
144
0
    m_xRB_Columns->set_active(  bUseColumns );
145
146
0
    m_xCB_FirstRowAsLabel->set_active( m_xRB_Rows->get_active()?bHasCategories:bFirstCellAsLabel  );
147
0
    m_xCB_FirstColumnAsLabel->set_active( m_xRB_Columns->get_active()?bHasCategories:bFirstCellAsLabel  );
148
149
0
    isValid();
150
151
0
    m_nChangingControlCalls--;
152
0
}
153
154
void RangeChooserTabPage::Deactivate()
155
0
{
156
0
    commitPage();
157
0
    vcl::OWizardPage::Deactivate();
158
0
}
159
160
void RangeChooserTabPage::commitPage()
161
0
{
162
0
    commitPage(::vcl::WizardTypes::eFinish);
163
0
}
164
165
bool RangeChooserTabPage::commitPage( ::vcl::WizardTypes::CommitPageReason /*eReason*/ )
166
0
{
167
    //ranges may have been edited in the meanwhile (dirty is true in that case here)
168
0
    if( isValid() )
169
0
    {
170
0
        changeDialogModelAccordingToControls();
171
0
        return true; // return false if this page should not be left
172
0
    }
173
0
    else
174
0
        return false;
175
0
}
176
177
void RangeChooserTabPage::changeDialogModelAccordingToControls()
178
0
{
179
0
    if(m_nChangingControlCalls>0)
180
0
        return;
181
182
0
    if( !m_xCurrentChartTypeTemplate.is() )
183
0
    {
184
0
        if(m_pTemplateProvider)
185
0
            m_xCurrentChartTypeTemplate = m_pTemplateProvider->getCurrentTemplate();
186
0
        if( !m_xCurrentChartTypeTemplate.is())
187
0
        {
188
0
            OSL_FAIL( "Need a template to change data source" );
189
0
            return;
190
0
        }
191
0
    }
192
193
0
    if( !m_bIsDirty )
194
0
        return;
195
196
0
    bool bFirstCellAsLabel = ( m_xCB_FirstColumnAsLabel->get_active() && !m_xRB_Columns->get_active() )
197
0
        || ( m_xCB_FirstRowAsLabel->get_active()    && !m_xRB_Rows->get_active() );
198
0
    bool bHasCategories = ( m_xCB_FirstColumnAsLabel->get_active() && m_xRB_Columns->get_active() )
199
0
        || ( m_xCB_FirstRowAsLabel->get_active()    && m_xRB_Rows->get_active() );
200
0
    bool bTimeBased = m_xCB_TimeBased->get_active();
201
202
0
    Sequence< beans::PropertyValue > aArguments(
203
0
        DataSourceHelper::createArguments(
204
0
            m_xRB_Columns->get_active(), bFirstCellAsLabel, bHasCategories ) );
205
206
0
    if(bTimeBased)
207
0
    {
208
0
        aArguments.realloc( aArguments.getLength() + 1 );
209
0
        aArguments.getArray()[aArguments.getLength() - 1] =
210
0
            beans::PropertyValue( u"TimeBased"_ustr, -1, uno::Any(bTimeBased),
211
0
                    beans::PropertyState_DIRECT_VALUE );
212
0
    }
213
214
    // only if range is valid
215
0
    if( m_aLastValidRangeString != m_xED_Range->get_text())
216
0
        return;
217
218
0
    m_rDialogModel.setTemplate( m_xCurrentChartTypeTemplate );
219
0
    aArguments.realloc( aArguments.getLength() + 1 );
220
0
    aArguments.getArray()[aArguments.getLength() - 1] =
221
0
        beans::PropertyValue( u"CellRangeRepresentation"_ustr , -1,
222
0
                              uno::Any( m_aLastValidRangeString ),
223
0
                              beans::PropertyState_DIRECT_VALUE );
224
0
    m_rDialogModel.setData( aArguments );
225
0
    m_bIsDirty = false;
226
227
0
    if(bTimeBased)
228
0
    {
229
0
        sal_Int32 nStart = m_xEd_TimeStart->get_text().toInt32();
230
0
        sal_Int32 nEnd = m_xEd_TimeEnd->get_text().toInt32();
231
0
        m_rDialogModel.setTimeBasedRange(true, nStart, nEnd);
232
0
    }
233
234
    //@todo warn user that the selected range is not valid
235
    //@todo better: disable OK-Button if range is invalid
236
0
}
237
238
bool RangeChooserTabPage::isValid()
239
0
{
240
0
    OUString aRange( m_xED_Range->get_text());
241
0
    bool bFirstCellAsLabel = ( m_xCB_FirstColumnAsLabel->get_active() && !m_xRB_Columns->get_active() )
242
0
        || ( m_xCB_FirstRowAsLabel->get_active()    && !m_xRB_Rows->get_active() );
243
0
    bool bHasCategories = ( m_xCB_FirstColumnAsLabel->get_active() && m_xRB_Columns->get_active() )
244
0
        || ( m_xCB_FirstRowAsLabel->get_active()    && m_xRB_Rows->get_active() );
245
0
    bool bIsValid = ( aRange.isEmpty() ) ||
246
0
        m_rDialogModel.getRangeSelectionHelper()->verifyArguments(
247
0
            DataSourceHelper::createArguments(
248
0
                aRange, Sequence< sal_Int32 >(), m_xRB_Columns->get_active(), bFirstCellAsLabel, bHasCategories ));
249
250
0
    if( bIsValid )
251
0
    {
252
0
        m_xED_Range->set_message_type(weld::EntryMessageType::Normal);
253
0
        if( m_pTabPageNotifiable )
254
0
            m_pTabPageNotifiable->setValidPage( this );
255
0
        m_aLastValidRangeString = aRange;
256
0
    }
257
0
    else
258
0
    {
259
0
        m_xED_Range->set_message_type(weld::EntryMessageType::Error);
260
0
        if( m_pTabPageNotifiable )
261
0
            m_pTabPageNotifiable->setInvalidPage( this );
262
0
    }
263
264
    // enable/disable controls
265
    // #i79531# if the range is valid but an action of one of these buttons
266
    // would render it invalid, the button should be disabled
267
0
    if( bIsValid )
268
0
    {
269
0
        bool bDataInColumns = m_xRB_Columns->get_active();
270
0
        bool bIsSwappedRangeValid = m_rDialogModel.getRangeSelectionHelper()->verifyArguments(
271
0
            DataSourceHelper::createArguments(
272
0
                aRange, Sequence< sal_Int32 >(), ! bDataInColumns, bHasCategories, bFirstCellAsLabel ));
273
0
        m_xRB_Rows->set_sensitive( bIsSwappedRangeValid );
274
0
        m_xRB_Columns->set_sensitive( bIsSwappedRangeValid );
275
276
0
        m_xCB_FirstRowAsLabel->set_sensitive(
277
0
            m_rDialogModel.getRangeSelectionHelper()->verifyArguments(
278
0
                DataSourceHelper::createArguments(
279
0
                    aRange, Sequence< sal_Int32 >(), m_xRB_Columns->get_active(),
280
0
                    bDataInColumns ? ! bFirstCellAsLabel : bFirstCellAsLabel,
281
0
                    bDataInColumns ? bHasCategories : ! bHasCategories )));
282
0
        m_xCB_FirstColumnAsLabel->set_sensitive(
283
0
            m_rDialogModel.getRangeSelectionHelper()->verifyArguments(
284
0
                DataSourceHelper::createArguments(
285
0
                    aRange, Sequence< sal_Int32 >(), m_xRB_Columns->get_active(),
286
0
                    bDataInColumns ? bFirstCellAsLabel : ! bFirstCellAsLabel,
287
0
                    bDataInColumns ? ! bHasCategories : bHasCategories )));
288
0
    }
289
0
    else
290
0
    {
291
0
        m_xRB_Rows->set_sensitive( bIsValid );
292
0
        m_xRB_Columns->set_sensitive( bIsValid );
293
0
        m_xCB_FirstRowAsLabel->set_sensitive( bIsValid );
294
0
        m_xCB_FirstColumnAsLabel->set_sensitive( bIsValid );
295
0
    }
296
297
0
    bool bShowIB = m_rDialogModel.getRangeSelectionHelper()->hasRangeSelection();
298
0
    lcl_ShowChooserButton( *m_xIB_Range, bShowIB );
299
300
0
    return bIsValid;
301
0
}
302
303
IMPL_LINK_NOARG(RangeChooserTabPage, ControlEditedHdl, weld::Entry&, void)
304
0
{
305
0
    setDirty();
306
0
    isValid();
307
0
}
308
309
IMPL_LINK_NOARG(RangeChooserTabPage, ControlChangedRadioHdl, weld::Toggleable&, void)
310
0
{
311
0
    ControlChangedHdl(*m_xED_Range);
312
0
}
313
314
IMPL_LINK_NOARG(RangeChooserTabPage, ControlChangedCheckBoxHdl, weld::Toggleable&, void)
315
0
{
316
0
    ControlChangedHdl(*m_xED_Range);
317
0
}
318
319
IMPL_LINK_NOARG(RangeChooserTabPage, ControlChangedHdl, weld::Entry&, void)
320
0
{
321
0
    setDirty();
322
0
    if( isValid())
323
0
        changeDialogModelAccordingToControls();
324
0
}
325
326
IMPL_LINK_NOARG(RangeChooserTabPage, ChooseRangeHdl, weld::Button&, void)
327
0
{
328
0
    OUString aRange = m_xED_Range->get_text();
329
0
    OUString aTitle = m_xFTTitle->get_label();
330
331
0
    enableRangeChoosing(true, m_pDialogController);
332
0
    m_rDialogModel.getRangeSelectionHelper()->chooseRange( aRange, aTitle, *this );
333
0
}
334
335
void RangeChooserTabPage::listeningFinished( const OUString & rNewRange )
336
0
{
337
    //user has selected a new range
338
339
    // rNewRange becomes invalid after removing the listener
340
0
    OUString aRange( rNewRange );
341
342
0
    m_rDialogModel.startControllerLockTimer();
343
344
    // stop listening
345
0
    m_rDialogModel.getRangeSelectionHelper()->stopRangeListening();
346
347
    //update dialog state
348
0
    m_xED_Range->set_text(aRange);
349
0
    m_xED_Range->grab_focus();
350
351
0
    setDirty();
352
0
    if( isValid())
353
0
        changeDialogModelAccordingToControls();
354
355
0
    enableRangeChoosing(false, m_pDialogController);
356
0
}
357
358
void RangeChooserTabPage::disposingRangeSelection()
359
0
{
360
0
    m_rDialogModel.getRangeSelectionHelper()->stopRangeListening( false );
361
0
}
362
363
void RangeChooserTabPage::setDirty()
364
0
{
365
0
    if( m_nChangingControlCalls == 0 )
366
0
        m_bIsDirty = true;
367
0
}
368
369
} //namespace chart
370
371
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */