GL Studio C++ Runtime API
callback_caller_base.h
Go to the documentation of this file.
1/// \file callback_caller_base.h
2/// \brief The CallbackMethodCallerBase class.
3///
4/// \par Copyright Information
5///
6/// Copyright (c) 2017 by The DiSTI Corporation.<br>
7/// 12249 Science Drive; Suite 300<br>
8/// Orlando, Florida 32826<br>
9/// USA<br>
10/// <br>
11/// All rights reserved.<br>
12///
13/// This Software contains proprietary trade secrets of DiSTI and may not be
14/// reproduced, in whole or part, in any form, or by any means of electronic,
15/// mechanical, or otherwise, without the written permission of DiSTI. Said
16/// permission may be derived through the purchase of applicable DiSTI product
17/// licenses which detail the distribution rights of this content and any
18/// Derivative Works based on this or other copyrighted DiSTI Software.
19///
20/// NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
21/// AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
22/// PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
23/// AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
24/// IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
25/// PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
26///
27/// LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
28/// IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
29/// INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
30/// DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
31/// INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
32/// INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
33/// OF SUCH DAMAGES. DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
34/// EXCEED FIVE DOLLARS (US$5.00).
35///
36/// The aforementioned terms and restrictions are governed by the laws of the
37/// State of Florida and the United States of America.
38
39#ifndef INCLUDED_DISTI_CALLBACK_CALLER_BASE_H
40#define INCLUDED_DISTI_CALLBACK_CALLER_BASE_H
41
42#include <cstddef>
43
44namespace disti
45{
46// Forward references
47class DisplayObject;
48class DisplayEvent;
49
50/** CallbackMethodCallerBase will be derived by any
51 class desiring to use it.
52 It allows for calling bound methods for specific objects
53*/
55{
56protected:
57 // Constructor is protected to force
58 // derivation without making it pure virtual
60
61public:
62 virtual ~CallbackMethodCallerBase() {}
63
64 /// This is for mouse and keyboard events.
65 /// \return 1 if event is handled, 0 otherwise.
66 virtual int Call( DisplayObject* /*target*/, DisplayEvent* ) { return 0; };
67
68 /// This is used mostly for user events.
69 /// The callbackData is generally passed in when this object is created.
70 virtual void CallType2( DisplayEvent*, void* /*callbackData*/ = NULL ){};
71
72 /// Allows for a very simple callback, with no additional data passed.
73 virtual void CallType3(){};
74
75 /// \return A pointer to an exact copy of this callback object.
76 virtual CallbackMethodCallerBase* Duplicate() const { return NULL; }
77
78 /// Assign a new object to be the target of this callback.
79 /// \param container The new target object.
80 virtual void SetContainer( DisplayObject* container ) = 0;
81};
82
83} // namespace disti
84#endif
Definition: callback_caller_base.h:55
virtual CallbackMethodCallerBase * Duplicate() const
Definition: callback_caller_base.h:76
virtual void CallType3()
Allows for a very simple callback, with no additional data passed.
Definition: callback_caller_base.h:73
virtual void SetContainer(DisplayObject *container)=0
virtual int Call(DisplayObject *, DisplayEvent *)
Definition: callback_caller_base.h:66
virtual void CallType2(DisplayEvent *, void *=NULL)
Definition: callback_caller_base.h:70
Definition: events.h:111
Definition: display.h:95
Definition: bmpimage.h:46