UTMergedMenu.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.
//==================================================================================================


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTMenu.h"
#include "UTGUIPoolAllocator.h"


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


// \cond DOXYGEN_DOCUMENT_NEVER

//==================================================================================================
class MergedMenuNode_t
//==================================================================================================
: public LinkedListNode_t<MergedMenuNode_t>
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline                              MergedMenuNode_t();
    inline                              MergedMenuNode_t(MenuNode_t* real_node);
    inline                              ~MergedMenuNode_t();

    void                                MakeEmpty();

    void                                Merge(  Menu_t* app_menu,
                                                Menu_t* win_menu,
                                                bool menus_only );

    inline int                          CountItems() const;
    inline MergedMenuNode_t*            Head() const;

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

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    MenuNode_t*                         m_real_node;
    uint                                m_real_node_token;
    OwnedLinkedList_t<MergedMenuNode_t> m_contents;

    friend class MenuBar_t;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline
MergedMenuNode_t::MergedMenuNode_t()
{
    m_real_node = NULL;
    m_real_node_token = 0;
}


inline
MergedMenuNode_t::MergedMenuNode_t(MenuNode_t* real_node)
{
    m_real_node = real_node;
    m_real_node_token = real_node->m_token;
}


inline
MergedMenuNode_t::~MergedMenuNode_t()
{
    // Nothing to do
}


inline int
MergedMenuNode_t::CountItems() const
{
    return m_contents.CountItems();
}


inline MergedMenuNode_t*
MergedMenuNode_t::Head() const
{
    return m_contents.Head();
}


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


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


// \endcond