kexiutils/utils.h

/* This file is part of the KDE project
   Copyright (C) 2003-2007 Jaroslaw Staniek <js@iidea.pl>
 
   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This program 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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this program; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef KEXIUTILS_UTILS_H
#define KEXIUTILS_UTILS_H
 
#include "kexiutils_export.h"
 
#include <tqguardedptr.h>
#include <tqobjectlist.h>
#include <kmimetype.h>
class TQColor;

namespace KexiUtils
{
    inline bool hasParent(TQObject* par, TQObject* o)
    {
        if (!o || !par)
            return false;
        while (o && o!=par)
            o = o->parent();
        return o==par;
    }

    template<class type>
    inline type* findParent(TQObject* o, const char* className)
    {
        if (!o || !className || className[0]=='\0')
            return 0;
        while ( ((o=o->parent())) && !o->inherits(className) )
            ;
        return static_cast<type*>(o);
    }

    template<class type>
    inline const type* findParentConst(const TQObject* const o, const char* className)
    {
        const TQObject * obj = o;
        if (!obj || !className || className[0]=='\0')
            return 0;
        while ( ((obj=obj->parent())) && !obj->inherits(className) )
            ;
        return static_cast<const type*>(obj);
    }

    template<class type>
    type* findFirstChild(TQObject *o, const char* className, const char* objName = 0)
    {
        if (!o || !className || className[0]=='\0')
            return 0;
        TQObjectList *l = o->queryList( className, objName );
        TQObject *result = l->first();
        delete l;
        return static_cast<type*>(result);
    }

    inline TQDateTime stringToHackedTQTime(const TQString& s)
    {
        if (s.isEmpty())
            return TQDateTime();
    //      kdDebug() << TQDateTime( TQDate(0,1,2), TQTime::fromString( s, TQt::ISODate ) ).toString(TQt::ISODate) << endl;;
        return TQDateTime( TQDate(0,1,2), TQTime::fromString( s, TQt::ISODate ) );
    }

    KEXIUTILS_EXPORT void setWaitCursor(bool noDelay = false);

    KEXIUTILS_EXPORT void removeWaitCursor();

    class KEXIUTILS_EXPORT WaitCursor
    {
        public:
            WaitCursor(bool noDelay = false);
            ~WaitCursor();
    };

    class KEXIUTILS_EXPORT WaitCursorRemover
    {
        public:
            WaitCursorRemover();
            ~WaitCursorRemover();
        private:
            bool m_reactivateCursor : 1;
    };

    KEXIUTILS_EXPORT TQString fileDialogFilterString(const KMimeType::Ptr& mime, bool kdeFormat = true);

    KEXIUTILS_EXPORT TQString fileDialogFilterString(const TQString& mimeString, bool kdeFormat = true);

    KEXIUTILS_EXPORT TQString fileDialogFilterStrings(const TQStringList& mimeStrings, bool kdeFormat);

    KEXIUTILS_EXPORT TQColor blendedColors(const TQColor& c1, const TQColor& c2, int factor1 = 1, int factor2 = 1);

    KEXIUTILS_EXPORT TQColor contrastColor(const TQColor& c);

    KEXIUTILS_EXPORT TQColor bleachedColor(const TQColor& c, int factor);

    KEXIUTILS_EXPORT TQIconSet colorizeIconToTextColor(const TQPixmap& icon, const TQPalette& palette);

    KEXIUTILS_EXPORT TQPixmap emptyIcon(TDEIcon::Group iconGroup);

    KEXIUTILS_EXPORT void serializeMap(const TQMap<TQString,TQString>& map, const TQByteArray& array);
    KEXIUTILS_EXPORT void serializeMap(const TQMap<TQString,TQString>& map, TQString& string);

    KEXIUTILS_EXPORT TQMap<TQString,TQString> deserializeMap(const TQByteArray& array);

    KEXIUTILS_EXPORT TQMap<TQString,TQString> deserializeMap(const TQString& string);

    KEXIUTILS_EXPORT TQString stringToFileName(const TQString& string);

    KEXIUTILS_EXPORT void simpleCrypt(TQString& string);

    KEXIUTILS_EXPORT void simpleDecrypt(TQString& string);
 
#ifdef KEXI_DEBUG_GUI
    KEXIUTILS_EXPORT TQWidget *createDebugWindow(TQWidget *parent);

    KEXIUTILS_EXPORT void addKexiDBDebug(const TQString& text);

    KEXIUTILS_EXPORT void addAlterTableActionDebug(const TQString& text, int nestingLevel = 0);

    KEXIUTILS_EXPORT void connectPushButtonActionForDebugWindow(const char* actionName, 
        const TQObject *receiver, const char* slot);
#endif

    KEXIUTILS_EXPORT void drawPixmap( TQPainter& p, int lineWidth, const TQRect& rect,
        const TQPixmap& pixmap, int alignment, bool scaledContents, bool keepAspectRatio);

    KEXIUTILS_EXPORT TQString ptrToStringInternal(void* ptr, uint size);
    KEXIUTILS_EXPORT void* stringToPtrInternal(const TQString& str, uint size);

    template<class type>
    TQString ptrToString(type *ptr)
    {
        return ptrToStringInternal(ptr, sizeof(type*));
    }
    
    template<class type>
    type* stringToPtr(const TQString& str)
    {
        return static_cast<type*>( stringToPtrInternal(str, sizeof(type*)) );
    }

    KEXIUTILS_EXPORT void setFocusWithReason(TQWidget* widget, TQFocusEvent::Reason reason);

    KEXIUTILS_EXPORT void unsetFocusWithReason(TQWidget* widget, TQFocusEvent::Reason reason);

    enum CopyFileResult {
        CopySuccess = 0,
        CopyReadError = 1,
        CopyWriteError = 2
    };
    
    KEXIUTILS_EXPORT CopyFileResult copyFile(const TQString& src, const TQString& dest);
}
 

#define GLUE_WIDGET(what, where) \
    { TQVBoxLayout *lyr = new TQVBoxLayout(where); \
      lyr->addWidget(what); }
 
 
#endif //KEXIUTILS_UTILS_H