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 #ifndef INCLUDED_SC_SOURCE_UI_VBA_VBASHEETOBJECTS_HXX
  21 #define INCLUDED_SC_SOURCE_UI_VBA_VBASHEETOBJECTS_HXX
  22
  23 #include <ooo/vba/excel/XGraphicObjects.hpp>
  24 #include <vbahelper/vbacollectionimpl.hxx>
  25 #include <rtl/ref.hxx>
  26
  27 namespace com { namespace sun { namespace 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     explicit ScVbaSheetObjectsBase( const ScVbaObjectContainerRef& rxContainer ) throw (css::uno::RuntimeException);
  45     virtual ~ScVbaSheetObjectsBase();
  46
  47     /** Updates the collection by fetching all shapes from the draw page. */
  48     void collectShapes() throw (css::uno::RuntimeException);
  49
  50     // XEnumerationAccess
  51     virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createEnumeration() throw (css::uno::RuntimeException) SAL_OVERRIDE;
  52
  53     // XElementAccess
  54     virtual css::uno::Type SAL_CALL getElementType() throw (css::uno::RuntimeException) SAL_OVERRIDE;
  55
  56     // ScVbaCollectionBase
  57     virtual css::uno::Any createCollectionObject( const css::uno::Any& rSource ) SAL_OVERRIDE;
  58     virtual css::uno::Any getItemByStringIndex( const OUString& rIndex ) throw (css::uno::RuntimeException) SAL_OVERRIDE;
  59
  60 protected:
  61     ScVbaObjectContainerRef mxContainer;
  62 };
  63
  64 typedef ::cppu::ImplInheritanceHelper1< ScVbaSheetObjectsBase, ov::excel::XGraphicObjects > ScVbaGraphicObjects_BASE;
  65
  66 /** Base class for collections containing a specific type of graphic object
  67     from a sheet.
  68  */
  69 class ScVbaGraphicObjectsBase : public ScVbaGraphicObjects_BASE
  70 {
  71 public:
  72     explicit ScVbaGraphicObjectsBase( const ScVbaObjectContainerRef& rxContainer ) throw (css::uno::RuntimeException);
  73
  74     // XGraphicObjects
  75     virtual css::uno::Any SAL_CALL Add(
  76         const css::uno::Any& rLeft,
  77         const css::uno::Any& rTop,
  78         const css::uno::Any& rWidth,
  79         const css::uno::Any& rHeight ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  80 };
  81
  82 /** Collection containing all button controls from a sheet (not ActiveX controls). */
  83 class ScVbaButtons : public ScVbaGraphicObjectsBase
  84 {
  85 public:
  86     explicit ScVbaButtons(
  87         const css::uno::Reference< ov::XHelperInterface >& rxParent,
  88         const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  89         const css::uno::Reference< css::frame::XModel >& rxModel,
  90         const css::uno::Reference< css::sheet::XSpreadsheet >& rxSheet ) throw (css::uno::RuntimeException);
  91
  92     VBAHELPER_DECL_XHELPERINTERFACE
  93 };
  94
  95 #endif
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */