FxProfile.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 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
 
#include "DDKERNEL.h"
 
#include "FxString.h"
#include "FxFavouriteFiles.h"
 
#include "FxPragmaPush.h"
 
class CFxProfileStorage;
class CFxSettings;
class CFxSystemFiles;
class CFxRecentFiles;
class CFxPreferences;

class DDKERNEL_API CFxProfile
{
public:
    virtual ~CFxProfile() {};
 
    virtual CFxString GetName() const = 0;
 
    virtual CFxString GetDescription() const = 0;

    virtual CFxSettings* GetSettings() = 0;

    virtual CFxProfileStorage* GetStorage( bool bCreateIfNotExists ) = 0;

    virtual CFxSystemFiles* GetSystemFiles() = 0;

    virtual CFxRecentFiles* GetRecentFiles() = 0;

    virtual CFxString ResolveAlias( const CFxString& strAlias ) const = 0;

    virtual void LoadAliases() = 0;

    virtual CFxPreferences* GetPreferences() = 0;

    virtual void Flush() = 0;

    virtual CFxFavouriteFiles* GetFavouriteFiles() = 0;
};

class DDKERNEL_API CFxProfileManagerReactor
{
public:
    virtual ~CFxProfileManagerReactor() {};

    virtual void currentProfileWillChange( const CFxString& newProfile ) {};

    virtual void currentProfileChanged( const CFxString& newProfile ) {};

    virtual void currentProfileWillBeReset( const CFxString& currentProfile ) {};

    virtual void currentProfileReset( const CFxString& currentProfile ) {};

    virtual void currentProfileWillBeSaved( const CFxString& currentProfile, CFxSettings* pCurrentProfileSettings ) {};

    virtual void currentProfileWillBeLoaded( const CFxString& currentProfile, CFxSettings* pCurrentProfileSettings ) {};

    virtual void currentProfileSaved( const CFxString& currentProfile ) {};

    virtual void currentProfileLoaded( const CFxString& currentProfile ) {};

    virtual void profileWillReset( const CFxString& profileName ) {};

    virtual void profileReset( const CFxString& profileName ) {};

    virtual void profileWillBeSaved( const CFxString& profileName, CFxSettings* pProfileSettings ) {};

    virtual void profileWillBeLoaded( const CFxString& profileName, CFxSettings* pProfileSettings ) {};

    virtual void profileSaved( const CFxString& profileName ) {};

    virtual void profileLoaded( const CFxString& profileName ) {};
};
 
typedef OdArray<CFxString> CFxProfileNameArray;

class DDKERNEL_API CFxProfileManager
{
public:
    virtual void ProfileRegistryKey( CFxString& strRegProfileKey, const CFxString& strProfileName ) = 0;

    virtual int ProfileListNames( CFxProfileNameArray& nameList ) = 0;

    virtual int ProfileExport( const CFxString& strProfileName, const CFxString& exportFileName ) = 0;

    virtual int ProfileImport( const CFxString& strProfileName, const CFxString& importFileName, const CFxString& profileDescription, bool bImportPathInfo ) = 0;

    virtual int ProfileDelete( const CFxString& strProfileName ) = 0;

    virtual int ProfileReset( const CFxString& strProfileName ) = 0;

    virtual int ProfileSetCurrent( const CFxString& strProfileName ) = 0;
 
    virtual CFxProfile* ProfileGetCurrent() = 0;
 
    virtual CFxProfile* ProfileGetFixed() = 0;
 
    virtual CFxProfile* ProfileGet( const CFxString& strProfileName ) = 0;

    virtual int ProfileCopy( const CFxString& newProfileName, const CFxString& oldProfileName, const CFxString& newProfileDesc ) = 0;

    virtual int ProfileRename( const CFxString& newProfileName, const CFxString& oldProfileName, const CFxString& newProfileDesc ) = 0;

    virtual int ProfileSave( const CFxString& profileName ) = 0;

    virtual void addReactor( CFxProfileManagerReactor* ) = 0;

    virtual void removeReactor( CFxProfileManagerReactor* ) = 0;
};
 
#define currProfile() GetFxSystemServices()->GetFxProfileManager()->ProfileGetCurrent()
 
class QDomNode;

class DDKERNEL_API CFxProfileStorage
{
public:
    virtual ~CFxProfileStorage() {};

    virtual int CreateNode( const CFxString& pszNodePath, QDomNode*& pNode ) = 0;

    virtual int GetNode( const CFxString& pszNodePath, QDomNode*& pNode ) = 0;

    virtual int ReplaceNode( const CFxString& pszNodePath, QDomNode* pNode ) = 0;

    virtual int DeleteNode( const CFxString& pszNodePath ) = 0;

    virtual int GetStorageFile( CFxString& fileName ) = 0;

    virtual int Save( void ) = 0;
};
 
#include "FxPragmaPop.h"