popupmenu_item.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
*/


#pragma once

#include "../api_gui.h"
#include "../gui_component.h"

class CL_PixelBuffer;
class CL_PopupMenuItem_Impl;
class CL_PopupMenu;

class CL_PopupMenuItem
{

public:
        CL_PopupMenuItem();

        CL_PopupMenuItem(int id);

        CL_PopupMenuItem(const CL_SharedPtr<CL_PopupMenuItem_Impl> &impl);

        virtual ~CL_PopupMenuItem();


public:

        CL_StringRef get_text() const;

        CL_StringRef get_accelerator_text() const;

        int get_id() const;

        bool is_null() const;

        bool has_submenu() const;

        bool is_disabled() const;

        bool is_separator() const;

        CL_PopupMenu get_submenu();

        bool is_checkable() const;

        bool is_checked() const;

        CL_PixelBuffer get_icon() const;


public:

        CL_Callback_v0 &func_clicked();


public:

        void set_id(int id);

        void set_text(const CL_StringRef &text);

        void set_icon(const CL_PixelBuffer &image);

        void set_submenu(CL_PopupMenu &submenu);

        void set_enabled(bool enabled);

        void set_separator(bool separator);

        void set_accelerator_text(const CL_StringRef &str);

        void set_checkable(bool checkable);

        void set_checked(bool checked);


private:
        CL_SharedPtr<CL_PopupMenuItem_Impl> impl;
};

---