sd/source/ui/inc/SlideSorter.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SlideSorter.hxx,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef SD_SLIDESORTER_SLIDE_SORTER_HXX
  33 #define SD_SLIDESORTER_SLIDE_SORTER_HXX
  34
  35 #include "fupoor.hxx"
  36 #include <com/sun/star/frame/XController.hpp>
  37 #include <cppuhelper/weakref.hxx>
  38 #include <sfx2/viewfrm.hxx>
  39 #include <boost/noncopyable.hpp>
  40 #include <boost/shared_ptr.hpp>
  41 #include <boost/scoped_ptr.hpp>
  42
  43 class ScrollBar;
  44 class ScrollBarBox;
  45 class Window;
  46
  47
  48 namespace sd {
  49 class ViewShell;
  50 class ViewShellBase;
  51 class Window;
  52 }
  53
  54 namespace sd { namespace slidesorter { namespace model {
  55 class SlideSorterModel;
  56 } } }
  57
  58 namespace sd { namespace slidesorter { namespace view {
  59 class SlideSorterView;
  60 } } }
  61
  62 namespace sd { namespace slidesorter { namespace controller {
  63 class Listener;
  64 class SlideSorterController;
  65 class SlotManager;
  66 } } }
  67
  68
  69 namespace sd { namespace slidesorter {
  70
  71
  72 /** Show previews for all the slides in a document and allow the user to
  73     insert or delete slides and modify the order of the slides.
  74
  75     This class is a facade for the model, view, and controller classes.
  76     It is a hub that allows access to the various parts of a slide sorter.
  77
  78     Note that this class is not in its final state.
  79 */
  80 class SlideSorter
  81     : private ::boost::noncopyable
  82 {
  83     friend class controller::SlotManager;
  84 public:
  85     virtual ~SlideSorter (void);
  86
  87     /** Return whether the called SlideSorter object is valid and calling
  88         its Get(Model,View,Controller) methods is safe.  When <FALSE/> is
  89         called then no other methods should be called.
  90         Calling this method should be necessary only during startup and
  91         shutdown (when that can be detected).
  92     */
  93     bool IsValid (void) const;
  94
  95     /** Create a new slide sorter that is strongly coupled to the given view
  96         shell.  Use this function for a slide sorter in the left pane.
  97         @param rViewShell
  98             Typically a SlideSorterViewShell object.
  99         @param rpContentWindow
 100             Typically the content window of the ViewShell.
 101         @param rpHorizontalScrollBar
 102             Typically the horizontal scroll bar of the ViewShell.
 103         @param rpVerticalScrollBar
 104             Typically the vertical scroll bar of the ViewShell.
 105         @param rpScrollBarBox
 106             The little square enclosed by the two scroll bars.  Typically
 107             the one from the ViewShell.
 108     */
 109     static ::boost::shared_ptr<SlideSorter> CreateSlideSorter (
 110         ViewShell& rViewShell,
 111         const ::boost::shared_ptr<sd::Window>& rpContentWindow,
 112         const ::boost::shared_ptr<ScrollBar>& rpHorizontalScrollBar,
 113         const ::boost::shared_ptr<ScrollBar>& rpVerticalScrollBar,
 114         const ::boost::shared_ptr<ScrollBarBox>& rpScrollBarBox);
 115
 116     /** Create a new slide sorter that is losely coupled to the given view
 117         shell.  The view shell may even be missing.
 118         @param rBase
 119             ViewShellBase object of the enclosing application.
 120         @param pViewShell
 121             Supply when at hand.
 122         @param rParentWindow
 123             The parent window of the internally created content window and
 124             scroll bars.
 125     */
 126     static ::boost::shared_ptr<SlideSorter> CreateSlideSorter (
 127         ViewShellBase& rBase,
 128         ViewShell* pViewShell,
 129         ::Window& rParentWindow);
 130
 131     /** Return the control of the vertical scroll bar.
 132     */
 133     ::boost::shared_ptr<ScrollBar> GetVerticalScrollBar (void) const;
 134
 135     /** Return the control of the horizontal scroll bar.
 136     */
 137     ::boost::shared_ptr<ScrollBar> GetHorizontalScrollBar (void) const;
 138
 139     /** Return the scroll bar filler that paints the little square that is
 140         enclosed by the two scroll bars.
 141     */
 142     ::boost::shared_ptr<ScrollBarBox> GetScrollBarFiller (void) const;
 143
 144     /** Return the content window.  This is a sibling and is geometrically
 145         enclosed by the scroll bars.
 146     */
 147     ::boost::shared_ptr<sd::Window> GetContentWindow (void) const;
 148
 149     /** Return the active window as it is returned by a view shell.
 150         Typically the content window.
 151     */
 152     ::sd::Window* GetActiveWindow (void) const;
 153
 154     model::SlideSorterModel& GetModel (void) const;
 155
 156     view::SlideSorterView& GetView (void) const;
 157
 158     controller::SlideSorterController& GetController (void) const;
 159
 160     /** Return the view shell that was given at construction.
 161         @return
 162             May be empty.
 163     */
 164     ViewShell* GetViewShell (void) const;
 165
 166     /** Return the XController object of the main view.
 167     */
 168     ::com::sun::star::uno::Reference<com::sun::star::frame::XController>
 169         GetXController (void) const;
 170
 171     /** Return the ViewShellBase object.
 172         @return
 173             May be empty.
 174     */
 175     ViewShellBase* GetViewShellBase (void) const;
 176
 177     void Paint (const Rectangle& rRepaintArea);
 178
 179     /** Place and size the controls and windows.  You may want to call this
 180         method when something has changed that for instance affects the
 181         visibility state of the scroll bars.
 182     */
 183     void ArrangeGUIElements (
 184         const Point& rOffset,
 185         const Size& rSize);
 186     SvBorder GetBorder (void);
 187
 188     bool RelocateToWindow (::Window* pWindow);
 189
 190     /** Set the current function at the view shell or, when it is not
 191         present, set it at the content window.  This method supports the use
 192         of functions even when there is no SlideSorterViewShell.
 193     */
 194     void SetCurrentFunction (const FunctionReference& rpFunction);
 195
 196 protected:
 197     /** This virtual method makes it possible to create a specialization of
 198         the slide sorter view shell that works with its own implementation
 199         of model, view, and controller.  The default implementation simply
 200         calls the CreateModel(), CreateView(), and CreateController()
 201         methods in this order.
 202     */
 203     virtual void CreateModelViewController (void);
 204
 205     /** Create the model for the view shell.  When called from the default
 206         implementation of CreateModelViewController() then neither view nor
 207         controller do exist.  Test their pointers when in doubt.
 208     */
 209     virtual model::SlideSorterModel* CreateModel (void);
 210
 211     /** Create the view for the view shell.  When called from the default
 212         implementation of CreateModelViewController() then the model but not
 213         the controller does exist.  Test their pointers when in doubt.
 214     */
 215     virtual view::SlideSorterView* CreateView (void);
 216
 217     /** Create the controller for the view shell.  When called from the default
 218         implementation of CreateModelViewController() then both the view and
 219         the controller do exist.  Test their pointers when in doubt.
 220     */
 221     virtual controller::SlideSorterController* CreateController (void);
 222
 223 private:
 224     bool mbIsValid;
 225
 226     ::boost::scoped_ptr<controller::SlideSorterController> mpSlideSorterController;
 227     ::boost::scoped_ptr<model::SlideSorterModel> mpSlideSorterModel;
 228     ::boost::scoped_ptr<view::SlideSorterView> mpSlideSorterView;
 229     ::com::sun::star::uno::WeakReference<com::sun::star::frame::XController> mxControllerWeak;
 230     ViewShell* mpViewShell;
 231     ViewShellBase* mpViewShellBase;
 232     ::boost::shared_ptr<sd::Window> mpContentWindow;
 233     ::boost::shared_ptr<ScrollBar> mpHorizontalScrollBar;
 234     ::boost::shared_ptr<ScrollBar> mpVerticalScrollBar;
 235     ::boost::shared_ptr<ScrollBarBox> mpScrollBarBox;
 236
 237     /** Set this flag to <TRUE/> to force a layout before the next paint.
 238     */
 239     bool mbLayoutPending;
 240
 241
 242     SlideSorter (
 243         ViewShell& rViewShell,
 244         const ::boost::shared_ptr<sd::Window>& rpContentWindow,
 245         const ::boost::shared_ptr<ScrollBar>& rpHorizontalScrollBar,
 246         const ::boost::shared_ptr<ScrollBar>& rpVerticalScrollBar,
 247         const ::boost::shared_ptr<ScrollBarBox>& rpScrollBarBox);
 248     SlideSorter (
 249         ViewShellBase& rBase,
 250         ViewShell* pViewShell,
 251         ::Window& rParentWindow);
 252
 253     void Init (void);
 254     /** Create the controls for the slide sorter.  This are the tab bar
 255        for switching the edit mode, the scroll bar, and the actual
 256        slide sorter view window.
 257        This method is usually called exactly one time from the
 258        constructor.
 259     */
 260     void SetupControls (::Window* pParentWindow);
 261
 262     /** This method is usually called exactly one time from the
 263         constructor.
 264     */
 265     void SetupListeners (void);
 266
 267     /** Release the listeners that have been installed in SetupListeners().
 268     */
 269     void ReleaseListeners (void);
 270 };
 271
 272 } } // end of namespace ::sd::slidesorter
 273
 274 #endif