framework/inc/xml/imagesconfiguration.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 <com/sun/star/io/XInputStream.hpp>
  23 #include <com/sun/star/io/XOutputStream.hpp>
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25
  26 #include <vector>
  27
  28 namespace framework
  29 {
  30
  31 struct ImageItemDescriptor
  32 {
  33     // index of the bitmap inside the bitmaplist; not required currently, but was mandatory
  34     // previously, so needs to be written for backward compatibility
  35     long nIndex = -1;
  36     OUString  aCommandURL;                // URL command to dispatch
  37 };
  38
  39 struct ImageItemDescriptorList
  40 {
  41     // a URL to a bitmap with several images inside; not required currently, but was mandatory
  42     // previously, so needs to be written for backward compatibility
  43     OUString aURL;
  44     std::vector<ImageItemDescriptor> aImageItemDescriptors;
  45 };
  46
  47 class ImagesConfiguration
  48 {
  49     public:
  50         static bool LoadImages(
  51             const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  52             const css::uno::Reference< css::io::XInputStream >& rInputStream,
  53             ImageItemDescriptorList& rItems );
  54
  55         static bool StoreImages(
  56             const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  57             const css::uno::Reference< css::io::XOutputStream >& rOutputStream,
  58             const ImageItemDescriptorList& rItems );
  59 };
  60
  61 } // namespace framework
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */