extensions/source/dbpilots/groupboxwiz.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 "groupboxwiz.hxx"
  21 #include "commonpagesdbp.hxx"
  22 #include <tools/debug.hxx>
  23 #include <vcl/svapp.hxx>
  24 #include "optiongrouplayouter.hxx"
  25 #include <helpids.h>
  26 #include <comphelper/processfactory.hxx>
  27 #include <osl/diagnose.h>
  28
  29 #define GBW_STATE_OPTIONLIST        0
  30 #define GBW_STATE_DEFAULTOPTION     1
  31 #define GBW_STATE_OPTIONVALUES      2
  32 #define GBW_STATE_DBFIELD           3
  33 #define GBW_STATE_FINALIZE          4
  34
  35 namespace dbp
  36 {
  37     using namespace ::com::sun::star::uno;
  38     using namespace ::com::sun::star::lang;
  39     using namespace ::com::sun::star::beans;
  40     using namespace ::com::sun::star::form;
  41
  42     OGroupBoxWizard::OGroupBoxWizard(weld::Window* _pParent,
  43             const Reference< XPropertySet >& _rxObjectModel, const Reference< XComponentContext >& _rxContext )
  44         : OControlWizard(_pParent, _rxObjectModel, _rxContext)
  45         , m_bVisitedDefault(false)
  46         , m_bVisitedDB(false)
  47     {
  48         initControlSettings(&m_aSettings);
  49
  50         m_xPrevPage->set_help_id(HID_GROUPWIZARD_PREVIOUS);
  51         m_xNextPage->set_help_id(HID_GROUPWIZARD_NEXT);
  52         m_xCancel->set_help_id(HID_GROUPWIZARD_CANCEL);
  53         m_xFinish->set_help_id(HID_GROUPWIZARD_FINISH);
  54         setTitleBase(compmodule::ModuleRes(RID_STR_GROUPWIZARD_TITLE));
  55     }
  56
  57     bool OGroupBoxWizard::approveControl(sal_Int16 _nClassId)
  58     {
  59         return FormComponentType::GROUPBOX == _nClassId;
  60     }
  61
  62     std::unique_ptr<BuilderPage> OGroupBoxWizard::createPage(::vcl::WizardTypes::WizardState _nState)
  63     {
  64         OString sIdent(OString::number(_nState));
  65         weld::Container* pPageContainer = m_xAssistant->append_page(sIdent);
  66
  67         switch (_nState)
  68         {
  69             case GBW_STATE_OPTIONLIST:
  70                 return std::make_unique<ORadioSelectionPage>(pPageContainer, this);
  71
  72             case GBW_STATE_DEFAULTOPTION:
  73                 return std::make_unique<ODefaultFieldSelectionPage>(pPageContainer, this);
  74
  75             case GBW_STATE_OPTIONVALUES:
  76                 return std::make_unique<OOptionValuesPage>(pPageContainer, this);
  77
  78             case GBW_STATE_DBFIELD:
  79                 return std::make_unique<OOptionDBFieldPage>(pPageContainer, this);
  80
  81             case GBW_STATE_FINALIZE:
  82                 return std::make_unique<OFinalizeGBWPage>(pPageContainer, this);
  83         }
  84
  85         return nullptr;
  86     }
  87
  88     vcl::WizardTypes::WizardState OGroupBoxWizard::determineNextState( ::vcl::WizardTypes::WizardState _nCurrentState ) const
  89     {
  90         switch (_nCurrentState)
  91         {
  92             case GBW_STATE_OPTIONLIST:
  93                 return GBW_STATE_DEFAULTOPTION;
  94
  95             case GBW_STATE_DEFAULTOPTION:
  96                 return GBW_STATE_OPTIONVALUES;
  97
  98             case GBW_STATE_OPTIONVALUES:
  99                 if (getContext().aFieldNames.hasElements())
 100                     return GBW_STATE_DBFIELD;
 101                 else
 102                     return GBW_STATE_FINALIZE;
 103
 104             case GBW_STATE_DBFIELD:
 105                 return GBW_STATE_FINALIZE;
 106         }
 107
 108         return WZS_INVALID_STATE;
 109     }
 110
 111     void OGroupBoxWizard::enterState(::vcl::WizardTypes::WizardState _nState)
 112     {
 113         // some stuff to do before calling the base class (modifying our settings)
 114         switch (_nState)
 115         {
 116             case GBW_STATE_DEFAULTOPTION:
 117                 if (!m_bVisitedDefault)
 118                 {   // assume that the first of the radio buttons should be selected
 119                     DBG_ASSERT(m_aSettings.aLabels.size(), "OGroupBoxWizard::enterState: should never have reached this state!");
 120                     m_aSettings.sDefaultField = m_aSettings.aLabels[0];
 121                 }
 122                 m_bVisitedDefault = true;
 123                 break;
 124
 125             case GBW_STATE_DBFIELD:
 126                 if (!m_bVisitedDB)
 127                 {   // try to generate a default for the DB field
 128                     // (simply use the first field in the DB names collection)
 129                     if (getContext().aFieldNames.hasElements())
 130                         m_aSettings.sDBField = getContext().aFieldNames[0];
 131                 }
 132                 m_bVisitedDB = true;
 133                 break;
 134         }
 135
 136         // setting the def button... to be done before the base class is called, too, 'cause the base class
 137         // calls the pages, which are allowed to override our def button behaviour
 138         defaultButton(GBW_STATE_FINALIZE == _nState ? WizardButtonFlags::FINISH : WizardButtonFlags::NEXT);
 139
 140         // allow "finish" on the last page only
 141         enableButtons(WizardButtonFlags::FINISH, GBW_STATE_FINALIZE == _nState);
 142         // allow previous on all pages but the first one
 143         enableButtons(WizardButtonFlags::PREVIOUS, GBW_STATE_OPTIONLIST != _nState);
 144         // allow next on all pages but the last one
 145         enableButtons(WizardButtonFlags::NEXT, GBW_STATE_FINALIZE != _nState);
 146
 147         OControlWizard::enterState(_nState);
 148     }
 149
 150     bool OGroupBoxWizard::onFinish()
 151     {
 152         // commit the basic control settings
 153         commitControlSettings(&m_aSettings);
 154
 155         // create the radio buttons
 156         try
 157         {
 158             OOptionGroupLayouter aLayouter( getComponentContext() );
 159             aLayouter.doLayout(getContext(), getSettings());
 160         }
 161         catch(const Exception&)
 162         {
 163             OSL_FAIL("OGroupBoxWizard::createRadios: caught an exception while creating the radio shapes!");
 164         }
 165
 166         return OControlWizard::onFinish();
 167     }
 168
 169     ORadioSelectionPage::ORadioSelectionPage(weld::Container* pPage, OControlWizard* pWizard)
 170         : OGBWPage(pPage, pWizard, "modules/sabpilot/ui/groupradioselectionpage.ui", "GroupRadioSelectionPage")
 171         , m_xRadioName(m_xBuilder->weld_entry("radiolabels"))
 172         , m_xMoveRight(m_xBuilder->weld_button("toright"))
 173         , m_xMoveLeft(m_xBuilder->weld_button("toleft"))
 174         , m_xExistingRadios(m_xBuilder->weld_tree_view("radiobuttons"))
 175     {
 176         if (getContext().aFieldNames.hasElements())
 177         {
 178             enableFormDatasourceDisplay();
 179         }
 180
 181         m_xMoveLeft->connect_clicked(LINK(this, ORadioSelectionPage, OnMoveEntry));
 182         m_xMoveRight->connect_clicked(LINK(this, ORadioSelectionPage, OnMoveEntry));
 183         m_xRadioName->connect_changed(LINK(this, ORadioSelectionPage, OnNameModified));
 184         m_xExistingRadios->connect_changed(LINK(this, ORadioSelectionPage, OnEntrySelected));
 185
 186         implCheckMoveButtons();
 187         m_xExistingRadios->set_selection_mode(SelectionMode::Multiple);
 188
 189         getDialog()->defaultButton(m_xMoveRight.get());
 190     }
 191
 192     ORadioSelectionPage::~ORadioSelectionPage()
 193     {
 194     }
 195
 196     void ORadioSelectionPage::Activate()
 197     {
 198         OGBWPage::Activate();
 199         m_xRadioName->grab_focus();
 200     }
 201
 202     void ORadioSelectionPage::initializePage()
 203     {
 204         OGBWPage::initializePage();
 205
 206         m_xRadioName->set_text("");
 207
 208         // no need to initialize the list of radios here
 209         // (we're the only one affecting this special setting, so it will be in the same state as last time this
 210         // page was committed)
 211
 212         implCheckMoveButtons();
 213     }
 214
 215     bool ORadioSelectionPage::commitPage( ::vcl::WizardTypes::CommitPageReason _eReason )
 216     {
 217         if (!OGBWPage::commitPage(_eReason))
 218             return false;
 219
 220         // copy the names of the radio buttons to be inserted
 221         // and initialize the values
 222         OOptionGroupSettings& rSettings = getSettings();
 223         rSettings.aLabels.clear();
 224         rSettings.aValues.clear();
 225         rSettings.aLabels.reserve(m_xExistingRadios->n_children());
 226         rSettings.aValues.reserve(m_xExistingRadios->n_children());
 227         for (sal_Int32 i=0; i<m_xExistingRadios->n_children(); ++i)
 228         {
 229             rSettings.aLabels.push_back(m_xExistingRadios->get_text(i));
 230             rSettings.aValues.push_back(OUString::number((i + 1)));
 231         }
 232
 233         return true;
 234     }
 235
 236     IMPL_LINK( ORadioSelectionPage, OnMoveEntry, weld::Button&, rButton, void )
 237     {
 238         bool bMoveLeft = (m_xMoveLeft.get() == &rButton);
 239         if (bMoveLeft)
 240         {
 241             while (m_xExistingRadios->count_selected_rows())
 242                 m_xExistingRadios->remove(m_xExistingRadios->get_selected_index());
 243         }
 244         else
 245         {
 246             m_xExistingRadios->append_text(m_xRadioName->get_text());
 247             m_xRadioName->set_text("");
 248         }
 249
 250         implCheckMoveButtons();
 251
 252         //adjust the focus
 253         if (bMoveLeft)
 254             m_xExistingRadios->grab_focus();
 255         else
 256             m_xRadioName->grab_focus();
 257     }
 258
 259     IMPL_LINK_NOARG( ORadioSelectionPage, OnEntrySelected, weld::TreeView&, void )
 260     {
 261         implCheckMoveButtons();
 262     }
 263
 264     IMPL_LINK_NOARG( ORadioSelectionPage, OnNameModified, weld::Entry&, void )
 265     {
 266         implCheckMoveButtons();
 267     }
 268
 269     bool ORadioSelectionPage::canAdvance() const
 270     {
 271         return 0 != m_xExistingRadios->n_children();
 272     }
 273
 274     void ORadioSelectionPage::implCheckMoveButtons()
 275     {
 276         bool bHaveSome = (0 != m_xExistingRadios->n_children());
 277         bool bSelectedSome = (0 != m_xExistingRadios->count_selected_rows());
 278         bool bUnfinishedInput = !m_xRadioName->get_text().isEmpty();
 279
 280         m_xMoveLeft->set_sensitive(bSelectedSome);
 281         m_xMoveRight->set_sensitive(bUnfinishedInput);
 282
 283         getDialog()->enableButtons(WizardButtonFlags::NEXT, bHaveSome);
 284
 285         if (bUnfinishedInput)
 286         {
 287             if (!m_xMoveRight->get_has_default())
 288                 getDialog()->defaultButton(m_xMoveRight.get());
 289         }
 290         else
 291         {
 292             if (m_xMoveRight->get_has_default())
 293                 getDialog()->defaultButton(WizardButtonFlags::NEXT);
 294         }
 295     }
 296
 297     ODefaultFieldSelectionPage::ODefaultFieldSelectionPage(weld::Container* pPage, OControlWizard* pWizard)
 298         : OMaybeListSelectionPage(pPage, pWizard, "modules/sabpilot/ui/defaultfieldselectionpage.ui", "DefaultFieldSelectionPage")
 299         , m_xDefSelYes(m_xBuilder->weld_radio_button("defaultselectionyes"))
 300         , m_xDefSelNo(m_xBuilder->weld_radio_button("defaultselectionno"))
 301         , m_xDefSelection(m_xBuilder->weld_combo_box("defselectionfield"))
 302     {
 303         announceControls(*m_xDefSelYes, *m_xDefSelNo, *m_xDefSelection);
 304     }
 305
 306     ODefaultFieldSelectionPage::~ODefaultFieldSelectionPage()
 307     {
 308     }
 309
 310     void ODefaultFieldSelectionPage::initializePage()
 311     {
 312         OMaybeListSelectionPage::initializePage();
 313
 314         const OOptionGroupSettings& rSettings = getSettings();
 315
 316         // fill the listbox
 317         m_xDefSelection->clear();
 318         for (auto const& label : rSettings.aLabels)
 319             m_xDefSelection->append_text(label);
 320
 321         implInitialize(rSettings.sDefaultField);
 322     }
 323
 324     bool ODefaultFieldSelectionPage::commitPage( ::vcl::WizardTypes::CommitPageReason _eReason )
 325     {
 326         if (!OMaybeListSelectionPage::commitPage(_eReason))
 327             return false;
 328
 329         OOptionGroupSettings& rSettings = getSettings();
 330         implCommit(rSettings.sDefaultField);
 331
 332         return true;
 333     }
 334
 335     OOptionValuesPage::OOptionValuesPage(weld::Container* pPage, OControlWizard* pWizard)
 336         : OGBWPage(pPage, pWizard, "modules/sabpilot/ui/optionvaluespage.ui", "OptionValuesPage")
 337         , m_xValue(m_xBuilder->weld_entry("optionvalue"))
 338         , m_xOptions(m_xBuilder->weld_tree_view("radiobuttons"))
 339         , m_nLastSelection(::vcl::WizardTypes::WizardState(-1))
 340     {
 341        m_xOptions->connect_changed(LINK(this, OOptionValuesPage, OnOptionSelected));
 342     }
 343
 344     OOptionValuesPage::~OOptionValuesPage()
 345     {
 346     }
 347
 348     IMPL_LINK_NOARG( OOptionValuesPage, OnOptionSelected, weld::TreeView&, void )
 349     {
 350         implTraveledOptions();
 351     }
 352
 353     void OOptionValuesPage::Activate()
 354     {
 355         OGBWPage::Activate();
 356         m_xValue->grab_focus();
 357     }
 358
 359     void OOptionValuesPage::implTraveledOptions()
 360     {
 361         if (::vcl::WizardTypes::WizardState(-1) != m_nLastSelection)
 362         {
 363             // save the value for the last option
 364             DBG_ASSERT(static_cast<size_t>(m_nLastSelection) < m_aUncommittedValues.size(), "OOptionValuesPage::implTraveledOptions: invalid previous selection index!");
 365             m_aUncommittedValues[m_nLastSelection] = m_xValue->get_text();
 366         }
 367
 368         m_nLastSelection = m_xOptions->get_selected_index();
 369         DBG_ASSERT(static_cast<size_t>(m_nLastSelection) < m_aUncommittedValues.size(), "OOptionValuesPage::implTraveledOptions: invalid new selection index!");
 370         m_xValue->set_text(m_aUncommittedValues[m_nLastSelection]);
 371     }
 372
 373     void OOptionValuesPage::initializePage()
 374     {
 375         OGBWPage::initializePage();
 376
 377         const OOptionGroupSettings& rSettings = getSettings();
 378         DBG_ASSERT(rSettings.aLabels.size(), "OOptionValuesPage::initializePage: no options!!");
 379         DBG_ASSERT(rSettings.aLabels.size() == rSettings.aValues.size(), "OOptionValuesPage::initializePage: inconsistent data!");
 380
 381         // fill the list with all available options
 382         m_xOptions->clear();
 383         m_nLastSelection = -1;
 384         for (auto const& label : rSettings.aLabels)
 385             m_xOptions->append_text(label);
 386
 387         // remember the values ... can't set them directly in the settings without the explicit commit call
 388         // so we need have a copy of the values
 389         m_aUncommittedValues = rSettings.aValues;
 390
 391         // select the first entry
 392         m_xOptions->select(0);
 393         implTraveledOptions();
 394     }
 395
 396     bool OOptionValuesPage::commitPage( ::vcl::WizardTypes::CommitPageReason _eReason )
 397     {
 398         if (!OGBWPage::commitPage(_eReason))
 399             return false;
 400
 401         OOptionGroupSettings& rSettings = getSettings();
 402
 403         // commit the current value
 404         implTraveledOptions();
 405         // copy the uncommitted values
 406         rSettings.aValues = m_aUncommittedValues;
 407
 408         return true;
 409     }
 410
 411     OOptionDBFieldPage::OOptionDBFieldPage(weld::Container* pPage, OControlWizard* pWizard)
 412         : ODBFieldPage(pPage, pWizard)
 413     {
 414         setDescriptionText(compmodule::ModuleRes(RID_STR_GROUPWIZ_DBFIELD));
 415     }
 416
 417     OUString& OOptionDBFieldPage::getDBFieldSetting()
 418     {
 419         return static_cast<OGroupBoxWizard*>(getDialog())->getSettings().sDBField;
 420     }
 421
 422     OFinalizeGBWPage::OFinalizeGBWPage(weld::Container* pPage, OControlWizard* pWizard)
 423         : OGBWPage(pPage, pWizard, "modules/sabpilot/ui/optionsfinalpage.ui", "OptionsFinalPage")
 424         , m_xName(m_xBuilder->weld_entry("nameit"))
 425     {
 426     }
 427
 428     OFinalizeGBWPage::~OFinalizeGBWPage()
 429     {
 430     }
 431
 432     void OFinalizeGBWPage::Activate()
 433     {
 434         OGBWPage::Activate();
 435         m_xName->grab_focus();
 436     }
 437
 438     bool OFinalizeGBWPage::canAdvance() const
 439     {
 440         return false;
 441     }
 442
 443     void OFinalizeGBWPage::initializePage()
 444     {
 445         OGBWPage::initializePage();
 446
 447         const OOptionGroupSettings& rSettings = getSettings();
 448         m_xName->set_text(rSettings.sControlLabel);
 449     }
 450
 451     bool OFinalizeGBWPage::commitPage( ::vcl::WizardTypes::CommitPageReason _eReason )
 452     {
 453         if (!OGBWPage::commitPage(_eReason))
 454             return false;
 455
 456         getSettings().sControlLabel = m_xName->get_text();
 457
 458         return true;
 459     }
 460
 461 }   // namespace dbp
 462
 463
 464 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */