diff options
Diffstat (limited to 'svx/inc/txencbox.hxx')
-rw-r--r-- | svx/inc/txencbox.hxx | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/svx/inc/txencbox.hxx b/svx/inc/txencbox.hxx new file mode 100644 index 000000000000..e24716f8c953 --- /dev/null +++ b/svx/inc/txencbox.hxx @@ -0,0 +1,121 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * 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 _SVX_TXENCBOX_HXX +#define _SVX_TXENCBOX_HXX + +// include --------------------------------------------------------------- + +#ifndef _LSTBOX_HXX //autogen +#include <vcl/lstbox.hxx> +#endif +#include <rtl/textenc.h> +#include "svx/svxdllapi.h" + +class SvxTextEncodingTable; + +class SVX_DLLPUBLIC SvxTextEncodingBox : public ListBox +{ +private: + const SvxTextEncodingTable* m_pEncTable; + + SVX_DLLPRIVATE USHORT EncodingToPos_Impl( rtl_TextEncoding nEnc ) const; + +public: + SvxTextEncodingBox( Window* pParent, const ResId& rResId ); + ~SvxTextEncodingBox(); + + /** Fill with all known encodings but exclude those matching one or more + given flags as defined in rtl/tencinfo.h + + <p> If nButIncludeInfoFlags is given, encodings are included even if they + match nExcludeInfoFlags. Thus it is possible to exclude 16/32-bit + Unicode with RTL_TEXTENCODING_INFO_UNICODE but to include UTF7 and UTF8 + with RTL_TEXTENCODING_INFO_MIME </p> + + @param bExcludeImportSubsets + If <TRUE/>, some specific encodings are not listed, as they are a + subset of another encoding. This is the case for + RTL_TEXTENCODING_GB_2312, RTL_TEXTENCODING_GBK, + RTL_TEXTENCODING_MS_936, which are covered by + RTL_TEXTENCODING_GB_18030. Normally, this flag should be set to + <TRUE/> whenever the box is used in import dialogs. */ + void FillFromTextEncodingTable( + sal_Bool bExcludeImportSubsets = FALSE, + sal_uInt32 nExcludeInfoFlags = 0, + sal_uInt32 nButIncludeInfoFlags = 0 + ); + + /** Fill with all encodings known to the dbtools::OCharsetMap but exclude + those matching one or more given flags as defined in rtl/tencinfo.h + + <p> If nButIncludeInfoFlags is given, encodings are included even if they + match nExcludeInfoFlags. Thus it is possible to exclude 16/32-bit + Unicode with RTL_TEXTENCODING_INFO_UNICODE but to include UTF7 and UTF8 + with RTL_TEXTENCODING_INFO_MIME </p> + + @param bExcludeImportSubsets + If <TRUE/>, some specific encodings are not listed, as they are a + subset of another encoding. This is the case for + RTL_TEXTENCODING_GB_2312, RTL_TEXTENCODING_GBK, + RTL_TEXTENCODING_MS_936, which are covered by + RTL_TEXTENCODING_GB_18030. Normally, this flag should be set to + <TRUE/> whenever the box is used in import dialogs. */ + void FillFromDbTextEncodingMap( + sal_Bool bExcludeImportSubsets = FALSE, + sal_uInt32 nExcludeInfoFlags = 0, + sal_uInt32 nButIncludeInfoFlags = 0 + ); + + /** Fill with all known MIME encodings and select the best according to + <method>GetBestMimeEncoding</method> + */ + void FillWithMimeAndSelectBest(); + + const SvxTextEncodingTable* GetTextEncodingTable() const + { return m_pEncTable; } + + void InsertTextEncoding( const rtl_TextEncoding nEnc, + USHORT nPos = LISTBOX_APPEND ); + + void InsertTextEncoding( const rtl_TextEncoding nEnc, + const String& rEntry, + USHORT nPos = LISTBOX_APPEND ); + + void RemoveTextEncoding( const rtl_TextEncoding nEnc ); + + void SelectTextEncoding( const rtl_TextEncoding nEnc, + BOOL bSelect = TRUE ); + + rtl_TextEncoding GetSelectTextEncoding() const; + + const String& GetSelectTextString() const; + + BOOL IsTextEncodingSelected( const rtl_TextEncoding nEnc ) const; +}; + +#endif + |