xref: /AOO41X/main/chart2/source/controller/inc/ObjectHierarchy.hxx (revision de7b3f825c374d9f7270d1282e9d92876f197200)
1*de7b3f82SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*de7b3f82SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*de7b3f82SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*de7b3f82SAndrew Rist  * distributed with this work for additional information
6*de7b3f82SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*de7b3f82SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*de7b3f82SAndrew Rist  * "License"); you may not use this file except in compliance
9*de7b3f82SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*de7b3f82SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*de7b3f82SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*de7b3f82SAndrew Rist  * software distributed under the License is distributed on an
15*de7b3f82SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*de7b3f82SAndrew Rist  * KIND, either express or implied.  See the License for the
17*de7b3f82SAndrew Rist  * specific language governing permissions and limitations
18*de7b3f82SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*de7b3f82SAndrew Rist  *************************************************************/
21*de7b3f82SAndrew Rist 
22*de7b3f82SAndrew Rist 
23cdf0e10cSrcweir #ifndef CHART2_OBJECTHIERARCHY_HXX
24cdf0e10cSrcweir #define CHART2_OBJECTHIERARCHY_HXX
25cdf0e10cSrcweir 
26cdf0e10cSrcweir #include "ObjectIdentifier.hxx"
27cdf0e10cSrcweir 
28cdf0e10cSrcweir #include <rtl/ustring.hxx>
29cdf0e10cSrcweir #include <com/sun/star/chart2/XChartDocument.hpp>
30cdf0e10cSrcweir #include <com/sun/star/awt/KeyEvent.hpp>
31cdf0e10cSrcweir 
32cdf0e10cSrcweir #include <memory>
33cdf0e10cSrcweir #include <vector>
34cdf0e10cSrcweir 
35cdf0e10cSrcweir namespace chart
36cdf0e10cSrcweir {
37cdf0e10cSrcweir 
38cdf0e10cSrcweir class ExplicitValueProvider;
39cdf0e10cSrcweir 
40cdf0e10cSrcweir namespace impl
41cdf0e10cSrcweir {
42cdf0e10cSrcweir class ImplObjectHierarchy;
43cdf0e10cSrcweir }
44cdf0e10cSrcweir 
45cdf0e10cSrcweir class ObjectHierarchy
46cdf0e10cSrcweir {
47cdf0e10cSrcweir public:
48cdf0e10cSrcweir     typedef ObjectIdentifier tOID;
49cdf0e10cSrcweir     typedef ::std::vector< tOID > tChildContainer;
50cdf0e10cSrcweir 
51cdf0e10cSrcweir     /** @param bFlattenDiagram
52cdf0e10cSrcweir             If <TRUE/>, the content of the diaram (data series, wall, floor,
53cdf0e10cSrcweir             etc.) is treated as being at the same level as the diagram. (This is
54cdf0e10cSrcweir             used for keyboard navigation).
55cdf0e10cSrcweir      */
56cdf0e10cSrcweir     explicit ObjectHierarchy(
57cdf0e10cSrcweir         const ::com::sun::star::uno::Reference<
58cdf0e10cSrcweir             ::com::sun::star::chart2::XChartDocument > & xChartDocument,
59cdf0e10cSrcweir         ExplicitValueProvider * pExplicitValueProvider = 0,
60cdf0e10cSrcweir         bool bFlattenDiagram = false,
61cdf0e10cSrcweir         bool bOrderingForElementSelector = false );
62cdf0e10cSrcweir     ~ObjectHierarchy();
63cdf0e10cSrcweir 
64cdf0e10cSrcweir     static tOID      getRootNodeOID();
65cdf0e10cSrcweir     static bool      isRootNode( const tOID& rOID );
66cdf0e10cSrcweir 
67cdf0e10cSrcweir     /// equal to getChildren( getRootNodeOID())
68cdf0e10cSrcweir     tChildContainer  getTopLevelChildren() const;
69cdf0e10cSrcweir     bool             hasChildren( const tOID& rParent ) const;
70cdf0e10cSrcweir     tChildContainer  getChildren( const tOID& rParent ) const;
71cdf0e10cSrcweir 
72cdf0e10cSrcweir     tChildContainer  getSiblings( const tOID& rNode ) const;
73cdf0e10cSrcweir 
74cdf0e10cSrcweir     /// The result is empty, if the node cannot be found in the tree
75cdf0e10cSrcweir     tOID             getParent( const tOID& rNode ) const;
76cdf0e10cSrcweir     /// @returns -1, if no parent can be determined
77cdf0e10cSrcweir     sal_Int32        getIndexInParent( const tOID& rNode ) const;
78cdf0e10cSrcweir 
79cdf0e10cSrcweir private:
80cdf0e10cSrcweir 
81cdf0e10cSrcweir     ::std::auto_ptr< impl::ImplObjectHierarchy > m_apImpl;
82cdf0e10cSrcweir };
83cdf0e10cSrcweir 
84cdf0e10cSrcweir class ObjectKeyNavigation
85cdf0e10cSrcweir {
86cdf0e10cSrcweir public:
87cdf0e10cSrcweir     explicit ObjectKeyNavigation( const ObjectHierarchy::tOID & rCurrentOID,
88cdf0e10cSrcweir                                   const ::com::sun::star::uno::Reference<
89cdf0e10cSrcweir                                       ::com::sun::star::chart2::XChartDocument > & xChartDocument,
90cdf0e10cSrcweir                                   ExplicitValueProvider * pExplicitValueProvider = 0 );
91cdf0e10cSrcweir 
92cdf0e10cSrcweir     bool handleKeyEvent( const ::com::sun::star::awt::KeyEvent & rEvent );
93cdf0e10cSrcweir     ObjectHierarchy::tOID getCurrentSelection() const;
94cdf0e10cSrcweir 
95cdf0e10cSrcweir private:
96cdf0e10cSrcweir     void setCurrentSelection( const ObjectHierarchy::tOID& rOID );
97cdf0e10cSrcweir     bool first();
98cdf0e10cSrcweir     bool last();
99cdf0e10cSrcweir     bool next();
100cdf0e10cSrcweir     bool previous();
101cdf0e10cSrcweir     bool up();
102cdf0e10cSrcweir     bool down();
103cdf0e10cSrcweir     bool veryFirst();
104cdf0e10cSrcweir     bool veryLast();
105cdf0e10cSrcweir 
106cdf0e10cSrcweir     ObjectHierarchy::tOID m_aCurrentOID;
107cdf0e10cSrcweir     ::com::sun::star::uno::Reference<
108cdf0e10cSrcweir             ::com::sun::star::chart2::XChartDocument > m_xChartDocument;
109cdf0e10cSrcweir     ExplicitValueProvider * m_pExplicitValueProvider;
110cdf0e10cSrcweir     bool m_bStepDownInDiagram;
111cdf0e10cSrcweir };
112cdf0e10cSrcweir 
113cdf0e10cSrcweir } //  namespace chart
114cdf0e10cSrcweir 
115cdf0e10cSrcweir // CHART2_OBJECTHIERARCHY_HXX
116cdf0e10cSrcweir #endif
117