accelerator_key.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 **    Harry Storbacka
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "api_gui.h"
00035 #include "../Core/System/sharedptr.h"
00036 #include "../Core/Signals/callback_v2.h"
00037 #include "../GUI/gui_message.h"
00038 #include "../GUI/gui_message_input.h"
00039 #include <vector>
00040 
00041 class CL_AcceleratorKey_Impl;
00042 
00046 class CL_AcceleratorKey
00047 {
00050 
00051 public:
00053         CL_AcceleratorKey();
00054 
00061         CL_AcceleratorKey(int id, int mod1=-1, int mod2=-1, int mod3=-1);
00062 
00063         ~CL_AcceleratorKey();
00064 
00068 
00069 public:
00070         CL_Callback_v2<CL_GUIMessage, CL_AcceleratorKey> &func_pressed();
00071 
00075         bool get_shift() const;
00076 
00080         bool get_alt() const;
00081 
00085         bool get_ctrl() const;
00086 
00090         int get_id() const;
00091 
00093         bool is_null() const { return impl ? true : false; }
00094 
00096         void throw_if_null() const;
00097 
00098 
00102 
00103 public:
00104 
00106         void set_shift(bool);
00107 
00109         void set_alt(bool);
00110 
00112         void set_ctrl(bool);
00113 
00115         void set_id(int);
00116 
00117 
00121 
00122 private:
00123         CL_SharedPtr<CL_AcceleratorKey_Impl> impl;
00125 };
00126