popupmenu_item.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 **    Harry Storbacka
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_gui.h"
00036 #include "../gui_component.h"
00037 
00038 class CL_PixelBuffer;
00039 class CL_PopupMenuItem_Impl;
00040 class CL_PopupMenu;
00041 
00045 class CL_PopupMenuItem
00046 {
00049 
00050 public:
00052         CL_PopupMenuItem();
00053 
00057         CL_PopupMenuItem(int id);
00058 
00062         CL_PopupMenuItem(const CL_SharedPtr<CL_PopupMenuItem_Impl> &impl);
00063 
00064         virtual ~CL_PopupMenuItem();
00065 
00069 
00070 public:
00071 
00075         CL_StringRef get_text() const;
00076 
00080         CL_StringRef get_accelerator_text() const;
00081 
00085         int get_id() const;
00086 
00088         bool is_null() const { return !impl; }
00089 
00091         void throw_if_null() const;
00092 
00096         bool has_submenu() const;
00097 
00101         bool is_disabled() const;
00102 
00106         bool is_separator() const;
00107 
00111         CL_PopupMenu get_submenu();
00112 
00116         bool is_checkable() const;
00117 
00121         bool is_checked() const;
00122 
00126         CL_PixelBuffer get_icon() const;
00127 
00131 
00132 public:
00133 
00137         CL_Callback_v0 &func_clicked();
00138 
00142 
00143 public:
00144 
00148         void set_id(int id);
00149 
00153         void set_text(const CL_StringRef &text);
00154 
00158         void set_icon(const CL_PixelBuffer &image);
00159 
00163         void set_submenu(CL_PopupMenu &submenu);
00164 
00168         void set_enabled(bool enabled);
00169 
00173         void set_separator(bool separator);
00174 
00178         void set_accelerator_text(const CL_StringRef &str);
00179 
00183         void set_checkable(bool checkable);
00184 
00188         void set_checked(bool checked);
00189 
00193 
00194 private:
00195         CL_SharedPtr<CL_PopupMenuItem_Impl> impl;
00197 };
00198