sd/source/ui/inc/fupoor.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 <vcl/timer.hxx>
  23 #include <tools/link.hxx>
  24 #include <tools/gen.hxx>
  25 #include <vcl/vclptr.hxx>
  26 #include <svx/svdobj.hxx>
  27
  28 #include <helper/simplereferencecomponent.hxx>
  29
  30 class SdDrawDocument;
  31 class SfxRequest;
  32 class CommandEvent;
  33 class HelpEvent;
  34 class KeyEvent;
  35 class MouseEvent;
  36
  37 namespace sd {
  38
  39 class DrawDocShell;
  40 class View;
  41 class ViewShell;
  42 class Window;
  43
  44 /**
  45  * Base class for all functions
  46  */
  47 class FuPoor : public SimpleReferenceComponent
  48 {
  49 public:
  50     static const int HITPIX = 2;                   // hit tolerance in pixel
  51     static const int HITLOG = 53;                  // hit tolerance in mm100
  52     static const int DRGLOG = 53;                  // minimal drag move in mm100
  53
  54
  55     virtual void DoExecute( SfxRequest& rReq );
  56
  57     void SetMouseButtonCode(sal_uInt16 nNew) { if(nNew != mnCode) mnCode = nNew; }
  58     sal_uInt16 GetMouseButtonCode() const { return mnCode; }
  59
  60     DrawDocShell* GetDocSh() { return mpDocSh; }
  61
  62     virtual void DoCut();
  63     virtual void DoCopy();
  64     virtual void DoPaste();
  65     virtual void DoPasteUnformatted();
  66
  67     // mouse & key events; return value = sal_True: event has been handled
  68     virtual bool KeyInput(const KeyEvent& rKEvt);
  69     virtual bool MouseMove(const MouseEvent& );
  70     virtual bool MouseButtonUp(const MouseEvent& rMEvt);
  71
  72     // moved from inline to *.cxx
  73     virtual bool MouseButtonDown(const MouseEvent& rMEvt);
  74
  75     virtual bool Command(const CommandEvent& rCEvt);
  76     virtual bool RequestHelp(const HelpEvent& rHEvt);
  77     virtual void ReceiveRequest(SfxRequest& rReq);
  78
  79     virtual void Activate();        ///< activates the function
  80     virtual void Deactivate();      ///< deactivates the function
  81
  82     void SetWindow(::sd::Window* pWin);
  83
  84     virtual void SelectionHasChanged();
  85
  86     sal_uInt16  GetSlotID() const { return nSlotId; }
  87
  88     void StartDelayToScrollTimer ();
  89
  90     virtual rtl::Reference<SdrObject> CreateDefaultObject(const sal_uInt16 nID, const ::tools::Rectangle& rRectangle);
  91
  92     /** is called when the current function should be aborted. <p>
  93         This is used when a function gets a KEY_ESCAPE but can also
  94         be called directly.
  95
  96         @returns true if an active function was aborted
  97     */
  98     virtual bool cancel();
  99
 100     // #i33136#
 101     /** Decide if the object to be created should be created
 102         orthogonal. Default implementation uses nSlotID
 103         to decide. May be overridden to use other criteria
 104         for this decision
 105
 106         @returns true if the to be created object should be orthogonal.
 107     */
 108     virtual bool doConstructOrthogonal() const;
 109
 110 protected:
 111     /**
 112         @param pViewSh
 113             May be NULL.
 114     */
 115     FuPoor (ViewShell* pViewSh,
 116         ::sd::Window* pWin,
 117         ::sd::View* pView,
 118         SdDrawDocument* pDoc,
 119         SfxRequest& rReq);
 120     virtual ~FuPoor() override;
 121
 122     DECL_LINK( DelayHdl, Timer *, void );
 123
 124     static void ImpForceQuadratic(::tools::Rectangle& rRect);
 125
 126     /** Switch to another layer.  The layer to switch to is specified by an
 127         offset relative to the active layer.  With respect to the layer bar
 128         control at the lower left of the document window positive values
 129         move to the right and negative values move to the left.
 130
 131         <p>Switching the layer is independent of the view's layer mode.  The
 132         layers are switched even when the layer mode is turned off and the
 133         layer control is not visible.</p>
 134         @param nOffset
 135            If the offset is positive skip that many layers in selecting the
 136            next layer.  If it is negative then select a previous one.  An
 137            offset or zero does not change the current layer.  If the
 138            resulting index lies outside the valid range of indices then it
 139            is set to either the minimal or maximal valid index, whichever
 140            is nearer.
 141     */
 142     void SwitchLayer (sal_Int32 nOffset);
 143
 144     ::sd::View* mpView;
 145     ViewShell* mpViewShell;
 146     VclPtr< ::sd::Window> mpWindow;
 147     DrawDocShell* mpDocSh;
 148     SdDrawDocument* mpDoc;
 149
 150     sal_uInt16          nSlotId;
 151
 152     Timer               aScrollTimer;           ///< for auto-scrolling
 153     DECL_LINK( ScrollHdl, Timer *, void );
 154     void ForceScroll(const Point& aPixPos);
 155
 156     Timer               aDragTimer;             ///< for Drag&Drop
 157     DECL_LINK(DragHdl, Timer *, void);
 158     bool            bIsInDragMode;
 159     Point               aMDPos;                 ///< position of MouseButtonDown
 160
 161     /// Flag to prevent auto-scrolling until one drags from outside into the window
 162     bool            bNoScrollUntilInside;
 163
 164     /// timer to delay scrolling (~ 1 sec) when dragging out of the window
 165     Timer               aDelayToScrollTimer;
 166     bool            bScrollable;
 167     bool            bDelayActive;
 168     bool            bFirstMouseMove;
 169
 170     /// member to hold state of the mouse buttons for creation of own MouseEvents (like in ScrollHdl)
 171
 172 private:
 173     sal_uInt16      mnCode;
 174
 175 };
 176
 177 } // end of namespace sd
 178
 179 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */