office-gobmx/autodoc/source/display/idl/hfi_globalindex.hxx
Vladimir Glazounov a3e90479fc INTEGRATION: CWS sdk02 (1.1.32); FILE MERGED
2003/05/26 15:21:35 np 1.1.32.1: #109482# Reenabling that Java help understands our IDL index file.
2003-06-10 10:33:18 +00:00

123 lines
4.6 KiB
C++

/*************************************************************************
*
* $RCSfile: hfi_globalindex.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: vg $ $Date: 2003-06-10 11:33:18 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef ADC_DISPLAY_HFI_GLOBALINDEX_HXX
#define ADC_DISPLAY_HFI_GLOBALINDEX_HXX
// USED SERVICES
// BASE CLASSES
#include "hi_factory.hxx"
// COMPONENTS
// PARAMETERS
#include <ary/idl/ip_2s.hxx>
class HF_IdlTypeText;
class HF_IdlGlobalIndex : public HtmlFactory_Idl
{
public:
typedef std::vector<ary::idl::Ce_id> PageData;
HF_IdlGlobalIndex(
Environment & io_rEnv,
Xml::Element & o_rOut );
virtual ~HF_IdlGlobalIndex();
void Produce_Page(
ary::idl::alphabetical_index::E_Letter
i_letter ) const;
private:
void make_Navibar() const; /// Called by @->Produce_Page()
void produce_Line( /// Called by @->Produce_Page()
PageData::const_iterator
i_entry,
const HF_IdlTypeText &
i_typeLinkWriter ) const;
void write_EntryItself( /// Called by @->produceLine()
Xml::Element & o_destination,
const ary::idl::CodeEntity &
i_entry,
const HF_IdlTypeText &
i_typeLinkWriter ) const;
void write_OwnerOfEntry( /// Called by @->produceLine()
Xml::Element & o_destination,
const ary::idl::CodeEntity &
i_entry,
const HF_IdlTypeText &
i_typeLinkWriter ) const;
void write_EntrySecondTime( /// Called by @->produceLine()
Xml::Element & o_destination,
const ary::idl::CodeEntity &
i_entry,
const HF_IdlTypeText &
i_typeLinkWriter ) const;
};
#endif