sd/source/ui/toolpanel/TitledControl.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: TitledControl.cxx,v $
  10  * $Revision: 1.14 $
  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_sd.hxx"
  33
  34 #include "taskpane/TitledControl.hxx"
  35
  36 #include "AccessibleTreeNode.hxx"
  37 #include "taskpane/ControlContainer.hxx"
  38 #include "TaskPaneFocusManager.hxx"
  39 #include "taskpane/TaskPaneControlFactory.hxx"
  40 #include <vcl/ctrl.hxx>
  41 #include <vcl/svapp.hxx>
  42
  43
  44 namespace sd { namespace toolpanel {
  45
  46
  47 TitledControl::TitledControl (
  48     TreeNode* pParent,
  49     ::std::auto_ptr<TreeNode> pControl,
  50     const String& rTitle,
  51     const ClickHandler& rClickHandler,
  52     TitleBar::TitleBarType eType)
  53     : ::Window (pParent->GetWindow(), WB_TABSTOP),
  54       TreeNode(pParent),
  55       msTitle(rTitle),
  56       mbVisible(true),
  57       mpUserData(NULL),
  58       mpControlFactory(NULL),
  59       mpClickHandler(new ClickHandler(rClickHandler)),
  60       mbExpansionModeIsToggle(eType!=TitleBar::TBT_CONTROL_TITLE)
  61 {
  62     if (pControl.get() != NULL)
  63     {
  64         mpControlContainer->AddControl (::std::auto_ptr<TreeNode> (
  65             new TitleBar (this, rTitle, eType, pControl->IsExpandable())));
  66         pControl->SetParentNode (this);
  67     }
  68     mpControlContainer->AddControl (pControl);
  69
  70     FocusManager::Instance().RegisterDownLink(this, GetControl()->GetWindow());
  71     FocusManager::Instance().RegisterUpLink(GetControl()->GetWindow(), this);
  72
  73     SetBackground (Wallpaper());
  74
  75     GetTitleBar()->GetWindow()->Show ();
  76     GetTitleBar()->GetWindow()->AddEventListener (
  77         LINK(this,TitledControl,WindowEventListener));
  78
  79     UpdateStates ();
  80 }
  81
  82
  83
  84
  85 TitledControl::TitledControl (
  86     TreeNode* pParent,
  87     ::std::auto_ptr<ControlFactory> pControlFactory,
  88     const String& rTitle,
  89     const ClickHandler& rClickHandler,
  90     TitleBar::TitleBarType eType)
  91     : ::Window (pParent->GetWindow(), WB_TABSTOP),
  92       TreeNode(pParent),
  93       msTitle (rTitle),
  94       mbVisible (true),
  95       mpUserData (NULL),
  96       mpControlFactory(pControlFactory),
  97       mpClickHandler(new ClickHandler(rClickHandler)),
  98       mbExpansionModeIsToggle(eType!=TitleBar::TBT_CONTROL_TITLE)
  99 {
 100     mpControlContainer->AddControl (::std::auto_ptr<TreeNode> (
 101         new TitleBar (this, rTitle, eType, true)));
 102
 103     // The second control is created on demand, i.e. when GetControl(true)
 104     // is called the first time.
 105
 106     SetBackground (Wallpaper());
 107
 108     GetTitleBar()->GetWindow()->Show ();
 109     GetTitleBar()->GetWindow()->AddEventListener (
 110         LINK(this,TitledControl,WindowEventListener));
 111
 112     UpdateStates ();
 113 }
 114
 115
 116
 117
 118 TitledControl::~TitledControl (void)
 119 {
 120     GetTitleBar()->GetWindow()->RemoveEventListener (
 121         LINK(this,TitledControl,WindowEventListener));
 122 }
 123
 124
 125
 126
 127 Size TitledControl::GetPreferredSize (void)
 128 {
 129     Size aPreferredSize;
 130     if (GetControl(false) != NULL)
 131     {
 132         aPreferredSize = GetControl()->GetPreferredSize();
 133         if ( ! IsExpanded())
 134             aPreferredSize.Height() = 0;
 135     }
 136     else
 137         aPreferredSize = Size (GetSizePixel().Width(), 0);
 138     if (aPreferredSize.Width() == 0)
 139         aPreferredSize.Width() = 300;
 140     aPreferredSize.Height() += GetTitleBar()->GetPreferredHeight(
 141         aPreferredSize.Width());
 142
 143     return aPreferredSize;
 144 }
 145
 146
 147
 148
 149 sal_Int32 TitledControl::GetPreferredWidth (sal_Int32 nHeight)
 150 {
 151     int nPreferredWidth = 0;
 152     if (GetControl(false) != NULL)
 153         nPreferredWidth = GetControl()->GetPreferredWidth(
 154             nHeight - GetTitleBar()->GetWindow()->GetSizePixel().Height());
 155     else
 156         nPreferredWidth = GetSizePixel().Width();
 157     if (nPreferredWidth == 0)
 158         nPreferredWidth = 300;
 159
 160     return nPreferredWidth;
 161 }
 162
 163
 164
 165
 166 sal_Int32 TitledControl::GetPreferredHeight (sal_Int32 nWidth)
 167 {
 168     int nPreferredHeight = 0;
 169     if (IsExpanded() && GetControl(false)!=NULL)
 170         nPreferredHeight = GetControl()->GetPreferredHeight(nWidth);
 171     nPreferredHeight += GetTitleBar()->GetPreferredHeight(nWidth);
 172
 173     return nPreferredHeight;
 174 }
 175
 176
 177
 178
 179 bool TitledControl::IsResizable (void)
 180 {
 181     return IsExpanded()
 182         && GetControl()->IsResizable();
 183 }
 184
 185
 186
 187
 188 ::Window* TitledControl::GetWindow (void)
 189 {
 190     return this;
 191 }
 192
 193
 194
 195
 196 void TitledControl::Resize (void)
 197 {
 198     Size aWindowSize (GetOutputSizePixel());
 199
 200     int nTitleBarHeight
 201         = GetTitleBar()->GetPreferredHeight(aWindowSize.Width());
 202     GetTitleBar()->GetWindow()->SetPosSizePixel (
 203         Point (0,0),
 204         Size (aWindowSize.Width(), nTitleBarHeight));
 205
 206
 207     TreeNode* pControl = GetControl(false);
 208     if (pControl != NULL
 209         && pControl->GetWindow() != NULL
 210         && pControl->GetWindow()->IsVisible())
 211     {
 212         pControl->GetWindow()->SetPosSizePixel (
 213             Point (0,nTitleBarHeight),
 214             Size (aWindowSize.Width(), aWindowSize.Height()-nTitleBarHeight));
 215     }
 216 }
 217
 218
 219
 220
 221 void TitledControl::GetFocus (void)
 222 {
 223     ::Window::GetFocus();
 224     if (GetTitleBar() != NULL)
 225         GetTitleBar()->SetFocus (true);
 226 }
 227
 228
 229
 230
 231 void TitledControl::LoseFocus (void)
 232 {
 233     ::Window::LoseFocus();
 234     if (GetTitleBar() != NULL)
 235         GetTitleBar()->SetFocus (false);
 236 }
 237
 238
 239
 240
 241 void TitledControl::KeyInput (const KeyEvent& rEvent)
 242 {
 243         KeyCode nCode = rEvent.GetKeyCode();
 244     if (nCode == KEY_SPACE)
 245     {
 246         // Toggle the expansion state of the control (when toggling is
 247         // supported.)  The focus remains on this control.
 248         GetParentNode()->GetControlContainer().SetExpansionState (
 249             this,
 250             ControlContainer::ES_TOGGLE);
 251     }
 252     else if (nCode == KEY_RETURN)
 253     {
 254         // Return, also called enter, enters the control and puts the
 255         // focus to the first child.  If the control is not yet
 256         // expanded then do that first.
 257         GetParentNode()->GetControlContainer().SetExpansionState (
 258             this,
 259             ControlContainer::ES_EXPAND);
 260
 261         if ( ! FocusManager::Instance().TransferFocus(this,nCode))
 262         {
 263             // When already expanded then put focus on first child.
 264             TreeNode* pControl = GetControl(false);
 265             if (pControl!=NULL && IsExpanded())
 266                 if (pControl->GetWindow() != NULL)
 267                     pControl->GetWindow()->GrabFocus();
 268         }
 269     }
 270     else if (nCode == KEY_ESCAPE)
 271     {
 272         if ( ! FocusManager::Instance().TransferFocus(this,nCode))
 273             // Put focus to parent.
 274             GetParent()->GrabFocus();
 275     }
 276     else
 277         Window::KeyInput (rEvent);
 278 }
 279
 280
 281
 282
 283 const String& TitledControl::GetTitle (void) const
 284 {
 285     return msTitle;
 286 }
 287
 288
 289
 290
 291 bool TitledControl::Expand (bool bExpanded)
 292 {
 293     bool bExpansionStateChanged (false);
 294
 295     if (IsExpandable() && IsEnabled())
 296     {
 297         if (GetTitleBar()->IsExpanded() != bExpanded)
 298             bExpansionStateChanged |= GetTitleBar()->Expand (bExpanded);
 299         // Get the control.  Use the bExpanded parameter as argument to
 300         // indicate that a control is created via its factory only when it
 301         // is to be expanded.  When it is collapsed this is not necessary.
 302         TreeNode* pControl = GetControl(bExpanded);
 303         if (pControl != NULL
 304             && GetControl()->IsExpanded() != bExpanded)
 305         {
 306             bExpansionStateChanged |= pControl->Expand (bExpanded);
 307         }
 308         if (bExpansionStateChanged)
 309             UpdateStates();
 310     }
 311
 312     return bExpansionStateChanged;
 313 }
 314
 315
 316
 317
 318 bool TitledControl::IsExpandable (void) const
 319 {
 320     const TreeNode* pControl = GetConstControl(false);
 321     if (pControl != NULL)
 322         return pControl->IsExpandable();
 323     else
 324         // When a control factory is given but the control has not yet been
 325         // created we assume that the control is expandable.
 326         return true;
 327 }
 328
 329
 330
 331
 332 bool TitledControl::IsExpanded (void) const
 333 {
 334     const TreeNode* pControl = GetConstControl(false);
 335     if (pControl != NULL)
 336         return pControl->IsExpanded();
 337     else
 338         return false;
 339 }
 340
 341 void TitledControl::SetEnabledState(bool bFlag)
 342 {
 343     if (!bFlag)
 344     {
 345             GetParentNode()->GetControlContainer().SetExpansionState (
 346                     this,
 347                     ControlContainer::ES_COLLAPSE);
 348             Disable();
 349     }
 350     else
 351     {
 352             GetParentNode()->GetControlContainer().SetExpansionState (
 353                     this,
 354                     ControlContainer::ES_EXPAND);
 355             Enable();
 356     }
 357
 358     GetTitleBar()->SetEnabledState(bFlag);
 359 }
 360
 361
 362
 363 void TitledControl::SetUserData (void* pUserData)
 364 {
 365     mpUserData = pUserData;
 366 }
 367
 368
 369
 370
 371 void* TitledControl::GetUserData (void) const
 372 {
 373     return mpUserData;
 374 }
 375
 376
 377
 378
 379 bool TitledControl::IsShowing (void) const
 380 {
 381     return mbVisible;
 382 }
 383
 384
 385
 386
 387 void TitledControl::Show (bool bVisible)
 388 {
 389     if (mbVisible != bVisible)
 390     {
 391         mbVisible = bVisible;
 392         UpdateStates ();
 393     }
 394 }
 395
 396
 397
 398
 399 void TitledControl::UpdateStates (void)
 400 {
 401     if (mbVisible)
 402         GetWindow()->Show();
 403     else
 404         GetWindow()->Hide();
 405
 406     TreeNode* pControl = GetControl(false);
 407     if (pControl!=NULL  &&  pControl->GetWindow() != NULL)
 408     {
 409         if (IsVisible() && IsExpanded())
 410             pControl->GetWindow()->Show();
 411         else
 412             pControl->GetWindow()->Hide();
 413     }
 414 }
 415
 416
 417
 418
 419 IMPL_LINK(TitledControl, WindowEventListener,
 420     VclSimpleEvent*, pEvent)
 421 {
 422     if (pEvent!=NULL && pEvent->ISA(VclWindowEvent))
 423     {
 424         VclWindowEvent* pWindowEvent = static_cast<VclWindowEvent*>(pEvent);
 425         switch (pWindowEvent->GetId())
 426         {
 427             case VCLEVENT_WINDOW_MOUSEBUTTONUP:
 428                 if (IsEnabled())
 429                     (*mpClickHandler)(*this);
 430                 break;
 431         }
 432     }
 433     return 0;
 434 }
 435
 436
 437
 438
 439 TreeNode* TitledControl::GetControl (bool bCreate)
 440 {
 441     TreeNode* pNode = mpControlContainer->GetControl(1);
 442     if (pNode==NULL && mpControlFactory.get()!=NULL && bCreate)
 443     {
 444         // We have to create the control with the factory object.
 445         ::std::auto_ptr<TreeNode> pControl (mpControlFactory->CreateControl(this));//GetParentNode()));
 446         if (pControl.get() != NULL)
 447         {
 448             pControl->SetParentNode(this);
 449             mpControlContainer->AddControl(pControl);
 450
 451             pNode = mpControlContainer->GetControl(1);
 452             FocusManager::Instance().RegisterDownLink(this, pNode->GetWindow());
 453             FocusManager::Instance().RegisterUpLink(pNode->GetWindow(), this);
 454         }
 455     }
 456
 457     return pNode;
 458 }
 459
 460
 461
 462
 463 const TreeNode* TitledControl::GetConstControl (bool bCreate) const
 464 {
 465     return const_cast<TitledControl*>(this)->GetControl(bCreate);
 466 }
 467
 468
 469
 470
 471 TitleBar* TitledControl::GetTitleBar (void)
 472 {
 473     return static_cast<TitleBar*>(mpControlContainer->GetControl(0));
 474 }
 475
 476
 477
 478
 479 ::com::sun::star::uno::Reference<
 480     ::com::sun::star::accessibility::XAccessible> TitledControl::CreateAccessibleObject (
 481         const ::com::sun::star::uno::Reference<
 482         ::com::sun::star::accessibility::XAccessible>& )
 483 {
 484     return new ::accessibility::AccessibleTreeNode(
 485         *this,
 486         GetTitle(),
 487         GetTitle(),
 488         ::com::sun::star::accessibility::AccessibleRole::LIST_ITEM);
 489 }
 490
 491
 492
 493
 494 //===== TitledControlStandardClickHandler =====================================
 495
 496 TitledControlStandardClickHandler::TitledControlStandardClickHandler (
 497     ControlContainer& rControlContainer,
 498     ControlContainer::ExpansionState eExpansionState)
 499     : mrControlContainer(rControlContainer),
 500       meExpansionState(eExpansionState)
 501 {
 502 }
 503
 504
 505
 506
 507 void TitledControlStandardClickHandler::operator () (TitledControl& rTitledControl)
 508 {
 509     // Toggle expansion.
 510     mrControlContainer.SetExpansionState (&rTitledControl, meExpansionState);
 511 }
 512
 513 } } // end of namespace ::sd::toolpanel