office-gobmx/include/svx/txencbox.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef INCLUDED_SVX_TXENCBOX_HXX
#define INCLUDED_SVX_TXENCBOX_HXX

#include <vcl/weld.hxx>
#include <rtl/textenc.h>
#include <svx/svxdllapi.h>

class SVX_DLLPUBLIC SvxTextEncodingBox
{
private:
    std::unique_ptr<weld::ComboBox> m_xControl;

public:
    SvxTextEncodingBox(std::unique_ptr<weld::ComboBox> pControl);

    ~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(
                            bool bExcludeImportSubsets,
                            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(
                            bool bExcludeImportSubsets,
                            sal_uInt32 nExcludeInfoFlags = 0);

    /** Fill with all known MIME encodings and select the best according to
        <method>GetBestMimeEncoding</method>
     */
    void                FillWithMimeAndSelectBest();

    void                InsertTextEncoding( const rtl_TextEncoding nEnc );

    void                InsertTextEncoding( const rtl_TextEncoding nEnc,
                            const OUString& rEntry );

    void                SelectTextEncoding( const rtl_TextEncoding nEnc );

    rtl_TextEncoding    GetSelectTextEncoding() const;

    void connect_changed(const Link<weld::ComboBox&, void>& rLink) { m_xControl->connect_changed(rLink); }
    void set_sensitive(bool bSensitive) { m_xControl->set_sensitive(bSensitive); }
    void grab_focus() { m_xControl->grab_focus(); }
    int get_active() const { return m_xControl->get_active(); }
    void set_active(int nActive) { m_xControl->set_active(nActive); }
    void show() { m_xControl->show(); }
    void hide() { m_xControl->hide(); }
};

class SVX_DLLPUBLIC SvxTextEncodingTreeView
{
private:
    std::unique_ptr<weld::TreeView> m_xControl;

public:
    SvxTextEncodingTreeView(std::unique_ptr<weld::TreeView> pControl);

    ~SvxTextEncodingTreeView();

    /** Fill with all known encodings but exclude those matching one or more
        given flags as defined in rtl/tencinfo.h

        @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(
                            bool bExcludeImportSubsets,
                            sal_uInt32 nExcludeInfoFlags = 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

        @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(
                            bool bExcludeImportSubsets,
                            sal_uInt32 nExcludeInfoFlags = 0);

    void                InsertTextEncoding( const rtl_TextEncoding nEnc );

    void                InsertTextEncoding( const rtl_TextEncoding nEnc,
                            const OUString& rEntry );

    void                SelectTextEncoding( const rtl_TextEncoding nEnc );

    rtl_TextEncoding    GetSelectTextEncoding() const;

    void connect_changed(const Link<weld::TreeView&, void>& rLink) { m_xControl->connect_changed(rLink); }
    void connect_row_activated(const Link<weld::TreeView&, bool>& rLink) { m_xControl->connect_row_activated(rLink); }
    void grab_focus() { m_xControl->grab_focus(); }
    void show() { m_xControl->show(); }
    void hide() { m_xControl->hide(); }
    int get_height_rows(int nRows) const
    {
        return m_xControl->get_height_rows(nRows);
    }
    void set_size_request(int nWidth, int nHeight)
    {
        m_xControl->set_size_request(nWidth, nHeight);
    }
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */