svx/source/inc/formtoolbars.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_SVX_SOURCE_INC_FORMTOOLBARS_HXX
  21 #define INCLUDED_SVX_SOURCE_INC_FORMTOOLBARS_HXX
  22
  23 #include "fmdocumentclassification.hxx"
  24 #include <com/sun/star/frame/XLayoutManager.hpp>
  25 #include <svx/svxdllapi.h>
  26
  27 namespace svxform
  28 {
  29     class FormToolboxes
  30     {
  31     private:
  32         ::com::sun::star::uno::Reference< ::com::sun::star::frame::XLayoutManager >
  33                         m_xLayouter;
  34
  35     public:
  36         /** constructs an instance
  37             @param _rxFrame
  38                 the frame to analyze
  39         */
  40         SVX_DLLPUBLIC FormToolboxes(
  41             const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& _rxFrame
  42         );
  43
  44     public:
  45         /** retrieves the URI for the toolbox associated with the given slot, depending
  46             on the type of our document
  47         */
  48         SVX_DLLPUBLIC OUString
  49                 getToolboxResourceName( sal_uInt16 _nSlotId ) const;
  50
  51         /** toggles the toolbox associated with the given slot
  52         */
  53         SVX_DLLPUBLIC void    toggleToolbox( sal_uInt16 _nSlotId ) const;
  54
  55         /** determines whether the toolbox associated with the given slot is currently visible
  56         */
  57         SVX_DLLPUBLIC bool    isToolboxVisible( sal_uInt16 _nSlotId ) const;
  58
  59         /** ensures that a given toolbox is visible
  60         */
  61         inline void showToolbox( sal_uInt16 _SlotId ) const
  62         {
  63             if ( !isToolboxVisible( _SlotId ) )
  64                 toggleToolbox( _SlotId );
  65         }
  66     };
  67
  68 }
  69
  70 #endif // INCLUDED_SVX_SOURCE_INC_FORMTOOLBARS_HXX
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */