UTView.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// 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
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_VIEW_H_
#define _UT_VIEW_H_



//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTgui.h"
#include "UTLists.h"
#include "UTDrawable.h"


//==================================================================================================
//=== Types and constants
//==================================================================================================

const float c_label_colon_control_h_spacing = -1;

const float c_ok_cancel_etc_h_spacing = -2;

const float c_controls_h_spacing = -3;

const float c_controls_wide_h_spacing = -4;

const float c_dialog_body_to_ok_cancel_etc_v_spacing = -5;

const float c_controls_v_spacing = -6;

const float c_controls_wide_v_spacing = -7;


//==================================================================================================
//=== Forward name declarations
//==================================================================================================
class ViewPlatformInfo_t;
class Window_t;
class Region_t;


//==================================================================================================
class UTGUI_EXPORT View_t
//==================================================================================================
:   public LinkedListNode_t<View_t>,
    public Drawable_t
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                                View_t();

    virtual                     ~View_t();

    inline Window_t*            ParentWindow() const;

    inline View_t*              ParentView() const;

    virtual void                SetMinMaxSize(  float min_width,
                                                float max_width,
                                                float min_height,
                                                float max_height );

    inline float                MinWidth() const;

    inline float                MaxWidth() const;

    inline float                MinHeight() const;

    inline float                MaxHeight() const;

    inline const Rect_t&        LBounds() const;

    inline const Rect_t&        PFrame() const;

    void                        SetPFrame(const Rect_t& pframe);

    void                        Invalidate();

    void                        Invalidate(const Rect_t& rect);

    inline int                  CountChildren() const;

    inline View_t*              HeadChild() const;

    inline View_t*              TailChild() const;

    static float                RealPlatformSpacing(float spacing_constant);

    //----------------------------------------------------------------------------------------------
    protected:
    //----------------------------------------------------------------------------------------------
    virtual void                AddChild(takes View_t* child);

    virtual gives View_t*       RemoveChild(View_t* child);

    virtual void                LBoundsChanged( const Rect_t& old_lbounds,
                                                const Rect_t& new_lbounds );

    virtual void                ChildMinMaxSizeChanged(View_t* child);

    virtual void                Paint(const Region_t& clip_to);

    virtual void                SetBackgroundColor(const Color_t& color);

    Color_t                     BackgroundColor() const;

    void                        SetClearBackgroundBeforePaint(bool clear_before_paint);

    virtual void                MouseChanged(   const Point_t& point,
                                                bool mouse_inside_view,
                                                bool left_mouse_button_down,
                                                bool left_mouse_button_double_clicked,
                                                bool right_mouse_button_down_if_present );
    // TODO: MODIFIER KEYS!!!  Key notifications will only be generated for the keyboard focus view
    // The view under the mouse can't rely on that for modifier keys.

    virtual void                TrackMouseUntilButtonsReleased(bool enable = true);

    //----------------------------------------------------------------------------------------------
    public:     // Drawable_t overrides
    //----------------------------------------------------------------------------------------------
    virtual void                SetBrush(   const Color_t& color,
                                            float brush_width = 1,
                                            line_cap_type_t cap_type =
                                                                    eLCT_butt_extended_half_width );

    virtual void                SetFillColor(const Color_t& color);

    virtual void                DrawLine(   const Point_t& from,
                                            const Point_t& to,
                                            bool anti_alias = true );

    virtual void                DrawRect(   const Rect_t& rect,
                                            bool anti_alias = true,
                                            bool fill = false );

    virtual void                DrawText(   const String_t& string,
                                            const Point_t& where,
                                            bool anti_alias = true );

    void                        SetFont(const Font_t& font);

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
                                View_t(bool create_os_peer);
                                    // Constructor which doesn't necessarily create an OS view peer,
                                    // allowing a subclass to do so.

    void                        SetWindow(Window_t* window);
                                    // Sets the window pointer for this view and all child views.

    virtual void                WindowWillBeDeleted();
                                    // Platform implementation detail.

    virtual void                WindowHasBeenDeleted();
                                    // Platform implementation detail.

    void                        SetMinMaxSizeInternal(  float min_width,
                                                        float max_width,
                                                        float min_height,
                                                        float max_height );
                                    // Platform implementation detail.  Handles min/max size
                                    // changes, below any class restrictions prohibiting calls to
                                    // SetMinMaxSize, e.g. Button_t prohibits calls to
                                    // SetMinMaxSize other than by ButtonPlatformInfo_t when the
                                    // style has changed, in which case SetMinMaxSizeInternal is
                                    // used.

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    ViewPlatformInfo_t*         m_platform_info;
                                    // For View subclasses, this will be a ViewPlatformInfo_t
                                    // subclass
    Window_t*                   m_window;
    View_t*                     m_parent;
    Rect_t                      m_pframe;
    Rect_t                      m_lbounds;
    OwnedLinkedList_t<View_t>   m_children;
    Color_t                     m_background_color;
    bool                        m_clear_background_before_paint;
    bool                        m_track_mouse_allowed;
    bool                        m_track_mouse_enabled;

    float                       m_min_width;
    float                       m_min_height;
    float                       m_max_width;
    float                       m_max_height;

    friend class AppPlatformInfo_t;
    friend class ViewPlatformInfo_t;
    friend class MouseCaptureManager_t;
    friend class Window_t;
    friend class WindowPlatformInfo_t;
    friend class Button_t;
    friend class ButtonPlatformInfo_t;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline Window_t*
View_t::ParentWindow() const
{
    return m_window;
}


inline View_t*
View_t::ParentView() const
{
    return m_parent;
}


inline float
View_t::MinWidth() const
{
    return m_min_width;
}


inline float
View_t::MinHeight() const
{
    return m_min_height;
}


inline float
View_t::MaxWidth() const
{
    return m_max_width;
}


inline float
View_t::MaxHeight() const
{
    return m_max_height;
}


inline const Rect_t&
View_t::LBounds() const
{
    return m_lbounds;
}


inline const Rect_t&
View_t::PFrame() const
{
    return m_pframe;
}


inline int
View_t::CountChildren() const
{
    return m_children.CountItems();
}


inline View_t*
View_t::HeadChild() const
{
    return m_children.Head();
}


inline View_t*
View_t::TailChild() const
{
    return m_children.Tail();
}


#endif // _UT_VIEW_H_