sd/source/ui/inc/LayerTabBar.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_INC_LAYERTABBAR_HXX
  21 #define INCLUDED_SD_SOURCE_UI_INC_LAYERTABBAR_HXX
  22
  23 #include <svtools/tabbar.hxx>
  24 #include <vcl/transfer.hxx>
  25 #include <sddllapi.h>
  26
  27 namespace sd {
  28
  29 /**
  30  * TabBar for layer administration
  31  */
  32 class DrawViewShell;
  33
  34 class SAL_DLLPUBLIC_RTTI LayerTabBar final
  35     : public TabBar,
  36       public DropTargetHelper
  37 {
  38 public:
  39     LayerTabBar (
  40         DrawViewShell* pDrViewSh,
  41         vcl::Window* pParent);
  42     virtual void dispose() override;
  43     virtual ~LayerTabBar() override;
  44
  45     /** Inform all listeners of this control that the current layer has been
  46         activated.  Call this method after switching the current layer and is
  47         not done elsewhere (like when using ctrl + page up/down keys).
  48     */
  49     void SendActivatePageEvent();
  50
  51     /** Inform all listeners of this control that the current layer has been
  52         deactivated.  Call this method before switching the current layer
  53         and is not done elsewhere (like when using ctrl page up/down keys).
  54     */
  55     void SendDeactivatePageEvent();
  56
  57     // Expects not-localized, real layer name in rText. Generates a localized layer name
  58     // that will be displayed on the tab of the LayerTabBar and writes the real name
  59     // to maAuxiliaryText. In case you want no entry in maAuxiliaryText, use method from TabBar.
  60     virtual void        InsertPage( sal_uInt16 nPageId, const OUString& rText,
  61                                 TabBarPageBits nBits = TabBarPageBits::NONE,
  62                                 sal_uInt16 nPos = TabBar::APPEND ) override;
  63     virtual void        SetPageText( sal_uInt16 nPageId, const OUString& rText ) override;
  64
  65     // Returns the real layer name if exists and empty OUString otherwise.
  66     OUString            GetLayerName(sal_uInt16 nPageId) const;
  67
  68     // Used e.g. in DeleteActualLayer() to test whether deleting is allowed.
  69     static bool IsRealNameOfStandardLayer(const OUString& rName);
  70
  71     // Used e.g. in validity test of user entered names
  72     static bool IsLocalizedNameOfStandardLayer(const OUString& rName);
  73
  74     // In case rName is one of the sUNO_LayerName_*, it generates a localized name,
  75     // otherwise it returns value of rName.
  76     static OUString convertToLocalizedName(const OUString& rName);
  77
  78     // TabBar
  79     virtual void        Select() override;
  80     virtual void        DoubleClick() override;
  81
  82     SD_DLLPUBLIC virtual void MouseButtonDown(const MouseEvent& rMEvt) override; // export for unit test
  83
  84     virtual void        Command(const CommandEvent& rCEvt) override;
  85
  86     virtual bool        StartRenaming() override;
  87     virtual TabBarAllowRenamingReturnCode  AllowRenaming() override;
  88     virtual void        EndRenaming() override;
  89
  90     virtual void        ActivatePage() override;
  91
  92     // DropTargetHelper
  93     virtual sal_Int8    AcceptDrop( const AcceptDropEvent& rEvt ) override;
  94     virtual sal_Int8    ExecuteDrop( const ExecuteDropEvent& rEvt ) override;
  95
  96 private:
  97     DrawViewShell* pDrViewSh;
  98
  99     // Expects not-localized, real layer name in rText and writes it to maAuxiliaryText.
 100     void SetLayerName( sal_uInt16 nPageId, const OUString& rText );
 101 };
 102
 103 } // end of namespace sd
 104
 105 #endif
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */