FxUIBaseView.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 "FxUIObject.h"
#include "FxUISignal.h"
#include "FxUIEvent.h"
 
class CFxUIBaseViewImpl;
 
class COMMONUI_API CFxUIBaseView : public CFxUIObject
{
public:
 
    enum TextAlignment
    {
        //The horizontal flags are :
        AlignLeft = 0x0001, //Aligns with the left edge.
        AlignRight = 0x0002, //Aligns with the right edge.
        AlignHCenter = 0x0004, //Centers horizontally in the available space.
        AlignJustify = 0x0008, //Justifies the text in the available space.
        //The vertical flags are :
        AlignTop = 0x0020, //Aligns with the top.
        AlignBottom = 0x0040, //Aligns with the bottom.
        AlignVCenter = 0x0080, //Centers vertically in the available space.
        AlignBaseline = 0x0100, //Aligns with the baseline.
        AlignCenter = AlignVCenter | AlignHCenter //Centers in both dimensions.
    };
 
    enum FocusPolicyType
    {
        eNoFocus = 0, 
        eTabFocus = 0x1, 
        eClickFocus = 0x2, 
        eStrongFocus = eTabFocus | eClickFocus | 0x8, 
        eWheelFocus = eStrongFocus | 0x4, 
        eKeyboardOnSetfocus = 0x10 
    };
    enum UIWidthSizePolicy
    {
        eExpanding = -1,
        eXS = 0, 
        eS, 
        eM, 
        eL, 
        eXL 
    };
 
public:
 
    CFxUIBaseView();
 
    virtual ~CFxUIBaseView();
 
    void setDisabled( bool on );
 
    void setEnabled( bool on );
 
    bool isEnabled() const;
 
    CFxUIPalette::ColorRole backgroundRole();
 
    void setPalette( const CFxUIPalette & );
 
    const CFxUIPalette& palette() const;
 
    bool isVisible();
 
    void setVisible( bool bVisible );
 
    bool hasFocus() const;
 
    void setFocus();
 
    void setFocus( int iReason );
 
    void setFocusPolicy( int iPolicy );
 
    static void setTabOrder( CFxUIObject* first, CFxUIObject* second );
 
    int width();
 
    void setWidth(int w);
 
    int height();
 
    void setHeight(int h);
 
    void update();
 
    void setBusyState( bool bBusy = false );
 
    void resize( int w, int h );
 
    void setCornerRadius( float radius );
 
    void setBorderWidth( float width );
 
    void setBorderWidth( float left, float top, float right, float bottom );
 
    void setBorderColor( int r, int g, int b );
 
 
    virtual void showEvent( CFxUIShowEvent * event );
 
    virtual void hideEvent( CFxUIHideEvent * event );
 
    virtual void paintEvent( CFxUIPaintEvent * event );
 
    virtual void resizeEvent( CFxUIResizeEvent * event );
 
    virtual void focusInEvent( CFxUIFocusEvent* focusInEvent );
 
    virtual void focusOutEvent( CFxUIFocusEvent* focusOutEvent );
 
    void setEventAccepted( bool bAccepted = false );
 
    void addView( CFxUIBaseView *pChild, float fWeight = 0.0 );
 
    void insertView( CFxUIBaseView *pChild, int index = 0, float fWeight = 0.0 );
 
    int indexOf( CFxUIBaseView *pChild );
 
    void removeView( CFxUIBaseView *pChild );
 
    void setPreferableSize( int w, int h );
 
        void setMinimumWidth( int iWidth );
 
        void setMinimumHeight( int iHeight );
 
    void setMinimumSize( const CFxUISize& size );
 
        void setMaximumWidth( int iWidth );
 
        void setMaximumHeight( int iHeight );
 
    void setMaximumSize( const CFxUISize& size );
 
    int minimumWidth();
 
    int minimumHeight();
 
    int maximumWidth();
 
    int maximumHeight();
 
        void setToolTip(const CFxUIString& sToolTip);
 
        const CFxUIString toolTip();
 
    CFxUISignal<void( void )>& aboutToPassEventToParent();
 
    CFxUISignal<void( void )>& aboutToShow();
 
    CFxUISignal<void( void )>& hoverEnter();
 
    CFxUISignal<void( void )>& hoverLeave();
 
    CFxUISignal<void( bool )>& visibilityChanged( );
   
    //...
};