PRM/PRM_PresetInfo.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        PRM_PresetInfo.h ( OP Library, C++)
 *
 * COMMENTS:    PresetInfo for an Operator type.
 */

#ifndef __PRM_PresetInfo__
#define __PRM_PresetInfo__

#include "PRM_API.h"
#include <iostream.h>
#include <UT/UT_Pair.h>
#include <UT/UT_String.h>
#include <UT/UT_PtrArray.h>

class PRM_ParmList;
class UT_StringArray;

typedef UT_Pair<UT_String, UT_String> UT_StringPair;
typedef UT_PtrArray<UT_StringPair *> UT_StringPairList;

#define PRM_DEFAULT_PRESET      "Permanent Defaults"

class PRM_API PRM_PresetInfo {
public:
                         PRM_PresetInfo(const char *subdir, const char *file);
    virtual             ~PRM_PresetInfo();

    void                 setIndexFile(const char *subdir);
    void                 setNeedsRefresh();

    int                  getNumPresets();
    const UT_String     &getPresetName(int i);
    const UT_String     &getPresetPath(int i);
    const UT_String     &getPresetFile();
    const UT_String     &getPresetSection();
    int                  getDefaultPreset();
    int                  getPresetIndex(const char *presetname);

    bool                 deletePresetFromDir(const char *name,
                                             const char *dir = 0);
    bool                 savePresetToDir(PRM_ParmList *parmlist,
                                         const char *name,
                                         const char *dir);
    bool                 loadPresetFile(PRM_ParmList *parmlist,
                                        const char *filename);
    bool                 savePresetFile(PRM_ParmList *parmlist,
                                        const char *filename);
    // This function makes sure the file name ends with ".preset".
    static void          makeValidPresetFileName(UT_String &filename);

    static const UT_StringArray &getValidSaveDirs();

    // Handle loading of basic contents (channels, values)
    static bool          loadPresetContents(PRM_ParmList *parmlist,
                                    const char *token, UT_IStream &is);

private:
    void                 clear();
    void                 findAllPresets();
    void                 refreshIfRequired();
    bool                 savePreset(PRM_ParmList *parmlist, ostream &os);
    bool                 loadPreset(PRM_ParmList *parmlist, UT_IStream &is);

    static int           comparePresets(UT_StringPair * const *p1,
                                        UT_StringPair * const *p2);

    UT_String            mySubdir;
    UT_String            myIndexFile;
    UT_String            myPresetFile;
    UT_String            myPresetSection;
    UT_StringPairList    myPresets;
    bool                 myNeedsRefresh;
};

#endif

---