FxUIObject.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2023 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "../FxCommonFramework.h"
 
#include <QtCore/QBuffer>
#include <QtCore/QByteArray>
#include <QtCore/QDate>
#include <QtCore/QFile>
#include <QtCore/QList>
#include <QtCore/QMap>
#include <QtCore/QString>
#include <QtCore/QUuid>
#include <QtCore/QVariant>
#include <QtCore/QVector>
#include <QtGui/QPalette>
#include <QtGui/QValidator>
#if !defined( XENON )
#include <QtGui/QIcon>
#include <QtGui/QPixmap>
#endif
 
using CFxUIBuffer = QBuffer;
using CFxUIByteArray = QByteArray;
using CFxUIByteArrayList = QByteArrayList;
using CFxUIDate = QDate;
using CFxUIFile = QFile;
template<typename T>
using CFxUIList = QList<T>;
using CFxUIPainter = QPainter;
using CFxUIPalette = QPalette;
using CFxUISize = QSize;
using CFxUIString = QString;
using CFxUIStringList = QStringList;
using CFxUIUuid = QUuid;
using CFxUIValidator = QValidator;
using CFxUIVariant = QVariant;
using CFxUIFont = QFont;
template< typename K, typename V >
using CFxUIMap = QMap< K, V >;
template< typename T >
using CFxUIVector = QVector<T>;
#if defined(XENON)
#include <Wt/WLink.h>
using CFxUIIcon = Wt::WLink;
using CFxUIPixmap = Wt::WLink;
#else
using CFxUIIcon = QIcon;
using CFxUIPixmap = QPixmap;
#endif
 
#if defined( Q_OS_IOS )
    typedef void* FxNativeHandle;
#elif defined( ANDROID )
    #include <jni.h>
    #include "../../../DDKERNEL/touch/FxJavaUtils.h"
    typedef CFxJavaHandle* FxNativeHandle;
#else
    #if defined(XENON)
#ifdef emit
#undef emit
#define FX_REDEFINE_EMIT
#endif
#ifdef slots
#undef slots
#define FX_REDEFINE_SLOTS
#endif
    #include <Wt/WObject.h>
    typedef Wt::WObject* FxNativeHandle;
#ifdef FX_REDEFINE_EMIT
#define emit
#endif
#ifdef FX_REDEFINE_SLOTS
#define slots
#endif
    #else
    typedef QObject* FxNativeHandle;
    #endif
#endif
 
class CFxUIObjectImpl;
class CFxUIObjectData;
class CFxUIEmitScope;
 
class COMMONUI_API CFxUIObject
{
    friend CFxUIObjectData;
    friend CFxUIEmitScope;
public:
 
    CFxUIObject();
 
    virtual ~CFxUIObject();
 
    FxNativeHandle getHandle() const;
 
    void setHandle( FxNativeHandle handle );
    
    void setParent( CFxUIObject* parent );
    
    CFxUIObject* parent();
 
    const CFxUIObject* parent() const;
    
    void setObjectName( const CFxUIString& objectName );
 
    CFxUIString objectName() const;
    
    bool setProperty( const char* name, const CFxUIVariant& value );
 
    CFxUIVariant property( const char* name );
    
    CFxUIList<CFxUIObject*> children() const;
    
    template<typename T>
    CFxUIList<T> findChildren( const CFxUIString& name = CFxUIString() )
    {
        CFxUIList<T> result;
        
        CFxUIList<CFxUIObject*> allChildren = children();
        for ( CFxUIObject* child : allChildren )
        {
            if ( T obj = dynamic_cast<T>( child ) )
            {
                if ( !name.isEmpty() )
                {
                    if ( name == obj->objectName() )
                        result.push_back( obj );
                }
                else
                    result.push_back( obj );
            }
        }
        
        return result;
    }
    
    void blockSignals( bool block );
 
    bool signalsBlocked() const;
 
protected:
    CFxUIObject* sender();
 
private:
    void setSender( CFxUIObject* pSender );
    
protected:
    CFxUIObjectImpl* m_pImpl;
    CFxUIObjectData* m_pData;
 
    //...
};