102 lines
3.2 KiB
C++
Executable File
102 lines
3.2 KiB
C++
Executable File
|
|
#ifndef _MUserEventMessage
|
|
#define _MUserEventMessage
|
|
//
|
|
//-
|
|
// ==========================================================================
|
|
// Copyright (C) Alias Systems, a division of Silicon Graphics Limited.
|
|
// All rights reserved. These coded instructions, statements and computer
|
|
// programs contain unpublished information proprietary to Alias Systems,
|
|
// a division of Silicon Graphics Limited, which is protected by the
|
|
// Canadian and US federal copyright law and may not be disclosed to third
|
|
// parties or copied or duplicated, in whole or in part, without prior
|
|
// written consent of Alias Systems, a division of Silicon Graphics Limited
|
|
// ==========================================================================
|
|
//+
|
|
//
|
|
// CLASS: MUserEventMessage
|
|
//
|
|
// *****************************************************************************
|
|
//
|
|
// CLASS DESCRIPTION (MUserEventMessage)
|
|
//
|
|
// This class is used to register user-defined event types, register
|
|
// callbacks with the user-defined event types, and to post user-defined
|
|
// messages.
|
|
//
|
|
// The registerUserEvent and deregisterUserEvent methods allow user event
|
|
// types to be created and destroyed. User events are identified by a unique
|
|
// string identifier.
|
|
//
|
|
// The addCallback method registers a function that will be executed
|
|
// whenever the specified message occurs. An id is returned and is used
|
|
// to remove the callback.
|
|
//
|
|
// The postUserEvent notifies all registered callbacks of the occurence of a
|
|
// user-defined event.
|
|
//
|
|
// To remove a callback use MMessage::removeCallback.
|
|
// All callbacks that are registered by a plug-in must be removed by that
|
|
// plug-in when it is unloaded. Failure to do so will result in a fatal error.
|
|
//
|
|
// *****************************************************************************
|
|
|
|
#if defined __cplusplus
|
|
|
|
// *****************************************************************************
|
|
|
|
// INCLUDED HEADER FILES
|
|
|
|
|
|
#include <maya/MMessage.h>
|
|
|
|
// *****************************************************************************
|
|
|
|
// DECLARATIONS
|
|
|
|
// *****************************************************************************
|
|
|
|
// CLASS DECLARATION (MUserEventMessage)
|
|
|
|
/// User-defined Message Types
|
|
/**
|
|
*/
|
|
#ifdef _WIN32
|
|
#pragma warning(disable: 4522)
|
|
#endif // _WIN32
|
|
|
|
class OPENMAYA_EXPORT MUserEventMessage : public MMessage
|
|
{
|
|
public:
|
|
|
|
///
|
|
static MStatus registerUserEvent( const MString& event );
|
|
///
|
|
static bool isUserEvent( const MString& event );
|
|
///
|
|
static MStatus deregisterUserEvent( const MString& event );
|
|
///
|
|
static MCallbackId addUserEventCallback(
|
|
const MString& event,
|
|
void (*func)( void* clientData ),
|
|
void * clientData = NULL,
|
|
MStatus * ReturnStatus = NULL );
|
|
///
|
|
static MStatus postUserEvent(
|
|
const MString& event,
|
|
void* clientData = NULL );
|
|
|
|
private:
|
|
|
|
static const char* className();
|
|
};
|
|
|
|
#ifdef _WIN32
|
|
#pragma warning(default: 4522)
|
|
#endif // _WIN32
|
|
|
|
// *****************************************************************************
|
|
|
|
#endif /* __cplusplus */
|
|
#endif /* _MUserEventMessage */
|