include/vcl/builderpage.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
  10 #ifndef INCLUDED_VCL_BUILDERPAGE_HXX
  11 #define INCLUDED_VCL_BUILDERPAGE_HXX
  12
  13 #include <vcl/weld.hxx>
  14
  15 class VCL_DLLPUBLIC BuilderPage
  16 {
  17 public:
  18     BuilderPage(weld::Widget* pParent, weld::DialogController* pController,
  19                 const OUString& rUIXMLDescription, const OUString& rID, bool bIsMobile = false);
  20     virtual ~BuilderPage() COVERITY_NOEXCEPT_FALSE;
  21
  22     /* The title of the page, in an Assistant the dialog may append this page title to the
  23        dialog title.
  24
  25        While in a Dialog hosting a single Page it may use the title as
  26        the dialog title.
  27     */
  28     void SetPageTitle(const OUString& rPageTitle) { m_aPageTitle = rPageTitle; }
  29     const OUString& GetPageTitle() const { return m_aPageTitle; }
  30
  31     // In a Notebook or Assistant the controller typically calls Activate on entering
  32     // this page, and Deactivate on leaving
  33     virtual void Activate();
  34     virtual void Deactivate();
  35
  36     void SetHelpId(const OUString& rHelpId) { m_xContainer->set_help_id(rHelpId); }
  37     OUString GetHelpId() const { return m_xContainer->get_help_id(); }
  38
  39 protected:
  40     weld::DialogController* m_pDialogController;
  41     std::unique_ptr<weld::Builder> m_xBuilder;
  42     std::unique_ptr<weld::Container> m_xContainer;
  43
  44 private:
  45     OUString m_aPageTitle;
  46 };
  47
  48 #endif
  49
  50 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */