diff options
Diffstat (limited to 'autodoc/inc/ary/doc/ht/dht_stream.hxx')
| -rw-r--r-- | autodoc/inc/ary/doc/ht/dht_stream.hxx | 166 |
1 files changed, 0 insertions, 166 deletions
diff --git a/autodoc/inc/ary/doc/ht/dht_stream.hxx b/autodoc/inc/ary/doc/ht/dht_stream.hxx deleted file mode 100644 index b45d7d7692b8..000000000000 --- a/autodoc/inc/ary/doc/ht/dht_stream.hxx +++ /dev/null @@ -1,166 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2008 by Sun Microsystems, Inc. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * $RCSfile: dht_stream.hxx,v $ - * $Revision: 1.3 $ - * - * 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 ARY_DOC_DHT_STREAM_HXX -#define ARY_DOC_DHT_STREAM_HXX - -// USED SERVICES -#include <ary/doc/d_hypertext.hxx> - - - -namespace ary -{ -namespace doc -{ -namespace ht -{ - class Stream; - - -typedef void (* F_StreamModifier)(Stream&); - -/// Causes the buffer in ->io_stream to be flushed. -void flush( - Stream & io_stream ); -/// Adds a newline. -void newline( - Stream & io_stream ); -/// Adds a single blank char. -void blank( - Stream & io_stream ); -/// Modifies ->Stream to plain text mode. -void plain( - Stream & io_stream ); -/// Modifies ->Stream to html text mode. -void html( - Stream & io_stream ); - - - - -/** Interface to write items into a ->HyperText. - - Text can be intepreted as plain ASCII or as HTML. The default - is plain ASCII. - Also you can add links and can specify the link's label. - If no label is provided for a link, the most specific part of the - link's name will be used. - - - @example - using ary::doc::HyperText; - using ary::doc::ht::Stream; - - Stream aWriter; - HyperText aText; - StreamGuard aGuard(aWriter,aText); - - Ce_id nId = i_ceid; - aWriter << "Hello," << newline; - aWriter.Add_Link2Ce(GetAbsolutePath(nId), "SomeCodeEntity") - aWriter << " will be transfered." << newline; - aWriter Add_Link2Param("io_someParameter"); - aWriter << " shows something else." - << flush; -*/ -class Stream -{ - NON_COPYABLE(Stream); - - public: - /// Marks the mode how documentation text is interpreted. - enum E_TextMode - { - tm_plain, - tm_html - }; - - Stream( - HyperText & o_Receiver, - E_TextMode i_initialTextMode = tm_plain); - /// Also flushes the stream to the connected ->HyperText, if any. - virtual ~Stream(); - - Stream & operator<<( - F_StreamModifier i_modifier ); - /// Inserts text. - Stream & operator<<( - const char * i_text ); - /// Inserts text. - Stream & operator<<( - const String & i_text ); - - void Add_Indentation( - uintt i_count ); - - void Add_Link2Ce( - const String & i_absolutePath, - const String & i_display = String::Null_() ); - void Add_Link2Unknown( - const String & i_type, - const String & i_display = String::Null_() ); - void Add_Link2Url( - const String & i_url, - const String & i_display = String::Null_() ); - void Add_Link2Param( - const String & i_parameter, - const String & i_display = String::Null_() ); - - E_TextMode CurrentMode() const; - - private: - friend void flush(Stream&); - friend void newline(Stream&); - friend void blank(Stream&); - friend void plain(Stream&); - friend void html(Stream&); - - // Locals - typedef void (Stream::*F_TextFlusher)(); - - void Flush(); - void PlainTextFlusher(); - void HtmlTextFlusher(); - - HyperText & Out(); - - // DATA - HyperText & mrOut; - F_TextFlusher mfCurTextFlusher; - StreamStr mText; -}; - - - -} // namspace ht -} // namspace doc -} // namspace ary -#endif |