FxUIObject.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 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 "../Core/FxUIGlobalDefines.h"
 
class CFxUIObjectImpl;
class CFxUIObjectData;
class CFxUIEmitScope;
class CFxUIVariant;

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;
 
    //...
};