UTApp.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_APP_H_
#define _UT_APP_H_



//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTgui.h"
#include "UTMessageLoop.h"
#include "UTResource.h"
#include "UTMenuChangedTask.h"
#include "UTWindowsMenuTask.h"


//==================================================================================================
//=== Forward name declarations
//==================================================================================================
class InitializeMessage_t;
class AppPlatformInfo_t;


//==================================================================================================
class UTGUI_EXPORT App_t
//==================================================================================================
: public MessageLoop_t
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                                App_t(int app_name_string_resource_id);

    virtual                     ~App_t();

    virtual void                Start(int32 stack_size = 0);

    virtual void                SetTimeout(int32 timeout_ms);

    void                        MessageMightHaveTakenALongTime();

    static inline App_t*        App();

    static inline Resource_t*   AppResources();

    static void                 GetAppName(out String_t* name);

    void                        SetMDIMode( bool enable_mdi,
                                            window_show_mode_t mode = eWINSHOWMODE_maximized,
                                            const Rect_t& normal_mode_mdi_frame =
                                                                            Rect_t( 0, 0, 0, 0) );

    bool                        MDIMode();

    Rect_t                      NormalModeMDIFrame();

    window_show_mode_t          MDIWindowMode();

    void                        SetAppMenu(takes Menu_t* menu);

    inline Menu_t*              AppMenu();

    MessageDestination_t<Message_t>
                                QuitRequestReceiver();

    virtual void                QuitRequested();

    virtual void                CloseAllWindowsRequested(bool app_quit_requested);

    inline bool                 RunningInMain();

    virtual bool                IsQuitInProgress();

    virtual void                CancelQuit();

    //----------------------------------------------------------------------------------------------
    protected:
    //----------------------------------------------------------------------------------------------
    virtual void                Main();

    virtual void                SetMessageAvailEvent();

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    void                        MenuChanged();
    void                        HandleMenuChanged();
    inline void                 UpdateWindowsMenu();
    void                        WindowBecameFocus( Window_t* new_focus, bool newly_shown );
    void                        ContinueQuitOrCloseAllWindowsAsync();
    void                        ContinueQuitOrCloseAllWindows();

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    Resource_t                  m_resource;
    int                         m_app_name_string_resource_id;
    bool                        m_running_in_main;
    Menu_t*                     m_app_menu;
    bool                        m_menu_change_pending;
    MenuChangedTask_t           m_menu_changed_task;
    WindowsMenuTask_t           m_window_menu_task;
    LinkedList_t<Window_t>      m_windows;      // Head item is in focus
    bool                        m_close_all_windows_in_progress;
    bool                        m_close_all_windows_for_quit;

    static App_t*               ms_app;
    static AppPlatformInfo_t*   ms_platform_info;

    friend class AppPlatformInfo_t;
    friend class WndProcBase_t;
    friend class Window_t;
    friend class WindowController_t;
    friend class WindowPlatformInfo_t;
    friend class Menu_t;
    friend class MenuItem_t;
    friend class MenuChangedTask_t;
    friend class WindowsMenuTask_t;
    friend class ViewPlatformInfo_t;
    friend class MouseCaptureManager_t;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline App_t*
App_t::App()
{
    return ms_app;
}


inline Resource_t*
App_t::AppResources()
{
    return &ms_app->m_resource;
}


inline Menu_t*
App_t::AppMenu()
{
    return m_app_menu;
}


inline bool
App_t::RunningInMain()
{
    return m_running_in_main;
}


inline void
App_t::UpdateWindowsMenu()
{
    m_window_menu_task.UpdateWindowsMenu();
}


#endif // _UT_APP_H_