Spinning Topp Logo BlackTopp Studios
inc
action.cpp
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _uiaction_cpp
41 #define _uiaction_cpp
42 
43 #include "UI/action.h"
44 
45 namespace Mezzanine
46 {
47  namespace UI
48  {
49  const String Action::EventActionActivated = "ActionActivated";
50  const String Action::EventActionDeactivated = "ActionDeactivated";
51 
52  Action::Action(const String& Name, ActionHandler* Handler)
53  : ActionName(Name),
54  Parent(Handler)
55  {
56  this->AddEvent(Action::EventActionActivated);
57  this->AddEvent(Action::EventActionDeactivated);
58  }
59 
61  {
62  }
63 
64  ///////////////////////////////////////////////////////////////////////////////
65  // Utility
66 
67  const String& Action::GetName() const
68  {
69  return this->ActionName;
70  }
71 
72  ///////////////////////////////////////////////////////////////////////////////
73  // Internal Methods
74 
76  {
77  EventArgumentsPtr Args( new ActionEventArguments(Action::EventActionActivated,this->ActionName) );
78  this->FireEvent(Args);
79  }
80 
82  {
83  EventArgumentsPtr Args( new ActionEventArguments(Action::EventActionDeactivated,this->ActionName) );
84  this->FireEvent(Args);
85  }
86 
88  {
89  return false;
90  }
91  }//UI
92 }//Mezzanine
93 
94 #endif
const String & GetName() const
Gets the name of this Action.
Definition: action.cpp:67
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
A simple reference counting pointer.
Definition: countedptr.h:70
void _OnActivateAction()
Runs all logic associated with this Action being activated.
Definition: action.cpp:75
const String ActionName
The name of this action.
Definition: action.h:123
This class is the core class responsible for the management of actions.
Definition: actionhandler.h:54
~Action()
Class destructor.
Definition: action.cpp:60
Event * AddEvent(const String &EventName)
Creates a new event this Publisher can fire.
void FireEvent(EventArgumentsPtr Args)
Fires an event.
Action(const String &Name, ActionHandler *Handler)
Class constructor.
Definition: action.cpp:52
This Determines the kind of user input.
Definition: metacode.h:93
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
This is the base class for action specific event arguments.
Definition: action.h:55
static const String EventActionActivated
Event name for when this Action is activated.
Definition: action.h:116
Boole _HandleInput(const Input::MetaCode &Code)
Handles input passed to this Action.
Definition: action.cpp:87
void _OnDeactivateAction()
Runs all logic associated with this Action being deactivated.
Definition: action.cpp:81
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
static const String EventActionDeactivated
Event name for when this Action is deactivated.
Definition: action.h:118