sc/source/ui/vba/vbasheetobjects.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 <cppuhelper/implbase.hxx>
  23 #include <ooo/vba/excel/XGraphicObjects.hpp>
  24 #include <vbahelper/vbacollectionimpl.hxx>
  25 #include <rtl/ref.hxx>
  26
  27 namespace com::sun::star {
  28     namespace container { class XEnumeration; }
  29     namespace frame { class XModel; }
  30     namespace sheet { class XSpreadsheet; }
  31 }
  32
  33 class ScVbaObjectContainer;
  34 typedef ::rtl::Reference< ScVbaObjectContainer > ScVbaObjectContainerRef;
  35
  36 typedef CollTestImplHelper< ov::XCollection > ScVbaSheetObjects_BASE;
  37
  38 /** Base class for collections containing a specific type of drawing object
  39     embedded in a sheet (worksheet, chart sheet, or dialog sheet).
  40  */
  41 class ScVbaSheetObjectsBase : public ScVbaSheetObjects_BASE
  42 {
  43 public:
  44     /// @throws css::uno::RuntimeException
  45     explicit ScVbaSheetObjectsBase( const ScVbaObjectContainerRef& rxContainer );
  46     virtual ~ScVbaSheetObjectsBase() override;
  47
  48     /** Updates the collection by fetching all shapes from the draw page.
  49
  50         @throws css::uno::RuntimeException
  51     */
  52     void collectShapes();
  53
  54     // XEnumerationAccess
  55     virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createEnumeration() override;
  56
  57     // XElementAccess
  58     virtual css::uno::Type SAL_CALL getElementType() override;
  59
  60     // ScVbaCollectionBase
  61     virtual css::uno::Any createCollectionObject( const css::uno::Any& rSource ) override;
  62     virtual css::uno::Any getItemByStringIndex( const OUString& rIndex ) override;
  63
  64 protected:
  65     ScVbaObjectContainerRef mxContainer;
  66 };
  67
  68 typedef ::cppu::ImplInheritanceHelper< ScVbaSheetObjectsBase, ov::excel::XGraphicObjects > ScVbaGraphicObjects_BASE;
  69
  70 /** Base class for collections containing a specific type of graphic object
  71     from a sheet.
  72  */
  73 class ScVbaGraphicObjectsBase : public ScVbaGraphicObjects_BASE
  74 {
  75 public:
  76     /// @throws css::uno::RuntimeException
  77     explicit ScVbaGraphicObjectsBase( const ScVbaObjectContainerRef& rxContainer );
  78
  79     // XGraphicObjects
  80     virtual css::uno::Any SAL_CALL Add(
  81         const css::uno::Any& rLeft,
  82         const css::uno::Any& rTop,
  83         const css::uno::Any& rWidth,
  84         const css::uno::Any& rHeight ) override;
  85 };
  86
  87 /** Collection containing all button controls from a sheet (not ActiveX controls). */
  88 class ScVbaButtons : public ScVbaGraphicObjectsBase
  89 {
  90 public:
  91     /// @throws css::uno::RuntimeException
  92     explicit ScVbaButtons(
  93         const css::uno::Reference< ov::XHelperInterface >& rxParent,
  94         const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  95         const css::uno::Reference< css::frame::XModel >& rxModel,
  96         const css::uno::Reference< css::sheet::XSpreadsheet >& rxSheet,
  97         bool bOptionButtons);
  98
  99     VBAHELPER_DECL_XHELPERINTERFACE
 100 };
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */