sd/source/ui/inc/SlideSorter.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 <cppuhelper/weakref.hxx>
  23 #include <svtools/scrolladaptor.hxx>
  24 #include <sddllapi.h>
  25 #include <memory>
  26
  27 namespace vcl { class Window; }
  28 namespace com::sun::star::frame { class XController; }
  29 namespace rtl { template <class reference_type> class Reference; }
  30
  31 namespace sd {
  32 class ViewShell;
  33 class ViewShellBase;
  34 class Window;
  35 class FuPoor;
  36 }
  37
  38 namespace sd::slidesorter::model { class SlideSorterModel; }
  39
  40 namespace sd::slidesorter::view {
  41     class SlideSorterView;
  42     class Theme;
  43 }
  44
  45 namespace sd::slidesorter::controller {
  46     class SlideSorterController;
  47     class SlotManager;
  48     class Properties;
  49 }
  50
  51 namespace sd::slidesorter {
  52
  53 /** Show previews for all the slides in a document and allow the user to
  54     insert or delete slides and modify the order of the slides.
  55
  56     This class is a facade for the model, view, and controller classes.
  57     It is a hub that allows access to the various parts of a slide sorter.
  58
  59     Note that this class is not in its final state.
  60 */
  61 class SlideSorter final
  62 {
  63     friend class controller::SlotManager;
  64 public:
  65     ~SlideSorter();
  66
  67     /// Forbid copy construction and copy assignment
  68     SlideSorter(const SlideSorter&) = delete;
  69     SlideSorter& operator=(const SlideSorter&) = delete;
  70
  71     /** Create a new slide sorter that is strongly coupled to the given view
  72         shell.  Use this function for a slide sorter in the left pane.
  73         @param rViewShell
  74             Typically a SlideSorterViewShell object.
  75         @param rpContentWindow
  76             Typically the content window of the ViewShell.
  77         @param rpHorizontalScrollBar
  78             Typically the horizontal scroll bar of the ViewShell.
  79         @param rpVerticalScrollBar
  80             Typically the vertical scroll bar of the ViewShell.
  81     */
  82     static std::shared_ptr<SlideSorter> CreateSlideSorter (
  83         ViewShell& rViewShell,
  84         sd::Window* pContentWindow,
  85         ScrollAdaptor* pHorizontalScrollBar,
  86         ScrollAdaptor* pVerticalScrollBar);
  87
  88     /** Return the control of the vertical scroll bar.
  89     */
  90     const VclPtr<ScrollAdaptor>& GetVerticalScrollBar() const { return mpVerticalScrollBar;}
  91
  92     /** Return the control of the horizontal scroll bar.
  93     */
  94     const VclPtr<ScrollAdaptor>& GetHorizontalScrollBar() const { return mpHorizontalScrollBar;}
  95
  96     /** Return the content window.  This is a sibling and is geometrically
  97         enclosed by the scroll bars.
  98     */
  99     const VclPtr<sd::Window>& GetContentWindow() const { return mpContentWindow;}
 100
 101     model::SlideSorterModel& GetModel() const;
 102
 103     view::SlideSorterView& GetView() const;
 104
 105     // Exported for unit test
 106     SD_DLLPUBLIC controller::SlideSorterController& GetController() const;
 107
 108     /** Return the view shell that was given at construction.
 109         @return
 110             May be empty.
 111     */
 112     ViewShell* GetViewShell() const { return mpViewShell;}
 113
 114     /** Return the XController object of the main view.
 115     */
 116     css::uno::Reference<css::frame::XController>
 117         GetXController() const;
 118
 119     /** Return the ViewShellBase object.
 120         @return
 121             May be empty.
 122     */
 123     ViewShellBase* GetViewShellBase() const { return mpViewShellBase;}
 124
 125     void Paint (const ::tools::Rectangle& rRepaintArea);
 126
 127     /** Place and size the controls and windows.  You may want to call this
 128         method when something has changed that for instance affects the
 129         visibility state of the scroll bars.
 130     */
 131     void ArrangeGUIElements (
 132         const Point& rOffset,
 133         const Size& rSize);
 134
 135     void RelocateToWindow (vcl::Window* pWindow);
 136
 137     /** Set the current function at the view shell or, when it is not
 138         present, set it at the content window.  This method supports the use
 139         of functions even when there is no SlideSorterViewShell.
 140     */
 141     void SetCurrentFunction (const rtl::Reference<FuPoor>& rpFunction);
 142
 143     /** Return a collection of properties that are used throughout the slide
 144         sorter.
 145     */
 146     std::shared_ptr<controller::Properties> const & GetProperties() const;
 147
 148     /** Return the active theme which gives access to colors and fonts.
 149     */
 150     std::shared_ptr<view::Theme> const & GetTheme() const;
 151
 152 private:
 153     /** This virtual method makes it possible to create a specialization of
 154         the slide sorter view shell that works with its own implementation
 155         of model, view, and controller.  The default implementation simply
 156         calls the CreateModel(), CreateView(), and CreateController()
 157         methods in this order.
 158     */
 159     void CreateModelViewController();
 160
 161     /** Create the model for the view shell.  When called from the default
 162         implementation of CreateModelViewController() then neither view nor
 163         controller do exist.  Test their pointers when in doubt.
 164     */
 165     model::SlideSorterModel* CreateModel();
 166
 167     std::unique_ptr<controller::SlideSorterController> mpSlideSorterController;
 168     std::unique_ptr<model::SlideSorterModel> mpSlideSorterModel;
 169     std::unique_ptr<view::SlideSorterView> mpSlideSorterView;
 170     css::uno::WeakReference<css::frame::XController> mxControllerWeak;
 171     ViewShell* mpViewShell;
 172     ViewShellBase* mpViewShellBase;
 173     VclPtr<sd::Window> mpContentWindow;
 174     VclPtr<ScrollAdaptor> mpHorizontalScrollBar;
 175     VclPtr<ScrollAdaptor> mpVerticalScrollBar;
 176
 177     /** Some slide sorter wide properties that are used in different
 178         classes.
 179     */
 180     std::shared_ptr<controller::Properties> mpProperties;
 181     std::shared_ptr<view::Theme> mpTheme;
 182
 183     SlideSorter (
 184         ViewShell& rViewShell,
 185         sd::Window* pContentWindow,
 186         ScrollAdaptor* pHorizontalScrollBar,
 187         ScrollAdaptor* pVerticalScrollBar);
 188
 189     void Init();
 190     /** Create the controls for the slide sorter.  This are the tab bar
 191        for switching the edit mode, the scroll bar, and the actual
 192        slide sorter view window.
 193        This method is usually called exactly one time from the
 194        constructor.
 195     */
 196     void SetupControls();
 197
 198     /** This method is usually called exactly one time from the
 199         constructor.
 200     */
 201     void SetupListeners();
 202
 203     /** Release the listeners that have been installed in SetupListeners().
 204     */
 205     void ReleaseListeners();
 206 };
 207
 208 } // end of namespace ::sd::slidesorter
 209
 210 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */