autodoc/inc/ary_i/ci_text2.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ci_text2.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_CINFO_CI_TEXT2_HXX
  32 #define ARY_CINFO_CI_TEXT2_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39     // PARAMETERS
  40
  41
  42 namespace ary
  43 {
  44 namespace inf
  45 {
  46
  47
  48 class DocumentationDisplay;
  49
  50
  51 class DocuToken
  52 {
  53   public:
  54     virtual                             ~DocuToken() {}
  55     virtual void                DisplayAt(
  56                             DocumentationDisplay &
  57                                                 o_rDisplay ) const = 0;
  58     virtual bool                IsWhiteOnly() const = 0;
  59 };
  60
  61
  62 class DocuTex2
  63 {
  64   public:
  65     typedef std::vector< DocuToken * >  TokenList;
  66
  67                         DocuTex2();
  68     virtual                             ~DocuTex2();
  69
  70     virtual void                DisplayAt(
  71                             DocumentationDisplay &
  72                                                 o_rDisplay ) const;
  73     void                AddToken(
  74                             DYN DocuToken &             let_drToken );
  75
  76     const TokenList &   Tokens() const                  { return aTokens; }
  77     bool                IsEmpty() const;
  78     const String &      TextOfFirstToken() const;
  79
  80     String &            Access_TextOfFirstToken();
  81
  82   private:
  83     TokenList                   aTokens;
  84 };
  85
  86
  87
  88 // IMPLEMENTATION
  89
  90 }   // namespace inf
  91 }   // namespace ary
  92
  93
  94 #endif
  95