1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 #ifndef ADC_X_DOCU_HXX 29 #define ADC_X_DOCU_HXX 30 31 // BASE CLASSES 32 #include <autodoc/x_parsing.hxx> 33 34 35 36 37 class X_Docu : public autodoc::X_Parser_Ifc 38 { 39 public: 40 // LIFECYCLE 41 X_Docu( 42 const char * i_tag, 43 const char * i_explanation ); 44 ~X_Docu(); 45 // INQUIRY 46 virtual E_Event GetEvent() const; 47 virtual void GetInfo( 48 std::ostream & o_rOutputMedium ) const; 49 50 private: 51 String sTagName; 52 String sExplanation; 53 }; 54 55 56 57 58 #endif 59