basctl/source/inc/ObjectCatalog.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 "bastype2.hxx"
  23 #include "bastypes.hxx"
  24
  25 #include <vcl/weld.hxx>
  26
  27 namespace basctl
  28 {
  29 /*!
  30  *  @brief A docking window that contains a tree of the currently loaded macros
  31  *
  32  *  The class creates Object Catalog window with the currently loaded macros
  33  *  in a tree structure which allows user to quickly select the necessary
  34  *  macro in BasicIDE.
  35  */
  36 class ObjectCatalog : public DockingWindow
  37 {
  38 public:
  39     explicit ObjectCatalog(vcl::Window* pParent);
  40     virtual ~ObjectCatalog() override;
  41     virtual void dispose() override;
  42
  43     ///  Update the entries of Object Catalog Treelist
  44     void UpdateEntries() { m_xTree->UpdateEntries(); }
  45     void SetCurrentEntry(BaseWindow* pCurWin);
  46
  47 private:
  48     std::unique_ptr<weld::Label> m_xTitle; ///< Title of the Object Catalog window
  49     std::unique_ptr<SbTreeListBox> m_xTree; ///< The Treelist of the objects in window
  50
  51     /*!
  52      *  Function for resize by DockingWindow.
  53      *  It is called by DockingWindow when IsFloatingMode() changes.
  54      */
  55     virtual void ToggleFloatingMode() override;
  56 };
  57
  58 } // namespace basctl
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */