autodoc/inc/ary_i/ci_text2.hxx

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