fbgenericmenu.h

Go to the documentation of this file.

#ifndef __GENERIC_MENU_H__
#define __GENERIC_MENU_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, which is 
 protected by Canada and United States of America federal copyright law 
 and by international treaties.
 
 The Data may not be disclosed or distributed to third parties, in whole 
 or in part, without the prior written consent of Autodesk, Inc. 
 ("Autodesk").
 
 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
 FREE.
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL
    #define FBSDK_DLL K_DLLEXPORT
#endif

#include <fbsdk/fbcomponent.h>
#include <fbcontrols/fbcontrols.h>

K_FORWARD( IKtObject );


#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

__FB_FORWARD( FBGenericMenuItem );
__FB_FORWARD( FBGenericMenu );
__FB_FORWARD( FBMenuManager );
FB_DEFINE_COMPONENT( FBSDK_DLL, GenericMenuItem );
FB_DEFINE_COMPONENT( FBSDK_DLL, GenericMenu );
FB_DEFINE_COMPONENT( FBSDK_DLL, MenuManager );

class  FBSDK_DLL FBGenericMenuItem : public FBComponent {
    __FBClassDeclare( FBGenericMenuItem, FBComponent );
public:      
    FBGenericMenuItem(HIObject pObject);  

    FBPropertyString Caption; 
    FBPropertyInt Id; 
    FBPropertyBool Enable; 
    FBPropertyGenericMenu Menu; 
};

class  FBSDK_DLL FBGenericMenu : public FBComponent {
    __FBClassDeclare( FBGenericMenu, FBComponent );
public:
    FBGenericMenu(HIObject pObject=NULL);

    virtual void FBDelete() override;
    
    FBGenericMenuItem* GetFirstItem();

    FBGenericMenuItem* GetLastItem();

    FBGenericMenuItem* GetNextItem(FBGenericMenuItem* pItem);

    FBGenericMenuItem* GetPrevItem(FBGenericMenuItem* pItem);

    FBGenericMenuItem* GetItem( int pItemId );

    FBGenericMenuItem* InsertFirst(const char*  pItemName, int pItemId, FBGenericMenu* pMenu = NULL);

    FBGenericMenuItem* InsertLast(const char*  pItemName, int pItemId, FBGenericMenu* pMenu = NULL);

    FBGenericMenuItem* InsertAfter(FBGenericMenuItem* pBeforeItem, const char*  pItemName, int pItemId, FBGenericMenu* pMenu = NULL);

    FBGenericMenuItem* InsertBefore(FBGenericMenuItem* pAfterItem, const char*  pItemName, int pItemId, FBGenericMenu* pMenu = NULL);
    
    void DeleteItem(FBGenericMenuItem* pToDelete);

    FBGenericMenuItem* Execute(int pX, int pY, bool pRightAlign = true);


    FBPropertyEvent OnMenuActivate; 
private:
    friend class FBMenuManager;
    friend class DataFBMenuManager;
    friend class DataFBGenericMenu;
};

class  FBSDK_DLL FBMenuManager : public FBComponent {
    __FBClassDeclare( FBMenuManager, FBComponent );
public:
    FBMenuManager();
    
    FBGenericMenu* GetMenu(const char*  pPath);

    FBGenericMenuItem* InsertFirst(const char*  pMenuPath, const char*  pMenuName);

    FBGenericMenuItem* InsertLast(const char*  pMenuPath, const char*  pMenuName);

    FBGenericMenuItem* InsertBefore(const char*  pMenuPath, const char*  pAfterMenuName, const char*  pMenuName);    

    FBGenericMenuItem* InsertAfter(const char*  pMenuPath, const char*  pBeforeMenuName, const char*  pMenuName);    

    void SetItemEnable(const char*  pMenuPath, int pItemId, bool pEnable );

    bool IsItemEnable(const char*  pMenuPath, int pItemId);
private:
    FBGenericMenuItem* GetMenuItem(const char*  pMenuPath, const char*  pMenuName, int pId );

public:
    bool ExecuteMenuItem( const char* pMenuPath, int pMenuItemID );

    bool ExecuteMenuItemFromFullPath( const char* pMenuItemFullPath );
};



#ifdef FBSDKUseNamespace
    }
#endif

#endif