diff options
Diffstat (limited to 'autodoc/source/display/idl/hi_env.hxx')
| -rw-r--r-- | autodoc/source/display/idl/hi_env.hxx | 163 |
1 files changed, 0 insertions, 163 deletions
diff --git a/autodoc/source/display/idl/hi_env.hxx b/autodoc/source/display/idl/hi_env.hxx deleted file mode 100644 index a081e07f..00000000 --- a/autodoc/source/display/idl/hi_env.hxx +++ /dev/null @@ -1,163 +0,0 @@ -/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ - -#ifndef ADC_DISPLAY_HI_ENV_HXX -#define ADC_DISPLAY_HI_ENV_HXX - - -// USED SERVICES - // BASE CLASSES - // COMPONENTS -#include <cosv/ploc.hxx> -#include <cosv/ploc_dir.hxx> - // PARAMETERS -#include <toolkit/out_position.hxx> - -namespace ary -{ -namespace idl -{ - class Gate; - class CodeEntity; -} -} -namespace display -{ - class CorporateFrame; -} -namespace output -{ - class Tree; -} - -class AryAccess; -class LinkHelper; - -/** @resp - Provides enviroment information to the HTML factory - classes. - - @descr - All information that is not included in the data, especially - about the layout of the output tree and the access to - information from the repository are provided here. - - @see HtmlFactory -*/ -class HtmlEnvironment_Idl -{ - public: - // LIFECYCLE - HtmlEnvironment_Idl( - const csv::ploc::Path & - io_rOutputDir, - const ary::idl::Gate & - i_rGate, - const display::CorporateFrame & - i_rLayout ); - ~HtmlEnvironment_Idl(); - - // OPERATIONS - void Goto_Directory( - output::Position i_pos, - bool i_bCreateDirectoryIfNecessary ); - void Goto_DirectoryLevelDown( - const String & i_subDirName, - bool i_bCreateDirectoryIfNecessary ); - void Goto_DirectoryLevelUp(); - void Set_CurFile( - const String & i_fileName ); - void Set_CurPageCe( - const ary::idl::CodeEntity * - i_ce ) - { pCurPageCe = i_ce; } - // INQUIRY - const ary::idl::Gate & - Gate() const { return *pGate; } - const AryAccess & Data() const { return *pData; } - const char * Link2Manual( - const String & i_link ) const; - - /// This may be reimplemented for removing dead links to members. - bool Is_MemberExistenceCheckRequired() const - { return false; } - - /// @return Holds only the current directory, not the current file. - output::Position & CurPosition() const { return aCurPosition; } - void Get_CurFilePath( - StreamStr & o_buffer ) const - { o_buffer << aCurPath; } - - const display::CorporateFrame & - Layout() const { return *pLayout; } - const LinkHelper & Linker() const { return *pLinker; } - - void Get_LinkTo( - StreamStr & o_result, - output::Position i_destination ) - { CurPosition().Get_LinkTo(o_result, i_destination); } - String CurPageCe_AsText() const; - String CurPageCe_AsFile( - const char * i_sEnding) const; - const ary::idl::CodeEntity * - CurPageCe() const { return pCurPageCe; } - - // ACCESS - output::Tree & OutputTree() { return *pOutputTree; } - - private: - // Local - void create_Directory( - const csv::ploc::Path & - i_path ); - - // DATA - csv::ploc::Directory - aOutputRoot; - csv::ploc::Path aCurPath; - - Dyn<AryAccess> pData; /// @invariant *pData is valid. - const ary::idl::Gate * - pGate; /// @invariant pGate != 0. - Dyn<output::Tree> pOutputTree; /// @invariant *pOutputTree is valid. - mutable output::Position - aCurPosition; - const ary::idl::CodeEntity * - pCurPageCe; - - const display::CorporateFrame * - pLayout; - - Dyn<LinkHelper> pLinker; -}; - - -#endif - - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |