sd/source/ui/slidesorter/inc/controller/SlsSelectionFunction.hxx

   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 #pragma once
  21
  22 #include <controller/SlsFocusManager.hxx>
  23 #include <fupoor.hxx>
  24 #include <memory>
  25
  26 namespace sd::slidesorter
  27 {
  28 class SlideSorter;
  29 }
  30
  31 struct AcceptDropEvent;
  32
  33 namespace sd::slidesorter::controller
  34 {
  35 class SlideSorterController;
  36
  37 class SelectionFunction final : public FuPoor
  38 {
  39 public:
  40     SelectionFunction(const SelectionFunction&) = delete;
  41     SelectionFunction& operator=(const SelectionFunction&) = delete;
  42
  43     static rtl::Reference<FuPoor> Create(SlideSorter& rSlideSorter, SfxRequest& rRequest);
  44
  45     // Mouse- & Key-Events
  46     virtual bool KeyInput(const KeyEvent& rKEvt) override;
  47     virtual bool MouseMove(const MouseEvent& rMEvt) override;
  48     virtual bool MouseButtonUp(const MouseEvent& rMEvt) override;
  49     virtual bool MouseButtonDown(const MouseEvent& rMEvt) override;
  50
  51     /// Forward to the clipboard manager.
  52     virtual void DoCut() override;
  53
  54     /// Forward to the clipboard manager.
  55     virtual void DoCopy() override;
  56
  57     /// Forward to the clipboard manager.
  58     virtual void DoPaste() override;
  59
  60     /** is called when the current function should be aborted. <p>
  61         This is used when a function gets a KEY_ESCAPE but can also
  62         be called directly.
  63
  64         @returns
  65             true if an active function was aborted
  66     */
  67     virtual bool cancel() override;
  68
  69     void MouseDragged(const AcceptDropEvent& rEvent, const sal_Int8 nDragAction);
  70
  71     /** Turn of substitution display and insertion indicator.
  72     */
  73     void NotifyDragFinished();
  74
  75     class EventDescriptor;
  76     class ModeHandler;
  77     friend class ModeHandler;
  78     enum Mode
  79     {
  80         NormalMode,
  81         MultiSelectionMode,
  82         DragAndDropMode
  83     };
  84     void SwitchToNormalMode();
  85     void SwitchToDragAndDropMode(const Point& rMousePosition);
  86     void SwitchToMultiSelectionMode(const Point& rMousePosition, const sal_uInt32 nEventCode);
  87
  88     void ResetShiftKeySelectionAnchor();
  89     /** Special case handling for when the context menu is hidden.  This
  90         method will reinitialize the current mouse position to prevent the
  91         mouse motion during the time the context menu is displayed from
  92         being interpreted as drag-and-drop start.
  93     */
  94     void ResetMouseAnchor();
  95
  96 private:
  97     SlideSorter& mrSlideSorter;
  98     SlideSorterController& mrController;
  99
 100     SelectionFunction(SlideSorter& rSlideSorter, SfxRequest& rRequest);
 101
 102     virtual ~SelectionFunction() override;
 103
 104     /** Remember the slide where the shift key was pressed and started a
 105         multiselection via keyboard.
 106     */
 107     sal_Int32 mnShiftKeySelectionAnchor;
 108
 109     /** The selection function can be in one of several mutually
 110         exclusive modes.
 111     */
 112     std::shared_ptr<ModeHandler> mpModeHandler;
 113
 114     /** Make the slide nOffset slides away of the current one the new
 115         current slide.  When the new index is outside the range of valid
 116         page numbers it is clipped to that range.
 117         @param nOffset
 118             When nOffset is negative then go back.  When nOffset if positive go
 119             forward.  When it is zero then ignore the call.
 120     */
 121     void GotoNextPage(int nOffset);
 122
 123     /** Make the slide with the given index the new current slide.
 124         @param nIndex
 125             Index of the new current slide.  When the new index is outside
 126             the range of valid page numbers it is clipped to that range.
 127     */
 128     void GotoPage(int nIndex);
 129
 130     void ProcessMouseEvent(sal_uInt32 nEventType, const MouseEvent& rEvent);
 131
 132     // What follows are a couple of helper methods that are used by
 133     // ProcessMouseEvent().
 134
 135     void ProcessEvent(EventDescriptor& rEvent);
 136
 137     void MoveFocus(const FocusManager::FocusMoveDirection eDirection, const bool bIsShiftDown,
 138                    const bool bIsControlDown);
 139
 140     void SwitchMode(const std::shared_ptr<ModeHandler>& rpHandler);
 141 };
 142
 143 } // end of namespace ::sd::slidesorter::controller
 144
 145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */