sd/source/ui/toolpanel/TitledControl.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 // MARKER(update_precomp.py): autogen include statement, do not remove
  29 #include "precompiled_sd.hxx"
  30
  31 #include "taskpane/TitledControl.hxx"
  32
  33 #include "AccessibleTreeNode.hxx"
  34 #include "taskpane/ControlContainer.hxx"
  35 #include "TaskPaneFocusManager.hxx"
  36 #include "taskpane/TaskPaneControlFactory.hxx"
  37 #include <vcl/ctrl.hxx>
  38 #include <vcl/svapp.hxx>
  39
  40
  41 namespace sd { namespace toolpanel {
  42
  43
  44 TitledControl::TitledControl (
  45     TreeNode* pParent,
  46     ::std::auto_ptr<TreeNode> pControl,
  47     const String& rTitle,
  48     const ClickHandler& rClickHandler,
  49     TitleBar::TitleBarType eType)
  50     : ::Window (pParent->GetWindow(), WB_TABSTOP),
  51       TreeNode(pParent),
  52       msTitle(rTitle),
  53       mbVisible(true),
  54       mpUserData(NULL),
  55       mpClickHandler(new ClickHandler(rClickHandler))
  56 {
  57     mpControlContainer->AddControl (::std::auto_ptr<TreeNode> (
  58         new TitleBar (this, rTitle, eType, pControl->IsExpandable())));
  59     pControl->SetParentNode (this);
  60     mpControlContainer->AddControl (pControl);
  61
  62     FocusManager::Instance().RegisterDownLink( GetTitleBar()->GetWindow(), GetControl()->GetWindow() );
  63     FocusManager::Instance().RegisterUpLink( GetControl()->GetWindow(), GetTitleBar()->GetWindow() );
  64
  65     SetBackground (Wallpaper());
  66
  67     GetTitleBar()->GetWindow()->Show ();
  68     GetTitleBar()->GetWindow()->AddEventListener (
  69         LINK(this,TitledControl,WindowEventListener));
  70
  71     UpdateStates ();
  72 }
  73
  74
  75
  76
  77 TitledControl::~TitledControl (void)
  78 {
  79     GetTitleBar()->GetWindow()->RemoveEventListener (
  80         LINK(this,TitledControl,WindowEventListener));
  81 }
  82
  83
  84
  85
  86 Size TitledControl::GetPreferredSize (void)
  87 {
  88     Size aPreferredSize;
  89     if (GetControl() != NULL)
  90     {
  91         aPreferredSize = GetControl()->GetPreferredSize();
  92         if ( ! IsExpanded())
  93             aPreferredSize.Height() = 0;
  94     }
  95     else
  96         aPreferredSize = Size (GetSizePixel().Width(), 0);
  97     if (aPreferredSize.Width() == 0)
  98         aPreferredSize.Width() = 300;
  99     aPreferredSize.Height() += GetTitleBar()->GetPreferredHeight(
 100         aPreferredSize.Width());
 101
 102     return aPreferredSize;
 103 }
 104
 105
 106
 107
 108 sal_Int32 TitledControl::GetPreferredWidth (sal_Int32 nHeight)
 109 {
 110     int nPreferredWidth = 0;
 111     if (GetControl() != NULL)
 112         nPreferredWidth = GetControl()->GetPreferredWidth(
 113             nHeight - GetTitleBar()->GetWindow()->GetSizePixel().Height());
 114     else
 115         nPreferredWidth = GetSizePixel().Width();
 116     if (nPreferredWidth == 0)
 117         nPreferredWidth = 300;
 118
 119     return nPreferredWidth;
 120 }
 121
 122
 123
 124
 125 sal_Int32 TitledControl::GetPreferredHeight (sal_Int32 nWidth)
 126 {
 127     int nPreferredHeight = 0;
 128     if (IsExpanded() && GetControl()!=NULL)
 129         nPreferredHeight = GetControl()->GetPreferredHeight(nWidth);
 130     nPreferredHeight += GetTitleBar()->GetPreferredHeight(nWidth);
 131
 132     return nPreferredHeight;
 133 }
 134
 135
 136
 137
 138 bool TitledControl::IsResizable (void)
 139 {
 140     return IsExpanded()
 141         && GetControl()->IsResizable();
 142 }
 143
 144
 145
 146
 147 ::Window* TitledControl::GetWindow (void)
 148 {
 149     return this;
 150 }
 151
 152
 153
 154
 155 void TitledControl::Resize (void)
 156 {
 157     Size aWindowSize (GetOutputSizePixel());
 158
 159     int nTitleBarHeight
 160         = GetTitleBar()->GetPreferredHeight(aWindowSize.Width());
 161     GetTitleBar()->GetWindow()->SetPosSizePixel (
 162         Point (0,0),
 163         Size (aWindowSize.Width(), nTitleBarHeight));
 164
 165
 166     TreeNode* pControl = GetControl();
 167     if (pControl != NULL
 168         && pControl->GetWindow() != NULL
 169         && pControl->GetWindow()->IsVisible())
 170     {
 171         pControl->GetWindow()->SetPosSizePixel (
 172             Point (0,nTitleBarHeight),
 173             Size (aWindowSize.Width(), aWindowSize.Height()-nTitleBarHeight));
 174     }
 175 }
 176
 177
 178
 179
 180 void TitledControl::GetFocus (void)
 181 {
 182     ::Window::GetFocus();
 183     if (GetTitleBar() != NULL)
 184         GetTitleBar()->GrabFocus();
 185 }
 186
 187
 188
 189
 190 void TitledControl::KeyInput (const KeyEvent& rEvent)
 191 {
 192     KeyCode nCode = rEvent.GetKeyCode();
 193     if (nCode == KEY_SPACE)
 194     {
 195         // Toggle the expansion state of the control (when toggling is
 196         // supported.)  The focus remains on this control.
 197         GetParentNode()->GetControlContainer().SetExpansionState (
 198             this,
 199             ControlContainer::ES_TOGGLE);
 200     }
 201     else if (nCode == KEY_RETURN)
 202     {
 203         // Return, also called enter, enters the control and puts the
 204         // focus to the first child.  If the control is not yet
 205         // expanded then do that first.
 206         GetParentNode()->GetControlContainer().SetExpansionState (
 207             this,
 208             ControlContainer::ES_EXPAND);
 209
 210         if ( ! FocusManager::Instance().TransferFocus(this,nCode))
 211         {
 212             // When already expanded then put focus on first child.
 213             TreeNode* pControl = GetControl();
 214             if (pControl!=NULL && IsExpanded())
 215                 if (pControl->GetWindow() != NULL)
 216                     pControl->GetWindow()->GrabFocus();
 217         }
 218     }
 219     else if (nCode == KEY_ESCAPE)
 220     {
 221         if ( ! FocusManager::Instance().TransferFocus(this,nCode))
 222             // Put focus to parent.
 223             GetParent()->GrabFocus();
 224     }
 225     else
 226         Window::KeyInput (rEvent);
 227 }
 228
 229
 230
 231
 232 const String& TitledControl::GetTitle (void) const
 233 {
 234     return msTitle;
 235 }
 236
 237
 238
 239
 240 bool TitledControl::Expand (bool bExpanded)
 241 {
 242     bool bExpansionStateChanged (false);
 243
 244     if (IsExpandable() && IsEnabled())
 245     {
 246         if (GetTitleBar()->IsExpanded() != bExpanded)
 247             bExpansionStateChanged |= GetTitleBar()->Expand (bExpanded);
 248         // Get the control.  Use the bExpanded parameter as argument to
 249         // indicate that a control is created via its factory only when it
 250         // is to be expanded.  When it is collapsed this is not necessary.
 251         TreeNode* pControl = GetControl();
 252         if (pControl != NULL
 253             && GetControl()->IsExpanded() != bExpanded)
 254         {
 255             bExpansionStateChanged |= pControl->Expand (bExpanded);
 256         }
 257         if (bExpansionStateChanged)
 258             UpdateStates();
 259     }
 260
 261     return bExpansionStateChanged;
 262 }
 263
 264
 265
 266
 267 bool TitledControl::IsExpandable (void) const
 268 {
 269     const TreeNode* pControl = GetConstControl();
 270     if (pControl != NULL)
 271         return pControl->IsExpandable();
 272     else
 273         // When a control factory is given but the control has not yet been
 274         // created we assume that the control is expandable.
 275         return true;
 276 }
 277
 278
 279
 280
 281 bool TitledControl::IsExpanded (void) const
 282 {
 283     const TreeNode* pControl = GetConstControl();
 284     if (pControl != NULL)
 285         return pControl->IsExpanded();
 286     else
 287         return false;
 288 }
 289
 290 void TitledControl::SetEnabledState(bool bFlag)
 291 {
 292     if (!bFlag)
 293     {
 294         GetParentNode()->GetControlContainer().SetExpansionState (
 295             this,
 296             ControlContainer::ES_COLLAPSE);
 297         Disable();
 298     }
 299     else
 300     {
 301 /*
 302         GetParentNode()->GetControlContainer().SetExpansionState (
 303             this,
 304             ControlContainer::ES_EXPAND);
 305 */
 306         Enable();
 307     }
 308
 309     GetTitleBar()->SetEnabledState(bFlag);
 310 }
 311
 312
 313
 314 bool TitledControl::IsShowing (void) const
 315 {
 316     return mbVisible;
 317 }
 318
 319
 320
 321
 322 void TitledControl::Show (bool bVisible)
 323 {
 324     if (mbVisible != bVisible)
 325     {
 326         mbVisible = bVisible;
 327         UpdateStates ();
 328     }
 329 }
 330
 331
 332
 333
 334 void TitledControl::UpdateStates (void)
 335 {
 336     if (mbVisible)
 337         GetWindow()->Show();
 338     else
 339         GetWindow()->Hide();
 340
 341     TreeNode* pControl = GetControl();
 342     if (pControl!=NULL  &&  pControl->GetWindow() != NULL)
 343     {
 344         if (IsVisible() && IsExpanded())
 345             pControl->GetWindow()->Show();
 346         else
 347             pControl->GetWindow()->Hide();
 348     }
 349 }
 350
 351
 352
 353
 354 IMPL_LINK(TitledControl, WindowEventListener,
 355     VclSimpleEvent*, pEvent)
 356 {
 357     if (pEvent!=NULL && pEvent->ISA(VclWindowEvent))
 358     {
 359         VclWindowEvent* pWindowEvent = static_cast<VclWindowEvent*>(pEvent);
 360         switch (pWindowEvent->GetId())
 361         {
 362             case VCLEVENT_WINDOW_MOUSEBUTTONUP:
 363                 if (IsEnabled())
 364                     (*mpClickHandler)(*this);
 365                 break;
 366         }
 367     }
 368     return 0;
 369 }
 370
 371
 372
 373
 374 TreeNode* TitledControl::GetControl (void)
 375 {
 376     return mpControlContainer->GetControl(1);
 377 }
 378
 379
 380
 381
 382 const TreeNode* TitledControl::GetConstControl () const
 383 {
 384     return const_cast<TitledControl*>(this)->GetControl();
 385 }
 386
 387
 388
 389
 390 TitleBar* TitledControl::GetTitleBar (void)
 391 {
 392     return static_cast<TitleBar*>(mpControlContainer->GetControl(0));
 393 }
 394
 395
 396
 397
 398 ::com::sun::star::uno::Reference<
 399     ::com::sun::star::accessibility::XAccessible> TitledControl::CreateAccessibleObject (
 400         const ::com::sun::star::uno::Reference<
 401         ::com::sun::star::accessibility::XAccessible>& )
 402 {
 403     return new ::accessibility::AccessibleTreeNode(
 404         *this,
 405         GetTitle(),
 406         GetTitle(),
 407         ::com::sun::star::accessibility::AccessibleRole::LIST_ITEM);
 408 }
 409
 410
 411
 412
 413 //===== TitledControlStandardClickHandler =====================================
 414
 415 TitledControlStandardClickHandler::TitledControlStandardClickHandler (
 416     ControlContainer& rControlContainer,
 417     ControlContainer::ExpansionState eExpansionState)
 418     : mrControlContainer(rControlContainer),
 419       meExpansionState(eExpansionState)
 420 {
 421 }
 422
 423
 424
 425
 426 void TitledControlStandardClickHandler::operator () (TitledControl& rTitledControl)
 427 {
 428     // Toggle expansion.
 429     mrControlContainer.SetExpansionState (&rTitledControl, meExpansionState);
 430 }
 431
 432 } } // end of namespace ::sd::toolpanel