transex3/inc/wrdtrans.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: wrdtrans.hxx,v $
  10  * $Revision: 1.4 $
  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
  32 // OBSOLETE //
  33
  34 #ifndef TX3_WRDTRANS_HXX
  35 #define TX3_WRDTRANS_HXX
  36
  37 // USED
  38     // Base Classes
  39     // Components
  40 class WordTransTree;
  41 class WordTrans_ErrorList;
  42     // Parameters
  43 #include <tools/string.hxx>
  44
  45 class WordTransformer
  46 {
  47   public:
  48     enum E_Error
  49     {
  50         OK = 0,
  51         ERROR_NO_WORDLIST,
  52         ERROR_HOTKEY,
  53         ERROR_OUTPUTSTRING_TOO_LONG,
  54         OTHER_ERROR
  55     };
  56
  57     //  LIFECYCLE
  58                         WordTransformer();
  59                         ~WordTransformer();
  60     BOOL                                LoadWordlist(                   /// @return False, if file could not be read, or there is already a wordlist loaded.
  61                             const ByteString &  i_sWordlist_Filepath,
  62                             CharSet                             i_nWorkingCharSet = RTL_TEXTENCODING_MS_1252,
  63                             CharSet                             i_nFileCharSet  = RTL_TEXTENCODING_MS_1252 );
  64
  65     // OPERATIONS
  66     USHORT                              Transform(              /// @return The number of errors during transforming.
  67                             ByteString &                io_sText);
  68
  69     // INQUIRY
  70     USHORT                              NrOfErrors() const;
  71     E_Error                             GetError(
  72                             USHORT                              i_nNr,                   /// [0 .. NrOfErrors()-1], other values return an empty error.
  73                             ByteString *                o_pErrorText = 0) const; /// If o_pErrorText != 0, the String is filled with the description of the error.
  74
  75   private:
  76     // SERVICE FUNCTION
  77     void                                CreateError();
  78
  79     // DATA
  80     WordTransTree *             dpTransformer;
  81     WordTrans_ErrorList *
  82                         dpErrors;
  83 };
  84
  85
  86
  87 #endif
  88
  89
  90 */