vcl/source/window/btndlg.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 <tools/rc.h>
  21
  22 #include <svdata.hxx>
  23
  24 #include <vcl/button.hxx>
  25 #include <vcl/btndlg.hxx>
  26
  27
  28 struct ImplBtnDlgItem
  29 {
  30     sal_uInt16              mnId;
  31     bool                    mbOwnButton;
  32     long                    mnSepSize;
  33     VclPtr<PushButton>      mpPushButton;
  34
  35     ImplBtnDlgItem() : mnId(0), mbOwnButton(false), mnSepSize(0) {}
  36 };
  37
  38 void ButtonDialog::ImplInitButtonDialogData()
  39 {
  40     mnButtonSize            = 0;
  41     mnCurButtonId           = 0;
  42     mnFocusButtonId         = BUTTONDIALOG_BUTTON_NOTFOUND;
  43     mbFormat                = true;
  44 }
  45
  46 ButtonDialog::ButtonDialog( WindowType nType ) :
  47     Dialog( nType )
  48 {
  49     ImplInitButtonDialogData();
  50 }
  51
  52 ButtonDialog::ButtonDialog( vcl::Window* pParent, WinBits nStyle ) :
  53     Dialog( WINDOW_BUTTONDIALOG )
  54 {
  55     ImplInitButtonDialogData();
  56     ImplInit( pParent, nStyle );
  57 }
  58
  59 ButtonDialog::~ButtonDialog()
  60 {
  61     disposeOnce();
  62 }
  63
  64 void ButtonDialog::dispose()
  65 {
  66     for (auto & it : m_ItemList)
  67     {
  68         if ( it->mbOwnButton )
  69             it->mpPushButton.disposeAndClear();
  70     }
  71     m_ItemList.clear();
  72     Dialog::dispose();
  73 }
  74
  75 VclPtr<PushButton> ButtonDialog::ImplCreatePushButton( ButtonDialogFlags nBtnFlags )
  76 {
  77     VclPtr<PushButton> pBtn;
  78     WinBits     nStyle = 0;
  79
  80     if ( nBtnFlags & ButtonDialogFlags::Default )
  81         nStyle |= WB_DEFBUTTON;
  82     if ( nBtnFlags & ButtonDialogFlags::Cancel )
  83         pBtn = VclPtr<CancelButton>::Create( this, nStyle );
  84     else if ( nBtnFlags & ButtonDialogFlags::OK )
  85         pBtn = VclPtr<OKButton>::Create( this, nStyle );
  86     else if ( nBtnFlags & ButtonDialogFlags::Help )
  87         pBtn = VclPtr<HelpButton>::Create( this, nStyle );
  88     else
  89         pBtn = VclPtr<PushButton>::Create( this, nStyle );
  90
  91     if ( !(nBtnFlags & ButtonDialogFlags::Help) )
  92         pBtn->SetClickHdl( LINK( this, ButtonDialog, ImplClickHdl ) );
  93
  94     return pBtn;
  95 }
  96
  97 ImplBtnDlgItem* ButtonDialog::ImplGetItem( sal_uInt16 nId ) const
  98 {
  99     for (auto & it : m_ItemList)
 100     {
 101         if (it->mnId == nId)
 102             return &(*it);
 103     }
 104
 105     return nullptr;
 106 }
 107
 108 long ButtonDialog::ImplGetButtonSize()
 109 {
 110     if ( !mbFormat )
 111         return mnButtonSize;
 112
 113     // Calculate ButtonSize
 114     long nLastSepSize = 0;
 115     long nSepSize = 0;
 116     maCtrlSize = Size( IMPL_MINSIZE_BUTTON_WIDTH, IMPL_MINSIZE_BUTTON_HEIGHT );
 117
 118     for (auto & it : m_ItemList)
 119     {
 120         nSepSize += nLastSepSize;
 121
 122         long nTxtWidth = it->mpPushButton->GetCtrlTextWidth(it->mpPushButton->GetText());
 123         nTxtWidth += IMPL_EXTRA_BUTTON_WIDTH;
 124
 125         if ( nTxtWidth > maCtrlSize.Width() )
 126             maCtrlSize.Width() = nTxtWidth;
 127
 128         long nTxtHeight = it->mpPushButton->GetTextHeight();
 129         nTxtHeight += IMPL_EXTRA_BUTTON_HEIGHT;
 130
 131         if ( nTxtHeight > maCtrlSize.Height() )
 132             maCtrlSize.Height() = nTxtHeight;
 133
 134         nSepSize += it->mnSepSize;
 135
 136         if ( GetStyle() & WB_HORZ )
 137             nLastSepSize = IMPL_SEP_BUTTON_X;
 138         else
 139             nLastSepSize = IMPL_SEP_BUTTON_Y;
 140     }
 141
 142     size_t const nButtonCount = m_ItemList.size();
 143
 144     if ( GetStyle() & WB_HORZ )
 145         mnButtonSize  = nSepSize + (nButtonCount*maCtrlSize.Width());
 146     else
 147         mnButtonSize = nSepSize + (nButtonCount*maCtrlSize.Height());
 148
 149     return mnButtonSize;
 150 }
 151
 152 void ButtonDialog::ImplPosControls()
 153 {
 154     if ( !mbFormat )
 155         return;
 156
 157     // Create PushButtons and determine Sizes
 158     ImplGetButtonSize();
 159
 160     // determine dialog size
 161     Size            aDlgSize = maPageSize;
 162     long            nX;
 163     long            nY;
 164     if ( GetStyle() & WB_HORZ )
 165     {
 166         if ( mnButtonSize+(IMPL_DIALOG_OFFSET*2) > aDlgSize.Width() )
 167             aDlgSize.Width() = mnButtonSize+(IMPL_DIALOG_OFFSET*2);
 168         if ( GetStyle() & WB_LEFT )
 169             nX = IMPL_DIALOG_OFFSET;
 170         else if ( GetStyle() & WB_RIGHT )
 171             nX = aDlgSize.Width()-mnButtonSize-IMPL_DIALOG_OFFSET;
 172         else
 173             nX = (aDlgSize.Width()-mnButtonSize)/2;
 174
 175         aDlgSize.Height() += IMPL_DIALOG_OFFSET+maCtrlSize.Height();
 176         nY = aDlgSize.Height()-maCtrlSize.Height()-IMPL_DIALOG_OFFSET;
 177     }
 178     else
 179     {
 180         if ( mnButtonSize+(IMPL_DIALOG_OFFSET*2) > aDlgSize.Height() )
 181             aDlgSize.Height() = mnButtonSize+(IMPL_DIALOG_OFFSET*2);
 182         if ( GetStyle() & WB_BOTTOM )
 183             nY = aDlgSize.Height()-mnButtonSize-IMPL_DIALOG_OFFSET;
 184         else if ( GetStyle() & WB_VCENTER )
 185             nY = (aDlgSize.Height()-mnButtonSize)/2;
 186         else
 187             nY = IMPL_DIALOG_OFFSET;
 188
 189         aDlgSize.Width() += IMPL_DIALOG_OFFSET+maCtrlSize.Width();
 190         nX = aDlgSize.Width()-maCtrlSize.Width()-IMPL_DIALOG_OFFSET;
 191     }
 192
 193     // Arrange PushButtons
 194     for (auto & it : m_ItemList)
 195     {
 196         if ( GetStyle() & WB_HORZ )
 197             nX += it->mnSepSize;
 198         else
 199             nY += it->mnSepSize;
 200
 201         it->mpPushButton->SetPosSizePixel( Point( nX, nY ), maCtrlSize );
 202         it->mpPushButton->Show();
 203
 204         if ( GetStyle() & WB_HORZ )
 205             nX += maCtrlSize.Width()+IMPL_SEP_BUTTON_X;
 206         else
 207             nY += maCtrlSize.Height()+IMPL_SEP_BUTTON_Y;
 208     }
 209
 210     SetOutputSizePixel(aDlgSize);
 211     SetMinOutputSizePixel(aDlgSize);
 212
 213     mbFormat = false;
 214 }
 215
 216 IMPL_LINK( ButtonDialog, ImplClickHdl, Button*, pBtn, void )
 217 {
 218     for (auto & it : m_ItemList)
 219     {
 220         if ( it->mpPushButton == pBtn )
 221         {
 222             mnCurButtonId = it->mnId;
 223             if ( IsInExecute() )
 224                 EndDialog( mnCurButtonId );
 225             break;
 226         }
 227     }
 228 }
 229
 230 void ButtonDialog::Resize()
 231 {
 232 }
 233
 234 void ButtonDialog::StateChanged( StateChangedType nType )
 235 {
 236     if ( nType == StateChangedType::InitShow )
 237     {
 238         ImplPosControls();
 239         for (auto & it : m_ItemList)
 240         {
 241             if ( it->mpPushButton && it->mbOwnButton )
 242                 it->mpPushButton->SetZOrder(nullptr, ZOrderFlags::Last);
 243         }
 244
 245         // Set focus on default button.
 246         if ( mnFocusButtonId != BUTTONDIALOG_BUTTON_NOTFOUND )
 247         {
 248             for (auto & it : m_ItemList)
 249             {
 250                 if (it->mnId == mnFocusButtonId )
 251                 {
 252                     if (it->mpPushButton->IsVisible())
 253                         it->mpPushButton->GrabFocus();
 254
 255                     break;
 256                 }
 257             }
 258         }
 259     }
 260
 261     Dialog::StateChanged( nType );
 262 }
 263
 264 void ButtonDialog::AddButton( const OUString& rText, sal_uInt16 nId,
 265                               ButtonDialogFlags nBtnFlags, long nSepPixel )
 266 {
 267     // PageItem anlegen
 268     std::unique_ptr<ImplBtnDlgItem> pItem(new ImplBtnDlgItem);
 269     pItem->mnId             = nId;
 270     pItem->mbOwnButton      = true;
 271     pItem->mnSepSize        = nSepPixel;
 272     pItem->mpPushButton     = ImplCreatePushButton( nBtnFlags );
 273
 274     if (!rText.isEmpty())
 275         pItem->mpPushButton->SetText( rText );
 276
 277     m_ItemList.push_back(std::move(pItem));
 278
 279     if ( nBtnFlags & ButtonDialogFlags::Focus )
 280         mnFocusButtonId = nId;
 281
 282     mbFormat = true;
 283 }
 284
 285 void ButtonDialog::AddButton( StandardButtonType eType, sal_uInt16 nId,
 286                               ButtonDialogFlags nBtnFlags, long nSepPixel )
 287 {
 288     // PageItem anlegen
 289     std::unique_ptr<ImplBtnDlgItem> pItem(new ImplBtnDlgItem);
 290     pItem->mnId             = nId;
 291     pItem->mbOwnButton      = true;
 292     pItem->mnSepSize        = nSepPixel;
 293
 294     if ( eType == StandardButtonType::OK )
 295         nBtnFlags |= ButtonDialogFlags::OK;
 296     else if ( eType == StandardButtonType::Help )
 297         nBtnFlags |= ButtonDialogFlags::Help;
 298     else if ( (eType == StandardButtonType::Cancel) || (eType == StandardButtonType::Close) )
 299         nBtnFlags |= ButtonDialogFlags::Cancel;
 300     pItem->mpPushButton = ImplCreatePushButton( nBtnFlags );
 301
 302     // Standard-Buttons have the right text already
 303     if ( !((eType == StandardButtonType::OK     && pItem->mpPushButton->GetType() == WINDOW_OKBUTTON) ||
 304            (eType == StandardButtonType::Cancel && pItem->mpPushButton->GetType() == WINDOW_CANCELBUTTON) ||
 305            (eType == StandardButtonType::Help   && pItem->mpPushButton->GetType() == WINDOW_HELPBUTTON)) )
 306     {
 307         pItem->mpPushButton->SetText( Button::GetStandardText( eType ) );
 308     }
 309
 310     if ( nBtnFlags & ButtonDialogFlags::Focus )
 311         mnFocusButtonId = nId;
 312
 313     m_ItemList.push_back(std::move(pItem));
 314
 315     mbFormat = true;
 316 }
 317
 318 void ButtonDialog::RemoveButton( sal_uInt16 nId )
 319 {
 320     for (std::vector<std::unique_ptr<ImplBtnDlgItem>>::iterator it
 321             = m_ItemList.begin(); it != m_ItemList.end(); ++it)
 322     {
 323         if ((*it)->mnId == nId)
 324         {
 325             (*it)->mpPushButton->Hide();
 326             if ((*it)->mbOwnButton)
 327                 (*it)->mpPushButton.disposeAndClear();
 328             else
 329                 (*it)->mpPushButton.clear();
 330             m_ItemList.erase(it);
 331             return;
 332         }
 333     }
 334
 335     SAL_WARN( "vcl.window", "ButtonDialog::RemoveButton(): ButtonId invalid" );
 336 }
 337
 338 void ButtonDialog::Clear()
 339 {
 340     for (auto & it : m_ItemList)
 341     {
 342         it->mpPushButton->Hide();
 343         if (it->mbOwnButton)
 344             it->mpPushButton.disposeAndClear();
 345     }
 346
 347     m_ItemList.clear();
 348     mbFormat = true;
 349 }
 350
 351 sal_uInt16 ButtonDialog::GetButtonId( sal_uInt16 nButton ) const
 352 {
 353     if ( nButton < m_ItemList.size() )
 354         return m_ItemList[nButton]->mnId;
 355     else
 356         return BUTTONDIALOG_BUTTON_NOTFOUND;
 357 }
 358
 359 PushButton* ButtonDialog::GetPushButton( sal_uInt16 nId ) const
 360 {
 361     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 362
 363     if ( pItem )
 364         return pItem->mpPushButton;
 365     else
 366         return nullptr;
 367 }
 368
 369 void ButtonDialog::SetButtonText( sal_uInt16 nId, const OUString& rText )
 370 {
 371     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 372
 373     if ( pItem )
 374     {
 375         pItem->mpPushButton->SetText( rText );
 376         mbFormat = true;
 377     }
 378 }
 379
 380 void ButtonDialog::SetButtonHelpText( sal_uInt16 nId, const OUString& rText )
 381 {
 382     ImplBtnDlgItem* pItem = ImplGetItem( nId );
 383
 384     if ( pItem )
 385         pItem->mpPushButton->SetHelpText( rText );
 386 }
 387
 388 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */