callback_caller_base.h

Go to the documentation of this file.

/*! \file
  \brief  The CallbackMethodCallerBase class.

  \par Copyright Information

  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd., Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef _CALLBACK_CALLER_BASE_H
#define _CALLBACK_CALLER_BASE_H

#include <cstddef>

namespace disti
{
// Forward references
class DisplayObject;
class DisplayEvent;

/** CallbackMethodCallerBase will be derived by any
    class desiring to use it.
    It allows for calling bound methods for specific objects
*/
class CallbackMethodCallerBase
{
protected:
    // Constructor is protected to force
    // derivation without making it pure virtual
    CallbackMethodCallerBase(){};

public:
    virtual ~CallbackMethodCallerBase() {}

    // Three paterns of methods are supported:
    // int Method(DisplayObject*, DisplayEvent*)
    //      This is for mouse and keyboard events.
    //      1 should be returned if event is handled, 0 otherwise
    virtual int Call( DisplayObject* /*target*/, DisplayEvent* ) { return 0; };
    // void Method(DisplayEvent* ev, void* callbackData)
    //      This is used mostly for user events
    //      The callbackData is generally passed in when this object is created.
    virtual void CallType2( DisplayEvent*, void* /*callbackData*/ = NULL ){};
    // void Method(void)
    //      Allows for a very simple callback, with no additional data passed.
    virtual void CallType3(){};

    virtual CallbackMethodCallerBase* Duplicate() const { return NULL; }

    virtual void SetContainer( DisplayObject* container ) = 0;
};

} // namespace disti
#endif