sd/source/ui/sidebar/LayoutMenu.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 #ifndef INCLUDED_SD_SOURCE_UI_SIDEBAR_LAYOUTMENU_HXX
  21 #define INCLUDED_SD_SOURCE_UI_SIDEBAR_LAYOUTMENU_HXX
  22
  23 #include <sfx2/sidebar/ILayoutableWindow.hxx>
  24
  25 #include <svtools/valueset.hxx>
  26 #include <vcl/transfer.hxx>
  27 #include <sfx2/shell.hxx>
  28 #include <xmloff/autolayout.hxx>
  29
  30 namespace com { namespace sun { namespace star { namespace frame { class XStatusListener; } } } }
  31 namespace com { namespace sun { namespace star { namespace ui { class XSidebar; } } } }
  32
  33
  34 namespace sd {
  35 class DrawDocShell;
  36 class ViewShellBase;
  37 }
  38
  39 namespace sd { namespace tools {
  40 class EventMultiplexerEvent;
  41 } }
  42
  43 namespace sd { namespace sidebar {
  44
  45 class LayoutMenu
  46     : public ValueSet,
  47       public DragSourceHelper,
  48       public DropTargetHelper,
  49       public sfx2::sidebar::ILayoutableWindow
  50 {
  51 public:
  52     /** Create a new layout menu.  Depending on the given flag it
  53         displays its own scroll bar or lets a surrounding window
  54         handle that.
  55         @param i_pParent
  56             the parent node in the control tree
  57         @param i_rPanelViewShell
  58             the view shell of the task pane.
  59     */
  60     LayoutMenu (
  61         vcl::Window* pParent,
  62         ViewShellBase& rViewShellBase,
  63         const css::uno::Reference<css::ui::XSidebar>& rxSidebar);
  64     virtual ~LayoutMenu() override;
  65     virtual void dispose() override;
  66
  67     void Dispose();
  68
  69     /** Return a numerical value representing the currently selected
  70         layout.
  71     */
  72     AutoLayout GetSelectedAutoLayout();
  73
  74     // From ILayoutableWindow
  75     virtual css::ui::LayoutSize GetHeightForWidth (const sal_Int32 nWidth) override;
  76
  77     // From vcl::Window
  78     virtual void Resize() override;
  79
  80     /** Show a context menu when the right mouse button is pressed.
  81     */
  82     virtual void MouseButtonDown (const MouseEvent& rEvent) override;
  83
  84     /** Call this method when the set of displayed layouts is not up-to-date
  85         anymore.  It will re-assemble this set according to the current
  86         settings.
  87     */
  88     void InvalidateContent();
  89
  90     // DragSourceHelper
  91     virtual void StartDrag (sal_Int8 nAction, const Point& rPosPixel) override;
  92
  93     // DropTargetHelper
  94     virtual sal_Int8 AcceptDrop (const AcceptDropEvent& rEvent) override;
  95     virtual sal_Int8 ExecuteDrop (const ExecuteDropEvent& rEvent) override;
  96
  97     /** The context menu is requested over this Command() method.
  98     */
  99     virtual void Command (const CommandEvent& rEvent) override;
 100
 101     /** Call Fill() when switching to or from high contrast mode so that the
 102         correct set of icons is displayed.
 103     */
 104     virtual void DataChanged (const DataChangedEvent& rEvent) override;
 105
 106     using Window::GetWindow;
 107     using ValueSet::StartDrag;
 108
 109 private:
 110     ViewShellBase& mrBase;
 111
 112     /** If we are asked for the preferred window size, then use this
 113         many columns for the calculation.
 114     */
 115     css::uno::Reference<css::frame::XStatusListener> mxListener;
 116     bool mbIsMainViewChangePending;
 117     css::uno::Reference<css::ui::XSidebar> mxSidebar;
 118     bool mbIsDisposed;
 119
 120     /** Calculate the number of displayed rows.  This depends on the given
 121         item size, the given number of columns, and the size of the
 122         control.  Note that this is not the number of rows managed by the
 123         valueset.  This number may be larger.  In that case a vertical
 124         scroll bar is displayed.
 125     */
 126     int CalculateRowCount (const Size& rItemSize, int nColumnCount);
 127
 128     /** Fill the value set with the layouts that are applicable to the
 129         current main view shell.
 130     */
 131     void Fill();
 132
 133     /** Remove all items from the value set.
 134     */
 135     void Clear();
 136
 137     /** Assign the given layout to all selected slides of a slide sorter.
 138         If no slide sorter is active then this call is ignored.  The slide
 139         sorter in the center pane is preferred if the choice exists.
 140     */
 141     void AssignLayoutToSelectedSlides (AutoLayout aLayout);
 142
 143     /** Insert a new page with the given layout.  The page is inserted via
 144         the main view shell, i.e. its SID_INSERTPAGE slot is called. If it
 145         does not support this slot then inserting a new page does not take
 146         place.  The new page is inserted after the currently active one (the
 147         one returned by ViewShell::GetActualPage().)
 148     */
 149     void InsertPageWithLayout (AutoLayout aLayout);
 150
 151     /** Create a request structure that can be used with the SID_INSERTPAGE
 152         and SID_MODIFYPAGE slots.  The parameters are set so that the given
 153         layout is assigned to the current page of the main view shell.
 154         @param nSlotId
 155             Supported slots are SID_INSERTPAGE and SID_MODIFYPAGE.
 156         @param aLayout
 157             Layout of the page to insert or to assign.
 158     */
 159     SfxRequest CreateRequest (
 160         sal_uInt16 nSlotId,
 161         AutoLayout aLayout);
 162
 163     /** Select the layout that is used by the current page.
 164     */
 165     void UpdateSelection();
 166
 167     // internal ctor
 168     void    implConstruct( DrawDocShell& rDocumentShell );
 169
 170     /** When clicked then set the current page of the view in the center pane.
 171     */
 172     DECL_LINK(ClickHandler, ValueSet*, void);
 173     DECL_LINK(StateChangeHandler, const OUString&, void);
 174     DECL_LINK(EventMultiplexerListener, ::sd::tools::EventMultiplexerEvent&, void);
 175     DECL_LINK(WindowEventHandler, VclWindowEvent&, void);
 176     DECL_LINK(OnMenuItemSelected, Menu*, bool);
 177 };
 178
 179 } } // end of namespace ::sd::toolpanel
 180
 181 #endif
 182
 183 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */