chart2/source/controller/inc/ObjectHierarchy.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 #pragma once
  20
  21 #include <ChartModel.hxx>
  22 #include <ObjectIdentifier.hxx>
  23 #include <map>
  24 #include <vector>
  25
  26 namespace com::sun::star::awt { struct KeyEvent; }
  27 namespace com::sun::star::chart2 { class XChartDocument; }
  28
  29 namespace chart
  30 {
  31
  32 class ExplicitValueProvider;
  33
  34 class ObjectHierarchy
  35 {
  36 public:
  37     typedef std::vector< ObjectIdentifier > tChildContainer;
  38
  39     /** @param bFlattenDiagram
  40             If <TRUE/>, the content of the diagram (data series, wall, floor,
  41             etc.) is treated as being at the same level as the diagram. (This is
  42             used for keyboard navigation).
  43      */
  44     explicit ObjectHierarchy(
  45         const rtl::Reference<::chart::ChartModel> & xChartDocument,
  46         ExplicitValueProvider * pExplicitValueProvider,
  47         bool bFlattenDiagram = false,
  48         bool bOrderingForElementSelector = false );
  49     ~ObjectHierarchy();
  50
  51     static ObjectIdentifier      getRootNodeOID();
  52     static bool      isRootNode( const ObjectIdentifier& rOID );
  53
  54     /// equal to getChildren( getRootNodeOID())
  55     const tChildContainer& getTopLevelChildren() const;
  56     bool hasChildren(const ObjectIdentifier& rParent) const;
  57     const tChildContainer& getChildren(const ObjectIdentifier& rParent) const;
  58     const tChildContainer& getSiblings(const ObjectIdentifier& rNode) const;
  59
  60     /// The result is empty, if the node cannot be found in the tree
  61     ObjectIdentifier             getParent( const ObjectIdentifier& rNode ) const;
  62     /// @returns -1, if no parent can be determined
  63     sal_Int32        getIndexInParent( const ObjectIdentifier& rNode ) const;
  64
  65 private:
  66     void createTree( const rtl::Reference<::chart::ChartModel> & xChartDocument );
  67     void createAxesTree(
  68         tChildContainer & rContainer,
  69         const rtl::Reference<::chart::ChartModel> & xChartDoc,
  70         const rtl::Reference< ::chart::Diagram > & xDiagram  );
  71     void createDiagramTree(
  72         tChildContainer& rContainer,
  73         const rtl::Reference<::chart::ChartModel>& xChartDoc,
  74         const rtl::Reference< ::chart::Diagram >& xDiagram );
  75     void createDataSeriesTree(
  76         tChildContainer & rOutDiagramSubContainer,
  77         const rtl::Reference< ::chart::Diagram > & xDiagram );
  78     static void createWallAndFloor(
  79         tChildContainer & rContainer,
  80         const rtl::Reference< ::chart::Diagram > & xDiagram );
  81     void createLegendTree(
  82         tChildContainer & rContainer,
  83         const rtl::Reference<::chart::ChartModel> & xChartDoc,
  84         const rtl::Reference< ::chart::Diagram > & xDiagram  );
  85     void createAdditionalShapesTree(tChildContainer& rContainer);
  86     ObjectIdentifier getParentImpl(
  87         const ObjectIdentifier& rParentOID,
  88         const ObjectIdentifier& rOID ) const;
  89
  90     typedef std::map<ObjectIdentifier, tChildContainer> tChildMap;
  91     tChildMap m_aChildMap;
  92     ExplicitValueProvider* m_pExplicitValueProvider;
  93     bool m_bFlattenDiagram;
  94     bool m_bOrderingForElementSelector;
  95 };
  96
  97 class ObjectKeyNavigation
  98 {
  99 public:
 100     explicit ObjectKeyNavigation( ObjectIdentifier aCurrentOID,
 101                                   rtl::Reference<::chart::ChartModel> xChartDocument,
 102                                   ExplicitValueProvider * pExplicitValueProvider );
 103
 104     bool handleKeyEvent( const css::awt::KeyEvent & rEvent );
 105     const ObjectIdentifier& getCurrentSelection() const { return m_aCurrentOID;}
 106
 107 private:
 108     void setCurrentSelection( const ObjectIdentifier& rOID );
 109     bool first();
 110     bool last();
 111     bool next();
 112     bool previous();
 113     bool up();
 114     bool down();
 115     bool veryFirst();
 116     bool veryLast();
 117
 118     ObjectIdentifier m_aCurrentOID;
 119     rtl::Reference<::chart::ChartModel> m_xChartDocument;
 120     ExplicitValueProvider * m_pExplicitValueProvider;
 121 };
 122
 123 } //  namespace chart
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */