sd/source/ui/slidesorter/controller/SlsFocusManager.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 <controller/SlsFocusManager.hxx>
  21
  22 #include <SlideSorter.hxx>
  23 #include <PaneDockingWindow.hxx>
  24 #include <controller/SlideSorterController.hxx>
  25 #include <controller/SlsCurrentSlideManager.hxx>
  26 #include <controller/SlsVisibleAreaManager.hxx>
  27 #include <model/SlideSorterModel.hxx>
  28 #include <model/SlsPageDescriptor.hxx>
  29 #include <view/SlideSorterView.hxx>
  30 #include <view/SlsLayouter.hxx>
  31 #include <vcl/toolbox.hxx>
  32
  33 #include <Window.hxx>
  34 #include <sdpage.hxx>
  35
  36 namespace sd { namespace slidesorter { namespace controller {
  37
  38 FocusManager::FocusManager (SlideSorter& rSlideSorter)
  39     : mrSlideSorter(rSlideSorter),
  40       mnPageIndex(0),
  41       mbPageIsFocused(false)
  42 {
  43     if (mrSlideSorter.GetModel().GetPageCount() > 0)
  44         mnPageIndex = 0;
  45 }
  46
  47 FocusManager::~FocusManager()
  48 {
  49 }
  50
  51 void FocusManager::MoveFocus (FocusMoveDirection eDirection)
  52 {
  53     if (!(mnPageIndex >= 0 && mbPageIsFocused))
  54         return;
  55
  56     HideFocusIndicator (GetFocusedPageDescriptor());
  57
  58     const sal_Int32 nColumnCount (mrSlideSorter.GetView().GetLayouter().GetColumnCount());
  59     const sal_Int32 nPageCount (mrSlideSorter.GetModel().GetPageCount());
  60     switch (eDirection)
  61     {
  62         case FocusMoveDirection::Left:
  63             if (mnPageIndex > 0)
  64                 mnPageIndex -= 1;
  65             break;
  66
  67         case FocusMoveDirection::Right:
  68             if (mnPageIndex < nPageCount-1)
  69                 mnPageIndex += 1;
  70             break;
  71
  72         case FocusMoveDirection::Up:
  73         {
  74             const sal_Int32 nCandidate (mnPageIndex - nColumnCount);
  75             if (nCandidate >= 0)
  76             {
  77                 // Move the focus the previous row.
  78                 mnPageIndex = nCandidate;
  79             }
  80         }
  81         break;
  82
  83         case FocusMoveDirection::Down:
  84         {
  85             const sal_Int32 nCandidate (mnPageIndex + nColumnCount);
  86             if (nCandidate < nPageCount)
  87             {
  88                 // Move the focus to the next row.
  89                 mnPageIndex = nCandidate;
  90             }
  91         }
  92         break;
  93     }
  94
  95     if (mnPageIndex < 0)
  96     {
  97         OSL_ASSERT(mnPageIndex>=0);
  98         mnPageIndex = 0;
  99     }
 100     else if (mnPageIndex >= nPageCount)
 101     {
 102         OSL_ASSERT(mnPageIndex<nPageCount);
 103         mnPageIndex = nPageCount - 1;
 104     }
 105
 106     if (mbPageIsFocused)
 107     {
 108         ShowFocusIndicator(GetFocusedPageDescriptor(), true);
 109     }
 110 }
 111
 112 void FocusManager::ShowFocus (const bool bScrollToFocus)
 113 {
 114     mbPageIsFocused = true;
 115     ShowFocusIndicator(GetFocusedPageDescriptor(), bScrollToFocus);
 116 }
 117
 118 void FocusManager::HideFocus()
 119 {
 120     mbPageIsFocused = false;
 121     HideFocusIndicator(GetFocusedPageDescriptor());
 122 }
 123
 124 bool FocusManager::ToggleFocus()
 125 {
 126     if (mnPageIndex >= 0)
 127     {
 128         if (mbPageIsFocused)
 129             HideFocus ();
 130         else
 131             ShowFocus ();
 132     }
 133     return mbPageIsFocused;
 134 }
 135
 136 bool FocusManager::HasFocus() const
 137 {
 138     return mrSlideSorter.GetContentWindow()->HasFocus();
 139 }
 140
 141 model::SharedPageDescriptor FocusManager::GetFocusedPageDescriptor() const
 142 {
 143     return mrSlideSorter.GetModel().GetPageDescriptor(mnPageIndex);
 144 }
 145
 146 void FocusManager::SetFocusedPage (const model::SharedPageDescriptor& rpDescriptor)
 147 {
 148     if (rpDescriptor.get() != nullptr)
 149     {
 150         FocusHider aFocusHider (*this);
 151         mnPageIndex = (rpDescriptor->GetPage()->GetPageNum()-1)/2;
 152     }
 153 }
 154
 155 void FocusManager::SetFocusedPage (sal_Int32 nPageIndex)
 156 {
 157     FocusHider aFocusHider (*this);
 158     mnPageIndex = nPageIndex;
 159 }
 160
 161 void FocusManager::SetFocusedPageToCurrentPage()
 162 {
 163     SetFocusedPage(mrSlideSorter.GetController().GetCurrentSlideManager()->GetCurrentSlide());
 164 }
 165
 166 bool FocusManager::IsFocusShowing() const
 167 {
 168     return HasFocus() && mbPageIsFocused;
 169 }
 170
 171 void FocusManager::HideFocusIndicator (const model::SharedPageDescriptor& rpDescriptor)
 172 {
 173     if (rpDescriptor.get() != nullptr)
 174     {
 175         mrSlideSorter.GetView().SetState(rpDescriptor, model::PageDescriptor::ST_Focused, false);
 176
 177         // Hide focus should also fire the focus event, Currently, only accessibility add the focus listener
 178         NotifyFocusChangeListeners();
 179     }
 180 }
 181
 182 void FocusManager::ShowFocusIndicator (
 183     const model::SharedPageDescriptor& rpDescriptor,
 184     const bool bScrollToFocus)
 185 {
 186     if (rpDescriptor.get() == nullptr)
 187         return;
 188
 189     mrSlideSorter.GetView().SetState(rpDescriptor, model::PageDescriptor::ST_Focused, true);
 190
 191     if (bScrollToFocus)
 192     {
 193         // Scroll the focused page object into the visible area and repaint
 194         // it, so that the focus indicator becomes visible.
 195         mrSlideSorter.GetController().GetVisibleAreaManager().RequestVisible(rpDescriptor,true);
 196     }
 197     mrSlideSorter.GetView().RequestRepaint(rpDescriptor);
 198
 199     NotifyFocusChangeListeners();
 200 }
 201
 202 void FocusManager::AddFocusChangeListener (const Link<LinkParamNone*,void>& rListener)
 203 {
 204     if (::std::find (maFocusChangeListeners.begin(), maFocusChangeListeners.end(), rListener)
 205         == maFocusChangeListeners.end())
 206     {
 207         maFocusChangeListeners.push_back (rListener);
 208     }
 209 }
 210
 211 void FocusManager::RemoveFocusChangeListener (const Link<LinkParamNone*,void>& rListener)
 212 {
 213     maFocusChangeListeners.erase (
 214         ::std::find (maFocusChangeListeners.begin(), maFocusChangeListeners.end(), rListener));
 215 }
 216
 217 void FocusManager::NotifyFocusChangeListeners() const
 218 {
 219     // Create a copy of the listener list to be safe when that is modified.
 220     ::std::vector<Link<LinkParamNone*,void>> aListeners (maFocusChangeListeners);
 221
 222     // Tell the selection change listeners that the selection has changed.
 223     for (auto& rListener : aListeners)
 224     {
 225         rListener.Call(nullptr);
 226     }
 227 }
 228
 229 FocusManager::FocusHider::FocusHider (FocusManager& rManager)
 230 : mbFocusVisible(rManager.IsFocusShowing())
 231 , mrManager(rManager)
 232 {
 233     mrManager.HideFocus();
 234 }
 235
 236 FocusManager::FocusHider::~FocusHider() COVERITY_NOEXCEPT_FALSE
 237 {
 238     if (mbFocusVisible)
 239         mrManager.ShowFocus();
 240 }
 241
 242 } } } // end of namespace ::sd::slidesorter::controller
 243
 244 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */