include/svx/DiagramDataInterface.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 #ifndef INCLUDED_SVX_DIAGRAMDATAINTERFACE_HXX
  20 #define INCLUDED_SVX_DIAGRAMDATAINTERFACE_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include <sal/types.h>
  24
  25 #include <utility>
  26 #include <vector>
  27
  28 /// Interface class to access diagram data for UI
  29 class SAL_NO_VTABLE SAL_DLLPUBLIC_RTTI DiagramDataInterface
  30 {
  31 public:
  32     // get text representation of data tree
  33     virtual OUString getString() const = 0;
  34
  35     // get children of provided data node
  36     // use empty string for top-level nodes
  37     // returns vector of (id, text)
  38     virtual std::vector<std::pair<OUString, OUString>>
  39     getChildren(const OUString& rParentId) const = 0;
  40
  41     // add new top-level node to data model, returns its id
  42     virtual OUString addNode(const OUString& rText) = 0;
  43
  44     virtual bool removeNode(const OUString& rNodeId) = 0;
  45
  46 protected:
  47     ~DiagramDataInterface() noexcept {}
  48 };
  49
  50 #endif // INCLUDED_SVX_DIAGRAMDATAINTERFACE_HXX
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */