vcl/inc/verticaltabctrl.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 <memory>
  23 #include <string_view>
  24
  25 #include <tools/json_writer.hxx>
  26
  27 #include <vcl/dllapi.h>
  28 #include <vcl/toolkit/ivctrl.hxx>
  29 #include <vcl/layout.hxx>
  30
  31 struct VerticalTabPageData;
  32
  33 class VerticalTabControl final : public VclHBox
  34 {
  35     VclPtr<SvtIconChoiceCtrl> m_xChooser;
  36     VclPtr<VclVBox> m_xBox;
  37
  38     std::vector<std::unique_ptr<VerticalTabPageData>> maPageList;
  39     OString m_sCurrentPageId;
  40
  41     Link<VerticalTabControl*, void> m_aActivateHdl;
  42     Link<VerticalTabControl*, bool> m_aDeactivateHdl;
  43
  44     DECL_LINK(ChosePageHdl_Impl, SvtIconChoiceCtrl*, void);
  45
  46     void ActivatePage();
  47     bool DeactivatePage();
  48
  49     VerticalTabPageData* GetPageData(std::string_view rId) const;
  50     VerticalTabPageData* GetPageData(const SvxIconChoiceCtrlEntry* pEntry) const;
  51
  52 public:
  53     VerticalTabControl(vcl::Window* pParent);
  54     virtual ~VerticalTabControl() override;
  55     virtual void dispose() override;
  56
  57     sal_uInt16 GetPageCount() const { return m_xChooser->GetEntryCount(); }
  58
  59     const OString& GetCurPageId() const { return m_sCurrentPageId; }
  60     void SetCurPageId(const OString& rId);
  61
  62     sal_uInt16 GetPagePos(std::string_view rPageId) const;
  63     const OString& GetPageId(sal_uInt16 nIndex) const;
  64     VclPtr<vcl::Window> GetPage(std::string_view rPageId) const;
  65
  66     void RemovePage(std::string_view rPageId);
  67     void InsertPage(const OString& rPageId, const OUString& rLabel, const Image& rImage,
  68                     const OUString& rTooltip, VclPtr<vcl::Window> xPage, int nPos = -1);
  69
  70     void SetActivatePageHdl(const Link<VerticalTabControl*, void>& rLink)
  71     {
  72         m_aActivateHdl = rLink;
  73     }
  74     void SetDeactivatePageHdl(const Link<VerticalTabControl*, bool>& rLink)
  75     {
  76         m_aDeactivateHdl = rLink;
  77     }
  78
  79     OUString GetPageText(std::string_view rPageId) const;
  80     void SetPageText(std::string_view rPageId, const OUString& rText);
  81
  82     vcl::Window* GetPageParent() { return m_xBox.get(); }
  83
  84     virtual void DumpAsPropertyTree(tools::JsonWriter& rJsonWriter) override;
  85
  86     virtual FactoryFunction GetUITestFactory() const override;
  87 };
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */