Qt Toolkit - qtranslator.h include file

| Classes - Annotated - Tree - Functions - Home - Structure

# qtranslator.h

This is the verbatim text of the qtranslator.h include file. It is provided only for illustration; the copyright remains with Trolltech.

    /****************************************************************************
    ** $Id: qt/src/kernel/qtranslator.h   2.3.7   edited 2001-01-26 $
    **
    ** Definition of the translator class
    **
    ** Created : 980906
    **
    ** Copyright (C) 1998-99 by Trolltech AS.  All rights reserved.
    **
    ** This file is part of the kernel module of the Qt GUI Toolkit.
    **
    ** This file may be distributed under the terms of the Q Public License
    ** as defined by Trolltech AS of Norway and appearing in the file
    ** LICENSE.QPL included in the packaging of this file.
    **
    ** This file may be distributed and/or modified under the terms of the
    ** GNU General Public License version 2 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.GPL included in the
    ** packaging of this file.
    **
    ** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
    ** licenses may use this file in accordance with the Qt Commercial License
    ** Agreement provided with the Software.
    **
    ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
    ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
    **
    ** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
    **   information about Qt Commercial License Agreements.
    ** See http://www.trolltech.com/qpl/ for QPL licensing information.
    ** See http://www.trolltech.com/gpl/ for GPL licensing information.
    **
    ** Contact info@trolltech.com if any conditions of this licensing are
    ** not clear to you.
    **
    **********************************************************************/

    #ifndef QTRANSLATOR_H
    #define QTRANSLATOR_H

    #ifndef QT_H
    #include "qobject.h"
    #include "qintdict.h"
    #endif // QT_H

    #ifndef QT_NO_TRANSLATION

    class QTranslatorPrivate;

    class Q_EXPORT QTranslatorMessage
    {
    public:
        QTranslatorMessage();
        QTranslatorMessage( const char * context,
                            const char * sourceText,
                            const char * comment,
                            const QString& translation = QString::null );
        QTranslatorMessage( QDataStream & );
        QTranslatorMessage( const QTranslatorMessage & m );

        QTranslatorMessage & operator=( const QTranslatorMessage & m );

        uint hash() const { return h; }
        const char *context() const { return cx; }
        const char *sourceText() const { return st; }
        const char *comment() const { return cm; }

        void setTranslation( const QString & translation ) { tn = translation; }
        QString translation() const { return tn; }

        enum Prefix { NoPrefix, Hash, HashContext, HashContextSourceText,
                      HashContextSourceTextComment };
        void write( QDataStream & s, bool strip,
                    Prefix prefix = HashContextSourceTextComment ) const;
        Prefix commonPrefix( const QTranslatorMessage& ) const;

        bool operator==( const QTranslatorMessage& m ) const;
        bool operator!=( const QTranslatorMessage& m ) const
        { return !operator==( m ); }
        bool operator<( const QTranslatorMessage& m ) const;
        bool operator<=( const QTranslatorMessage& m ) const
        { return !operator>( m ); }
        bool operator>( const QTranslatorMessage& m ) const
        { return this->operator<( m ); }
        bool operator>=( const QTranslatorMessage& m ) const
        { return !operator<( m ); }

    private:
        uint h;
        QCString cx;
        QCString st;
        QCString cm;
        QString tn;

        enum Tag { Tag_End = 1, Tag_SourceText16, Tag_Translation, Tag_Context16,
                   Tag_Hash, Tag_SourceText, Tag_Context, Tag_Comment,
                   Tag_Obsolete1 };
    };

    class Q_EXPORT QTranslator: public QObject
    {
        Q_OBJECT
    public:
        QTranslator( QObject * parent, const char * name = 0 );
        ~QTranslator();

    // ### find( const char *, const char *, const char * ) obsolete in Qt 3.0 ?
        QString find( const char *, const char *, const char * ) const;
    // ### find( const char *, const char * ) obsolete in Qt 3.0
        virtual QString find( const char *, const char * ) const;
    // ### findMessage made virtual in Qt 3.0
        QTranslatorMessage findMessage( const char *, const char *,
                                        const char * ) const;

        bool load( const QString & filename,
                   const QString & directory = QString::null,
                   const QString & search_delimiters = QString::null,
                   const QString & suffix = QString::null );

        enum SaveMode { Everything, Stripped };

        bool save( const QString & filename, SaveMode mode = Everything );

        void clear();

        void insert( const QTranslatorMessage& );
    // ### insert() obsolete in Qt 3.0
        void insert( const char *, const char *, const QString & );
        void remove( const QTranslatorMessage& );
    // ### first remove obsolete in Qt 3.0
        void remove( const char *, const char * );
        bool contains( const char *, const char *, const char * ) const;
    // ### contains removed in Qt 3.0
        bool contains( const char *, const char * ) const;

    // ### squeeze() obsolete in Qt 3.0
    // ### replaced by squeeze( SaveMode mode = Everything )
        void squeeze( SaveMode );
        void squeeze();
        void unsqueeze();

        QValueList<QTranslatorMessage> messages() const;

    private:
        QTranslatorPrivate * d;

    private:        // Disabled copy constructor and operator=
    #if defined(Q_DISABLE_COPY)
        QTranslator( const QTranslator & );
        QTranslator &operator=( const QTranslator & );
    #endif
    };

    #endif // QT_NO_TRANSLATION

    #endif