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
  36 namespace dbp
  37 {
  38
  39
  40     using namespace ::com::sun::star::uno;
  41     using namespace ::com::sun::star::lang;
  42     using namespace ::com::sun::star::beans;
  43     using namespace ::com::sun::star::form;
  44     using namespace ::svt;
  45
  46     OGroupBoxWizard::OGroupBoxWizard( vcl::Window* _pParent,
  47             const Reference< XPropertySet >& _rxObjectModel, const Reference< XComponentContext >& _rxContext )
  48         :OControlWizard(_pParent, _rxObjectModel, _rxContext)
  49         ,m_bVisitedDefault(false)
  50         ,m_bVisitedDB(false)
  51     {
  52         initControlSettings(&m_aSettings);
  53
  54         m_pPrevPage->SetHelpId(HID_GROUPWIZARD_PREVIOUS);
  55         m_pNextPage->SetHelpId(HID_GROUPWIZARD_NEXT);
  56         m_pCancel->SetHelpId(HID_GROUPWIZARD_CANCEL);
  57         m_pFinish->SetHelpId(HID_GROUPWIZARD_FINISH);
  58         setTitleBase(compmodule::ModuleRes(RID_STR_GROUPWIZARD_TITLE));
  59     }
  60
  61
  62     bool OGroupBoxWizard::approveControl(sal_Int16 _nClassId)
  63     {
  64         return FormComponentType::GROUPBOX == _nClassId;
  65     }
  66
  67
  68     VclPtr<TabPage> OGroupBoxWizard::createPage(::svt::WizardTypes::WizardState _nState)
  69     {
  70         switch (_nState)
  71         {
  72             case GBW_STATE_OPTIONLIST:
  73                 return VclPtr<ORadioSelectionPage>::Create(this);
  74
  75             case GBW_STATE_DEFAULTOPTION:
  76                 return VclPtr<ODefaultFieldSelectionPage>::Create(this);
  77
  78             case GBW_STATE_OPTIONVALUES:
  79                 return VclPtr<OOptionValuesPage>::Create(this);
  80
  81             case GBW_STATE_DBFIELD:
  82                 return VclPtr<OOptionDBFieldPage>::Create(this);
  83
  84             case GBW_STATE_FINALIZE:
  85                 return VclPtr<OFinalizeGBWPage>::Create(this);
  86         }
  87
  88         return nullptr;
  89     }
  90
  91
  92     WizardTypes::WizardState OGroupBoxWizard::determineNextState( ::svt::WizardTypes::WizardState _nCurrentState ) const
  93     {
  94         switch (_nCurrentState)
  95         {
  96             case GBW_STATE_OPTIONLIST:
  97                 return GBW_STATE_DEFAULTOPTION;
  98
  99             case GBW_STATE_DEFAULTOPTION:
 100                 return GBW_STATE_OPTIONVALUES;
 101
 102             case GBW_STATE_OPTIONVALUES:
 103                 if (getContext().aFieldNames.hasElements())
 104                     return GBW_STATE_DBFIELD;
 105                 else
 106                     return GBW_STATE_FINALIZE;
 107
 108             case GBW_STATE_DBFIELD:
 109                 return GBW_STATE_FINALIZE;
 110         }
 111
 112         return WZS_INVALID_STATE;
 113     }
 114
 115
 116     void OGroupBoxWizard::enterState(::svt::WizardTypes::WizardState _nState)
 117     {
 118         // some stuff to do before calling the base class (modifying our settings)
 119         switch (_nState)
 120         {
 121             case GBW_STATE_DEFAULTOPTION:
 122                 if (!m_bVisitedDefault)
 123                 {   // assume that the first of the radio buttons should be selected
 124                     DBG_ASSERT(m_aSettings.aLabels.size(), "OGroupBoxWizard::enterState: should never have reached this state!");
 125                     m_aSettings.sDefaultField = m_aSettings.aLabels[0];
 126                 }
 127                 m_bVisitedDefault = true;
 128                 break;
 129
 130             case GBW_STATE_DBFIELD:
 131                 if (!m_bVisitedDB)
 132                 {   // try to generate a default for the DB field
 133                     // (simply use the first field in the DB names collection)
 134                     if (getContext().aFieldNames.hasElements())
 135                         m_aSettings.sDBField = getContext().aFieldNames[0];
 136                 }
 137                 m_bVisitedDB = true;
 138                 break;
 139         }
 140
 141         // setting the def button .... to be done before the base class is called, too, 'cause the base class
 142         // calls the pages, which are allowed to override our def button behaviour
 143         defaultButton(GBW_STATE_FINALIZE == _nState ? WizardButtonFlags::FINISH : WizardButtonFlags::NEXT);
 144
 145         // allow "finish" on the last page only
 146         enableButtons(WizardButtonFlags::FINISH, GBW_STATE_FINALIZE == _nState);
 147         // allow previous on all pages but the first one
 148         enableButtons(WizardButtonFlags::PREVIOUS, GBW_STATE_OPTIONLIST != _nState);
 149         // allow next on all pages but the last one
 150         enableButtons(WizardButtonFlags::NEXT, GBW_STATE_FINALIZE != _nState);
 151
 152         OControlWizard::enterState(_nState);
 153     }
 154
 155
 156     bool OGroupBoxWizard::onFinish()
 157     {
 158         // commit the basic control settings
 159         commitControlSettings(&m_aSettings);
 160
 161         // create the radio buttons
 162         try
 163         {
 164             OOptionGroupLayouter aLayouter( getComponentContext() );
 165             aLayouter.doLayout(getContext(), getSettings());
 166         }
 167         catch(const Exception&)
 168         {
 169             OSL_FAIL("OGroupBoxWizard::createRadios: caught an exception while creating the radio shapes!");
 170         }
 171
 172         return OControlWizard::onFinish();
 173     }
 174
 175     ORadioSelectionPage::ORadioSelectionPage( OControlWizard* _pParent )
 176         :OGBWPage(_pParent, "GroupRadioSelectionPage", "modules/sabpilot/ui/groupradioselectionpage.ui")
 177     {
 178         get(m_pRadioName, "radiolabels");
 179         get(m_pMoveRight, "toright");
 180         get(m_pMoveLeft, "toleft");
 181         get(m_pExistingRadios, "radiobuttons");
 182
 183         if (getContext().aFieldNames.hasElements())
 184         {
 185             enableFormDatasourceDisplay();
 186         }
 187
 188         m_pMoveLeft->SetClickHdl(LINK(this, ORadioSelectionPage, OnMoveEntry));
 189         m_pMoveRight->SetClickHdl(LINK(this, ORadioSelectionPage, OnMoveEntry));
 190         m_pRadioName->SetModifyHdl(LINK(this, ORadioSelectionPage, OnNameModified));
 191         m_pExistingRadios->SetSelectHdl(LINK(this, ORadioSelectionPage, OnEntrySelected));
 192
 193         implCheckMoveButtons();
 194         m_pExistingRadios->EnableMultiSelection(true);
 195
 196         getDialog()->defaultButton(m_pMoveRight.get());
 197     }
 198
 199     ORadioSelectionPage::~ORadioSelectionPage()
 200     {
 201         disposeOnce();
 202     }
 203
 204     void ORadioSelectionPage::dispose()
 205     {
 206         m_pRadioName.clear();
 207         m_pMoveRight.clear();
 208         m_pMoveLeft.clear();
 209         m_pExistingRadios.clear();
 210         OGBWPage::dispose();
 211     }
 212
 213     void ORadioSelectionPage::ActivatePage()
 214     {
 215         OGBWPage::ActivatePage();
 216         m_pRadioName->GrabFocus();
 217     }
 218
 219
 220     void ORadioSelectionPage::initializePage()
 221     {
 222         OGBWPage::initializePage();
 223
 224         m_pRadioName->SetText("");
 225
 226         // no need to initialize the list of radios here
 227         // (we're the only one affecting this special setting, so it will be in the same state as last time this
 228         // page was committed)
 229
 230         implCheckMoveButtons();
 231     }
 232
 233
 234     bool ORadioSelectionPage::commitPage( ::svt::WizardTypes::CommitPageReason _eReason )
 235     {
 236         if (!OGBWPage::commitPage(_eReason))
 237             return false;
 238
 239         // copy the names of the radio buttons to be inserted
 240         // and initialize the values
 241         OOptionGroupSettings& rSettings = getSettings();
 242         rSettings.aLabels.clear();
 243         rSettings.aValues.clear();
 244         rSettings.aLabels.reserve(m_pExistingRadios->GetEntryCount());
 245         rSettings.aValues.reserve(m_pExistingRadios->GetEntryCount());
 246         for (sal_Int32 i=0; i<m_pExistingRadios->GetEntryCount(); ++i)
 247         {
 248             rSettings.aLabels.push_back(m_pExistingRadios->GetEntry(i));
 249             rSettings.aValues.push_back(OUString::number((i + 1)));
 250         }
 251
 252         return true;
 253     }
 254
 255
 256     IMPL_LINK( ORadioSelectionPage, OnMoveEntry, Button*, _pButton, void )
 257     {
 258         bool bMoveLeft = (m_pMoveLeft == _pButton);
 259         if (bMoveLeft)
 260         {
 261             while (m_pExistingRadios->GetSelectedEntryCount())
 262                 m_pExistingRadios->RemoveEntry(m_pExistingRadios->GetSelectedEntryPos());
 263         }
 264         else
 265         {
 266             m_pExistingRadios->InsertEntry(m_pRadioName->GetText());
 267             m_pRadioName->SetText("");
 268         }
 269
 270         implCheckMoveButtons();
 271
 272         //adjust the focus
 273         if (bMoveLeft)
 274             m_pExistingRadios->GrabFocus();
 275         else
 276             m_pRadioName->GrabFocus();
 277     }
 278
 279
 280     IMPL_LINK_NOARG( ORadioSelectionPage, OnEntrySelected, ListBox&, void )
 281     {
 282         implCheckMoveButtons();
 283     }
 284
 285
 286     IMPL_LINK_NOARG( ORadioSelectionPage, OnNameModified, Edit&, void )
 287     {
 288         implCheckMoveButtons();
 289     }
 290
 291
 292     bool ORadioSelectionPage::canAdvance() const
 293     {
 294         return 0 != m_pExistingRadios->GetEntryCount();
 295     }
 296
 297
 298     void ORadioSelectionPage::implCheckMoveButtons()
 299     {
 300         bool bHaveSome = (0 != m_pExistingRadios->GetEntryCount());
 301         bool bSelectedSome = (0 != m_pExistingRadios->GetSelectedEntryCount());
 302         bool bUnfinishedInput = !m_pRadioName->GetText().isEmpty();
 303
 304         m_pMoveLeft->Enable(bSelectedSome);
 305         m_pMoveRight->Enable(bUnfinishedInput);
 306
 307         getDialog()->enableButtons(WizardButtonFlags::NEXT, bHaveSome);
 308
 309         if (bUnfinishedInput)
 310         {
 311             if (0 == (m_pMoveRight->GetStyle() & WB_DEFBUTTON))
 312                 getDialog()->defaultButton(m_pMoveRight.get());
 313         }
 314         else
 315         {
 316             if (WB_DEFBUTTON == (m_pMoveRight->GetStyle() & WB_DEFBUTTON))
 317                 getDialog()->defaultButton(WizardButtonFlags::NEXT);
 318         }
 319     }
 320
 321     ODefaultFieldSelectionPage::ODefaultFieldSelectionPage( OControlWizard* _pParent )
 322         :OMaybeListSelectionPage(_pParent, "DefaultFieldSelectionPage", "modules/sabpilot/ui/defaultfieldselectionpage.ui")
 323     {
 324         get(m_pDefSelYes, "defaultselectionyes");
 325         get(m_pDefSelNo, "defaultselectionno");
 326         get(m_pDefSelection, "defselectionfield");
 327
 328         announceControls(*m_pDefSelYes, *m_pDefSelNo, *m_pDefSelection);
 329         m_pDefSelection->SetDropDownLineCount(10);
 330         m_pDefSelection->SetStyle(WB_DROPDOWN);
 331     }
 332
 333     ODefaultFieldSelectionPage::~ODefaultFieldSelectionPage()
 334     {
 335         disposeOnce();
 336     }
 337
 338     void ODefaultFieldSelectionPage::dispose()
 339     {
 340         m_pDefSelYes.clear();
 341         m_pDefSelNo.clear();
 342         m_pDefSelection.clear();
 343         OMaybeListSelectionPage::dispose();
 344     }
 345
 346     void ODefaultFieldSelectionPage::initializePage()
 347     {
 348         OMaybeListSelectionPage::initializePage();
 349
 350         const OOptionGroupSettings& rSettings = getSettings();
 351
 352         // fill the listbox
 353         m_pDefSelection->Clear();
 354         for (auto const& label : rSettings.aLabels)
 355             m_pDefSelection->InsertEntry(label);
 356
 357
 358         implInitialize(rSettings.sDefaultField);
 359     }
 360
 361
 362     bool ODefaultFieldSelectionPage::commitPage( ::svt::WizardTypes::CommitPageReason _eReason )
 363     {
 364         if (!OMaybeListSelectionPage::commitPage(_eReason))
 365             return false;
 366
 367         OOptionGroupSettings& rSettings = getSettings();
 368         implCommit(rSettings.sDefaultField);
 369
 370         return true;
 371     }
 372
 373     OOptionValuesPage::OOptionValuesPage( OControlWizard* _pParent )
 374         :OGBWPage(_pParent, "OptionValuesPage", "modules/sabpilot/ui/optionvaluespage.ui")
 375         ,m_nLastSelection(::svt::WizardTypes::WizardState(-1))
 376     {
 377         get(m_pValue, "optionvalue");
 378         get(m_pOptions, "radiobuttons");
 379
 380         m_pOptions->SetSelectHdl(LINK(this, OOptionValuesPage, OnOptionSelected));
 381     }
 382
 383     OOptionValuesPage::~OOptionValuesPage()
 384     {
 385         disposeOnce();
 386     }
 387
 388     void OOptionValuesPage::dispose()
 389     {
 390         m_pValue.clear();
 391         m_pOptions.clear();
 392         OGBWPage::dispose();
 393     }
 394
 395     IMPL_LINK_NOARG( OOptionValuesPage, OnOptionSelected, ListBox&, void )
 396     {
 397         implTraveledOptions();
 398     }
 399
 400
 401     void OOptionValuesPage::ActivatePage()
 402     {
 403         OGBWPage::ActivatePage();
 404         m_pValue->GrabFocus();
 405     }
 406
 407
 408     void OOptionValuesPage::implTraveledOptions()
 409     {
 410         if (::svt::WizardTypes::WizardState(-1) != m_nLastSelection)
 411         {
 412             // save the value for the last option
 413             DBG_ASSERT(static_cast<size_t>(m_nLastSelection) < m_aUncommittedValues.size(), "OOptionValuesPage::implTraveledOptions: invalid previous selection index!");
 414             m_aUncommittedValues[m_nLastSelection] = m_pValue->GetText();
 415         }
 416
 417         m_nLastSelection = m_pOptions->GetSelectedEntryPos();
 418         DBG_ASSERT(static_cast<size_t>(m_nLastSelection) < m_aUncommittedValues.size(), "OOptionValuesPage::implTraveledOptions: invalid new selection index!");
 419         m_pValue->SetText(m_aUncommittedValues[m_nLastSelection]);
 420     }
 421
 422
 423     void OOptionValuesPage::initializePage()
 424     {
 425         OGBWPage::initializePage();
 426
 427         const OOptionGroupSettings& rSettings = getSettings();
 428         DBG_ASSERT(rSettings.aLabels.size(), "OOptionValuesPage::initializePage: no options!!");
 429         DBG_ASSERT(rSettings.aLabels.size() == rSettings.aValues.size(), "OOptionValuesPage::initializePage: inconsistent data!");
 430
 431         // fill the list with all available options
 432         m_pOptions->Clear();
 433         m_nLastSelection = -1;
 434         for (auto const& label : rSettings.aLabels)
 435             m_pOptions->InsertEntry(label);
 436
 437         // remember the values ... can't set them directly in the settings without the explicit commit call
 438         // so we need have a copy of the values
 439         m_aUncommittedValues = rSettings.aValues;
 440
 441         // select the first entry
 442         m_pOptions->SelectEntryPos(0);
 443         implTraveledOptions();
 444     }
 445
 446
 447     bool OOptionValuesPage::commitPage( ::svt::WizardTypes::CommitPageReason _eReason )
 448     {
 449         if (!OGBWPage::commitPage(_eReason))
 450             return false;
 451
 452         OOptionGroupSettings& rSettings = getSettings();
 453
 454         // commit the current value
 455         implTraveledOptions();
 456         // copy the uncommitted values
 457         rSettings.aValues = m_aUncommittedValues;
 458
 459         return true;
 460     }
 461
 462     OOptionDBFieldPage::OOptionDBFieldPage( OControlWizard* _pParent )
 463         :ODBFieldPage(_pParent)
 464     {
 465         setDescriptionText(compmodule::ModuleRes(RID_STR_GROUPWIZ_DBFIELD));
 466     }
 467
 468
 469     OUString& OOptionDBFieldPage::getDBFieldSetting()
 470     {
 471         return static_cast<OGroupBoxWizard*>(getDialog())->getSettings().sDBField;
 472     }
 473
 474     OFinalizeGBWPage::OFinalizeGBWPage( OControlWizard* _pParent )
 475         :OGBWPage(_pParent, "OptionsFinalPage", "modules/sabpilot/ui/optionsfinalpage.ui")
 476     {
 477         get(m_pName, "nameit");
 478     }
 479
 480     OFinalizeGBWPage::~OFinalizeGBWPage()
 481     {
 482         disposeOnce();
 483     }
 484
 485     void OFinalizeGBWPage::dispose()
 486     {
 487         m_pName.clear();
 488         OGBWPage::dispose();
 489     }
 490
 491     void OFinalizeGBWPage::ActivatePage()
 492     {
 493         OGBWPage::ActivatePage();
 494         m_pName->GrabFocus();
 495     }
 496
 497
 498     bool OFinalizeGBWPage::canAdvance() const
 499     {
 500         return false;
 501     }
 502
 503
 504     void OFinalizeGBWPage::initializePage()
 505     {
 506         OGBWPage::initializePage();
 507
 508         const OOptionGroupSettings& rSettings = getSettings();
 509         m_pName->SetText(rSettings.sControlLabel);
 510     }
 511
 512
 513     bool OFinalizeGBWPage::commitPage( ::svt::WizardTypes::CommitPageReason _eReason )
 514     {
 515         if (!OGBWPage::commitPage(_eReason))
 516             return false;
 517
 518         getSettings().sControlLabel = m_pName->GetText();
 519
 520         return true;
 521     }
 522
 523
 524 }   // namespace dbp
 525
 526
 527 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */