xref: /AOO41X/main/chart2/source/controller/inc/ObjectHierarchy.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir #ifndef CHART2_OBJECTHIERARCHY_HXX
28*cdf0e10cSrcweir #define CHART2_OBJECTHIERARCHY_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include "ObjectIdentifier.hxx"
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir #include <rtl/ustring.hxx>
33*cdf0e10cSrcweir #include <com/sun/star/chart2/XChartDocument.hpp>
34*cdf0e10cSrcweir #include <com/sun/star/awt/KeyEvent.hpp>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir #include <memory>
37*cdf0e10cSrcweir #include <vector>
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir namespace chart
40*cdf0e10cSrcweir {
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir class ExplicitValueProvider;
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir namespace impl
45*cdf0e10cSrcweir {
46*cdf0e10cSrcweir class ImplObjectHierarchy;
47*cdf0e10cSrcweir }
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir class ObjectHierarchy
50*cdf0e10cSrcweir {
51*cdf0e10cSrcweir public:
52*cdf0e10cSrcweir     typedef ObjectIdentifier tOID;
53*cdf0e10cSrcweir     typedef ::std::vector< tOID > tChildContainer;
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir     /** @param bFlattenDiagram
56*cdf0e10cSrcweir             If <TRUE/>, the content of the diaram (data series, wall, floor,
57*cdf0e10cSrcweir             etc.) is treated as being at the same level as the diagram. (This is
58*cdf0e10cSrcweir             used for keyboard navigation).
59*cdf0e10cSrcweir      */
60*cdf0e10cSrcweir     explicit ObjectHierarchy(
61*cdf0e10cSrcweir         const ::com::sun::star::uno::Reference<
62*cdf0e10cSrcweir             ::com::sun::star::chart2::XChartDocument > & xChartDocument,
63*cdf0e10cSrcweir         ExplicitValueProvider * pExplicitValueProvider = 0,
64*cdf0e10cSrcweir         bool bFlattenDiagram = false,
65*cdf0e10cSrcweir         bool bOrderingForElementSelector = false );
66*cdf0e10cSrcweir     ~ObjectHierarchy();
67*cdf0e10cSrcweir 
68*cdf0e10cSrcweir     static tOID      getRootNodeOID();
69*cdf0e10cSrcweir     static bool      isRootNode( const tOID& rOID );
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir     /// equal to getChildren( getRootNodeOID())
72*cdf0e10cSrcweir     tChildContainer  getTopLevelChildren() const;
73*cdf0e10cSrcweir     bool             hasChildren( const tOID& rParent ) const;
74*cdf0e10cSrcweir     tChildContainer  getChildren( const tOID& rParent ) const;
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir     tChildContainer  getSiblings( const tOID& rNode ) const;
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir     /// The result is empty, if the node cannot be found in the tree
79*cdf0e10cSrcweir     tOID             getParent( const tOID& rNode ) const;
80*cdf0e10cSrcweir     /// @returns -1, if no parent can be determined
81*cdf0e10cSrcweir     sal_Int32        getIndexInParent( const tOID& rNode ) const;
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir private:
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir     ::std::auto_ptr< impl::ImplObjectHierarchy > m_apImpl;
86*cdf0e10cSrcweir };
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir class ObjectKeyNavigation
89*cdf0e10cSrcweir {
90*cdf0e10cSrcweir public:
91*cdf0e10cSrcweir     explicit ObjectKeyNavigation( const ObjectHierarchy::tOID & rCurrentOID,
92*cdf0e10cSrcweir                                   const ::com::sun::star::uno::Reference<
93*cdf0e10cSrcweir                                       ::com::sun::star::chart2::XChartDocument > & xChartDocument,
94*cdf0e10cSrcweir                                   ExplicitValueProvider * pExplicitValueProvider = 0 );
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir     bool handleKeyEvent( const ::com::sun::star::awt::KeyEvent & rEvent );
97*cdf0e10cSrcweir     ObjectHierarchy::tOID getCurrentSelection() const;
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir private:
100*cdf0e10cSrcweir     void setCurrentSelection( const ObjectHierarchy::tOID& rOID );
101*cdf0e10cSrcweir     bool first();
102*cdf0e10cSrcweir     bool last();
103*cdf0e10cSrcweir     bool next();
104*cdf0e10cSrcweir     bool previous();
105*cdf0e10cSrcweir     bool up();
106*cdf0e10cSrcweir     bool down();
107*cdf0e10cSrcweir     bool veryFirst();
108*cdf0e10cSrcweir     bool veryLast();
109*cdf0e10cSrcweir 
110*cdf0e10cSrcweir     ObjectHierarchy::tOID m_aCurrentOID;
111*cdf0e10cSrcweir     ::com::sun::star::uno::Reference<
112*cdf0e10cSrcweir             ::com::sun::star::chart2::XChartDocument > m_xChartDocument;
113*cdf0e10cSrcweir     ExplicitValueProvider * m_pExplicitValueProvider;
114*cdf0e10cSrcweir     bool m_bStepDownInDiagram;
115*cdf0e10cSrcweir };
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir } //  namespace chart
118*cdf0e10cSrcweir 
119*cdf0e10cSrcweir // CHART2_OBJECTHIERARCHY_HXX
120*cdf0e10cSrcweir #endif
121