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 <ObjectIdentifier.hxx>
  22
  23 namespace com::sun::star::awt { struct KeyEvent; }
  24 namespace com::sun::star::chart2 { class XChartDocument; }
  25
  26 #include <memory>
  27 #include <vector>
  28
  29 namespace chart
  30 {
  31
  32 class ExplicitValueProvider;
  33
  34 namespace impl
  35 {
  36 class ImplObjectHierarchy;
  37 }
  38
  39 class ObjectHierarchy
  40 {
  41 public:
  42     typedef std::vector< ObjectIdentifier > tChildContainer;
  43
  44     /** @param bFlattenDiagram
  45             If <TRUE/>, the content of the diagram (data series, wall, floor,
  46             etc.) is treated as being at the same level as the diagram. (This is
  47             used for keyboard navigation).
  48      */
  49     explicit ObjectHierarchy(
  50         const css::uno::Reference< css::chart2::XChartDocument > & xChartDocument,
  51         ExplicitValueProvider * pExplicitValueProvider,
  52         bool bFlattenDiagram = false,
  53         bool bOrderingForElementSelector = false );
  54     ~ObjectHierarchy();
  55
  56     static ObjectIdentifier      getRootNodeOID();
  57     static bool      isRootNode( const ObjectIdentifier& rOID );
  58
  59     /// equal to getChildren( getRootNodeOID())
  60     tChildContainer  getTopLevelChildren() const;
  61     bool             hasChildren( const ObjectIdentifier& rParent ) const;
  62     tChildContainer  getChildren( const ObjectIdentifier& rParent ) const;
  63
  64     tChildContainer  getSiblings( const ObjectIdentifier& rNode ) const;
  65
  66     /// The result is empty, if the node cannot be found in the tree
  67     ObjectIdentifier             getParent( const ObjectIdentifier& rNode ) const;
  68     /// @returns -1, if no parent can be determined
  69     sal_Int32        getIndexInParent( const ObjectIdentifier& rNode ) const;
  70
  71 private:
  72
  73     std::unique_ptr< impl::ImplObjectHierarchy > m_apImpl;
  74 };
  75
  76 class ObjectKeyNavigation
  77 {
  78 public:
  79     explicit ObjectKeyNavigation( const ObjectIdentifier & rCurrentOID,
  80                                   const css::uno::Reference< css::chart2::XChartDocument > & xChartDocument,
  81                                   ExplicitValueProvider * pExplicitValueProvider );
  82
  83     bool handleKeyEvent( const css::awt::KeyEvent & rEvent );
  84     const ObjectIdentifier& getCurrentSelection() const { return m_aCurrentOID;}
  85
  86 private:
  87     void setCurrentSelection( const ObjectIdentifier& rOID );
  88     bool first();
  89     bool last();
  90     bool next();
  91     bool previous();
  92     bool up();
  93     bool down();
  94     bool veryFirst();
  95     bool veryLast();
  96
  97     ObjectIdentifier m_aCurrentOID;
  98     css::uno::Reference< css::chart2::XChartDocument > m_xChartDocument;
  99     ExplicitValueProvider * m_pExplicitValueProvider;
 100 };
 101
 102 } //  namespace chart
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */