FxPluginModule.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2023 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
/*       IMPORTANT: DO NOT CHANGE THIS FILE!      */
 
/* This class gets inherited by your custom class. */
 
#include "FxPluginModuleInternal.h"
#include "FxPluginModuleDefines.h"
#include "FxModule.h"
 
#include "FxPragmaPush.h"
 
// Inherit from this class to initialise your plugin
class DDKERNEL_API CFxPluginModule : public CFxModule
{
public:
    // Constructs the module and sets the GUID keys for the module used for encryption.
    CFxPluginModule(const CFxString& sGUIDs) : CFxModule() 
    { 
        internal = GetCFxPluginModuleInternal(); 
        addGUIDs( sGUIDs );
    }
 
    ~CFxPluginModule() override { delete internal; }
 
    // You need to implement these methods. These are replacements for initApp and uninitApp.
    virtual void init() = 0;
    virtual void uninit() = 0;
 
    // Add valid GUIDs for this DRX file.
    // The GUID is the same as in the PLG or XML file.
    // Call this method in your init() implementation
    void addGUID(const CFxString& sGUID ) { internal->addGUID(sGUID); }
    void addGUIDs(const CFxString& sGUIDs) { internal->addGUIDs(sGUIDs); }
 
    // Method is called from application on different events.
    int event( ModuleEvent e, CFxEventData* pData = 0 ) override { return 0; }
 
    CFxPluginModuleInternal* internal;
    FX_PLUGINMODULE_INTERNAL
};
 
#include "FxPragmaPop.h"