pawsmenu.h

Go to the documentation of this file.

/*
 * pawsmenu.h - Author: Ondrej Hurt
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * 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 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef PAWS_MENU_HEADER
#define PAWS_MENU_HEADER

#include <csutil/parray.h>
#include <iutil/document.h>
#include "pawswidget.h"
#include "pawstextbox.h"
#include "pawsbutton.h"


class pawsIMenu;
class pawsMenu;
class pawsIMenuItem;
class pawsMenuItem;

class pawsMenuAction
{
public:
    csString name;
    csArray<csString> params;
};

#define MENU_DESTROY_ACTION_NAME "MenuWantsDestroy"

//-----------------------------------------------------------------------------
//                          interface pawsIMenu
//-----------------------------------------------------------------------------

enum pawsMenuClose
{
    closeAction,          
    closeSiblingOpened,   
    closeCloseClicked,    
    closeParentClosed,    
    closeChildClosed      
};

class pawsIMenu : public pawsWidget
{
public:
    pawsIMenu() {  };

    pawsIMenu(const pawsIMenu &origin): pawsWidget(origin)
    {

    }

    virtual void SetParentMenu(pawsIMenu* parentMenu) = 0;

    virtual void OnParentMenuDestroyed(pawsMenuClose reason) = 0;

    virtual void OnChildMenuDestroyed(pawsIMenu* child, pawsMenuClose reason) = 0;

    virtual void OnSiblingOpened() = 0;

    virtual void DoAction(pawsIMenuItem* item) = 0;

    virtual void SetNotify(pawsWidget* notifyTarget) = 0;

};


//-----------------------------------------------------------------------------
//                            class pawsMenu
//-----------------------------------------------------------------------------

enum pawsMenuAlign {alignLeft, alignCenter};


class pawsMenu : public pawsIMenu
{
public:
    pawsMenu();
    ~pawsMenu();
    pawsMenu(const pawsMenu &origin);

    //from pawsWidget:
    virtual bool OnButtonPressed(int button, int keyModifier, pawsWidget* widget);
    virtual bool OnMouseDown(int button, int modifiers, int x, int y);
    virtual bool Setup(iDocumentNode* node);
    virtual bool PostSetup();
    virtual void Draw();

    //from pawsIMenu:
    virtual void SetParentMenu(pawsIMenu* parentMenu);
    virtual void OnParentMenuDestroyed(pawsMenuClose reason);
    virtual void OnChildMenuDestroyed(pawsIMenu* child, pawsMenuClose reason);
    virtual void OnSiblingOpened();
    virtual void DoAction(pawsIMenuItem* item);
    virtual void SetNotify(pawsWidget* notifyTarget);


    /* Adds 'item' to the menu, before the 'nextItem' item.
     * If 'nextItem' is NULL, item is added to the end.
     * OWNERSHIP of 'item' goes to pawsMenu
     */
    void AddItem(pawsIMenuItem* item, pawsIMenuItem* nextItem=NULL);

    void DeleteItem(pawsIMenuItem* item);

    void SetItemAction(pawsIMenuItem* item, const pawsMenuAction &action);

    bool HasSubmenus();

protected:
    void SetPositionsOfItems();

    void SendOnMenuAction(const pawsMenuAction &action);

    void SendDestroyAction();

    void DestroyMenu(pawsMenuClose reason);

    int GetContentWidth();
    int GetContentHeight();

    void Autosize();

    void SetSubmenuPos(pawsMenu* submenu, int recommY);

    csPtr<iDocumentNode> FindSubmenuNode(iDocumentNode* node, const csString &name);

    void SetButtonPositions();


    pawsIMenu* parentMenu;

    csArray<pawsIMenuItem*> items;

    csArray<pawsIMenu*> submenus;

    pawsWidget* notifyTarget;

    pawsButton* stickyButton, * closeButton;
    pawsTextBox* label;

    csRef<iPawsImage> arrowImage;    // image of right arrow indicating that menu item invokes a submenu

    pawsMenuAlign align;

    bool autosize;

    bool sticky;

    iGraphics2D* graphics2d;
};

CREATE_PAWS_FACTORY(pawsMenu);

//-----------------------------------------------------------------------------
//                            class pawsMenuItem
//-----------------------------------------------------------------------------

class pawsIMenuItem : public pawsWidget
{
public:
    pawsIMenuItem() {}
    pawsIMenuItem(const pawsIMenuItem &origin):pawsWidget(origin)
    {

    }
    virtual void Invoke()
    {
    }

    virtual void SetAction(const pawsMenuAction & /*action*/)
    {
    }
    virtual pawsMenuAction GetAction()
    {
        pawsMenuAction action;
        return action;
    }
};

class pawsMenuItem : public pawsIMenuItem
{
public:
    pawsMenuItem();
    pawsMenuItem(const pawsMenuItem &origin);
    //from pawsWidget:
    virtual bool Load(iDocumentNode* node);
    virtual bool Setup(iDocumentNode* node);
    virtual void Draw();

    //from pawsIMenuItem:
    virtual void Invoke();
    void SetAction(const pawsMenuAction &action);
    pawsMenuAction GetAction()
    {
        return action;
    }

    void EnableCheckbox(bool enable);
    void EnableImage(bool enable);

    void SetImage(const csString &newImage);
    void SetLabel(const csString &newLabel);

    void SetCheckboxImages(const csString &on, const csString &off);

    void SetCheckboxState(bool checked);

    void SetSizes(int labelWidth, int spacing, int border);

protected:
    void SetLayout();

    virtual void LoadAction(iDocumentNode* node);


    pawsWidget* image;
    pawsTextBox* label;
    pawsButton* checkbox;

    pawsMenuAction action;

    bool imageEnabled, checkboxEnabled;

    int spacing;

    int border;

    iGraphics2D* graphics2d;
};

CREATE_PAWS_FACTORY(pawsMenuItem);


//-----------------------------------------------------------------------------
//                            menu separator
//-----------------------------------------------------------------------------

class pawsMenuSeparator : public pawsIMenuItem
{
public:
    pawsMenuSeparator();
    pawsMenuSeparator(const pawsMenuSeparator &origin);
    // from pawsWidget:
    virtual void Draw();

protected:
    iGraphics2D* graphics2d;
};

CREATE_PAWS_FACTORY(pawsMenuSeparator);


#endif