UTWindowsMenuTask.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_WINDOWS_MENU_TASK_H_
#define _UT_WINDOWS_MENU_TASK_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTMessage.h"
#include "UTTask.h"
#include "UTWindow.h"
#include "UTGUIPoolAllocator.h"


//==================================================================================================
//=== Forward name declarations
//==================================================================================================
class Menu_t;


// \cond DOXYGEN_DOCUMENT_NEVER


//==================================================================================================
//=== Constants
//==================================================================================================
const int c_approx_target_window_menu_size = 20;


//==================================================================================================
class ActivateWindowMessage_t
//==================================================================================================
: public Message_t
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline              ActivateWindowMessage_t(Window_t* window);
    inline Window_t*    Window() const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    Window_t*           m_window;
};


//==================================================================================================
class WindowListEntry_t
//==================================================================================================
: public LinkedListNode_t<WindowListEntry_t>
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline                                  WindowListEntry_t();
    inline                                  WindowListEntry_t(  Window_t* window,
                                                                WindowListEntry_t* parent );

    inline WindowListEntry_t*               ListHead();
    WindowListEntry_t*                      AddParentsAndWindowUnlessExists(    Window_t* window,
                                                                                int* total_count );
    void                                    TrimWindowsListSize(int* total_count);
    int                                     CountNodesIncludingSelf();
    void                                    AlphabeticalSortWindows();
    WindowListEntry_t*                      NextInFlatList();
    int                                     SubordinateDepth();
    inline Window_t*                        Window() const;

    inline void*                            operator new(size_t size);
    inline void                             operator delete(void* block);

    inline bool                             operator <(const WindowListEntry_t& other) const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    Window_t*                               m_window;
    WindowListEntry_t*                      m_parent;
    OwnedLinkedList_t<WindowListEntry_t>    m_contents;

    friend class WindowsMenuTask_t;
};


//==================================================================================================
class WindowsMenuTask_t
//==================================================================================================
: public Task_t
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                        WindowsMenuTask_t();
    void                SetWindowMenu(Menu_t* menu);
    void                UpdateWindowsMenu();


    static void         CreateWindowsMenuList(  WindowListEntry_t* root_entry,
                                                out bool* more_windows_are_not_in_list );
    static void         CreateWindowsMenuList(WindowListEntry_t* root_entry);
    static void         AddWindowsInUseOrder( WindowListEntry_t* root_entry, int* total_count );

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    Menu_t*             m_windows_menu;
    String_t            m_more_string;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    void CascadeWindowsReceived(const Message_t* message);
    MessageReceiver_t< WindowsMenuTask_t, Message_t > m_CascadeWindowsReceiver;

    void TileHorizontalReceived(const Message_t* message);
    MessageReceiver_t< WindowsMenuTask_t, Message_t > m_TileHorizontalReceiver;

    void TileVerticalReceived(const Message_t* message);
    MessageReceiver_t< WindowsMenuTask_t, Message_t > m_TileVerticalReceiver;

    void CloseAllWindowsReceived(const Message_t* message);
    MessageReceiver_t< WindowsMenuTask_t, Message_t > m_CloseAllWindowsReceiver;

    void ActivateWindowReceived(const ActivateWindowMessage_t* message);
    MessageReceiver_t< WindowsMenuTask_t, ActivateWindowMessage_t > m_ActivateWindowReceiver;

    void MoreWindowsListReceived(const Message_t* message);
    MessageReceiver_t< WindowsMenuTask_t, Message_t > m_MoreWindowsListReceiver;

    void DeferredWindowClosedReceived(const Message_t* message);
    MessageReceiver_t< WindowsMenuTask_t, Message_t > m_DeferredWindowClosedReceiver;

    friend class App_t;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations: class ActivateWindowMessage_t
//===
//==================================================================================================
//==================================================================================================
inline
ActivateWindowMessage_t::ActivateWindowMessage_t(Window_t* window)
{
    m_window = window;
}


inline Window_t*
ActivateWindowMessage_t::Window() const
{
    return m_window;
}




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations: class WindowListEntry_t
//===
//==================================================================================================
//==================================================================================================
inline
WindowListEntry_t::WindowListEntry_t()
{
    m_window = NULL;
    m_parent = NULL;
}


inline
WindowListEntry_t::WindowListEntry_t( Window_t* window, WindowListEntry_t* parent )
{
    m_window = window;
    m_parent = parent;
}


inline WindowListEntry_t*
WindowListEntry_t::ListHead()
{
    return m_contents.Head();
}


inline Window_t*
WindowListEntry_t::Window() const
{
    return m_window;
}


inline void*
WindowListEntry_t::operator new(size_t size)
{
    return g_gui_pool_allocator.Allocate(size);
}


inline void
WindowListEntry_t::operator delete(void* block)
{
    g_gui_pool_allocator.Release(block);
}


inline bool
WindowListEntry_t::operator <(const WindowListEntry_t& other) const
{
    assert(m_window && other.m_window);
    return (m_window->Title().CompareIgnoreCase( other.m_window->Title() ) < 0);
}


// \endcond

#endif // _UT_WINDOWS_MENU_TASK_H_