FxUIPixmap.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 "../UI/FxUIEnum.h"
#include "FxUIGlobalDefines.h"
#include "FxUISize.h"
#include "FxUIColor.h"
#include "FxUIPaintDevice.h"
 
#if defined( XENON )
namespace Wt
{
    class WLink;
}
using FxNativePixmap = Wt::WLink;
#else
class QPixmap;
using FxNativePixmap = QPixmap;
#endif
 
class CFxUIPixmapImpl;
class CFxUIImage;
class CFxUIByteArray;
 
class COMMONUI_API CFxUIPixmap : public CFxUIPaintDevice
{
public:
    enum AspectRatioMode
    {
        IgnoreAspectRatio,           // The size is scaled freely. The aspect ratio is not preserved.
        KeepAspectRatio,             // The size is scaled to a rectangle as large as possible inside a given rectangle, preserving the aspect ratio.
        KeepAspectRatioByExpanding   // The size is scaled to a rectangle as small as possible outside a given rectangle, preserving the aspect ratio.
    };
 
    enum TransformationMode
    {
        FastTransformation,    // The transformation is performed quickly, with no smoothing.
        SmoothTransformation   // The resulting image is transformed using bilinear filtering.
    };
 
public:

    CFxUIPixmap();

    CFxUIPixmap( int width, int height );
    CFxUIPixmap( const CFxUIString& fileName );

    CFxUIPixmap( const CFxUIPixmap& pixmap );
    CFxUIPixmap( const FxNativePixmap& pixmap );

    ~CFxUIPixmap();

    CFxUIPixmap& operator=( const CFxUIPixmap& pixmap );
 
    operator FxNativePixmap&() const;

    void fill( const CFxUIColor& color = FxUIGlobalColor::white );

    bool loadFromData( const CFxUIByteArray& data );

    bool load( const CFxUIString& fileName );

    bool save( const CFxUIString& fileName, const char* format = nullptr, int quality = -1 ) const;

    CFxUIPixmap scaled( int width, int height, AspectRatioMode aspectRatioMode = IgnoreAspectRatio, TransformationMode transformMode = FastTransformation ) const;

    CFxUIPixmap scaledToWidth( int width, TransformationMode mode = FastTransformation ) const;

    CFxUIImage toImage() const;

    void setUrl( const CFxUIString& url );

    CFxUIString url() const;

    int width();

    CFxUISize size();

    bool isNull();
 
protected:
    CFxUIPixmapImpl* m_pImpl = nullptr;
};