xref: /AOO41X/main/autodoc/source/display/inc/toolkit/out_position.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 
28*cdf0e10cSrcweir #ifndef ADC_DISPLAY_OUT_POSITION_HXX
29*cdf0e10cSrcweir #define ADC_DISPLAY_OUT_POSITION_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir // USED SERVICES
33*cdf0e10cSrcweir     // BASE CLASSES
34*cdf0e10cSrcweir     // COMPONENTS
35*cdf0e10cSrcweir #include <toolkit/out_node.hxx>
36*cdf0e10cSrcweir     // PARAMETERS
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir namespace output
41*cdf0e10cSrcweir {
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir class Position
46*cdf0e10cSrcweir {
47*cdf0e10cSrcweir   public:
48*cdf0e10cSrcweir     // LIFECYCLE
49*cdf0e10cSrcweir                         Position();
50*cdf0e10cSrcweir     explicit            Position(
51*cdf0e10cSrcweir                             Node &              i_directory,
52*cdf0e10cSrcweir                             const String &      i_file = String::Null_() );
53*cdf0e10cSrcweir                         Position(
54*cdf0e10cSrcweir                             const Position &    i_directory,
55*cdf0e10cSrcweir                             const String &      i_rDifferentFile );
56*cdf0e10cSrcweir                         ~Position();
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir     // OPERATIONS
59*cdf0e10cSrcweir     Position &          operator=(
60*cdf0e10cSrcweir                             Node &              i_node );
61*cdf0e10cSrcweir     Position &          operator+=(
62*cdf0e10cSrcweir                             const String &      i_nodeName );
63*cdf0e10cSrcweir     Position &          operator-=(
64*cdf0e10cSrcweir                             intt                i_levels );
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir     // INQUIRY
67*cdf0e10cSrcweir     bool                IsValid() const         { return pDirectory->Depth() >= 0; }
68*cdf0e10cSrcweir     const String &      Name() const            { return pDirectory->Name(); }
69*cdf0e10cSrcweir     const String &      File() const            { return sFile; }
70*cdf0e10cSrcweir     intt                Depth() const           { return pDirectory->Depth(); }
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir     void                Get_Chain(
73*cdf0e10cSrcweir                             StringVector &      o_result ) const
74*cdf0e10cSrcweir                                                 { pDirectory->Get_Chain(o_result); }
75*cdf0e10cSrcweir     String              LinkToRoot(
76*cdf0e10cSrcweir                             const String &      i_localLabel = String::Null_() ) const;
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir     void                Get_LinkTo(
79*cdf0e10cSrcweir                             StreamStr &         o_result,
80*cdf0e10cSrcweir                             const Position &    i_destination,
81*cdf0e10cSrcweir                             const String &      i_localLabel = String::Null_() ) const;
82*cdf0e10cSrcweir     void                Get_LinkToRoot(
83*cdf0e10cSrcweir                             StreamStr &         o_result,
84*cdf0e10cSrcweir                             const String &      i_localLabel = String::Null_() ) const;
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir     static char         Delimiter()             { return '/'; }
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir     // ACCESS
89*cdf0e10cSrcweir     Node &              RelatedNode() const     { return *pDirectory; }
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir     void                Set(
92*cdf0e10cSrcweir                             Node &              i_node,
93*cdf0e10cSrcweir                             const String &      i_file = String::Null_() );
94*cdf0e10cSrcweir     void                Set_File(
95*cdf0e10cSrcweir                             const String &      i_file );
96*cdf0e10cSrcweir 
97*cdf0e10cSrcweir   private:
98*cdf0e10cSrcweir     // DATA
99*cdf0e10cSrcweir     String              sFile;
100*cdf0e10cSrcweir     Node *              pDirectory;
101*cdf0e10cSrcweir };
102*cdf0e10cSrcweir 
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir /// @return No delimiter at start, with delimiter at end.
105*cdf0e10cSrcweir const char *        get_UpLink(
106*cdf0e10cSrcweir                         uintt                   i_depth );
107*cdf0e10cSrcweir 
108*cdf0e10cSrcweir 
109*cdf0e10cSrcweir // IMPLEMENTATION
110*cdf0e10cSrcweir 
111*cdf0e10cSrcweir inline void
112*cdf0e10cSrcweir Position::Set_File( const String & i_file )
113*cdf0e10cSrcweir     { sFile = i_file; }
114*cdf0e10cSrcweir 
115*cdf0e10cSrcweir }   // namespace output
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir #endif
118