preferences_page.h

Go to the documentation of this file.

class NOVTABLE preferences_page : public service_base {
public:
    virtual HWND create(HWND p_parent) = 0;
    virtual const char * get_name() = 0;
    virtual GUID get_guid() = 0;
    virtual GUID get_parent_guid() = 0;
    virtual bool reset_query() = 0;
    virtual void reset() = 0;
    virtual bool get_help_url(pfc::string_base & p_out);

    static void get_help_url_helper(pfc::string_base & out, const char * category, const GUID & id, const char * name);
    
    static const GUID guid_root, guid_hidden, guid_tools,guid_core,guid_display,guid_playback,guid_visualisations,guid_input,guid_tag_writing,guid_media_library, guid_tagging;

    FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(preferences_page);
};

class NOVTABLE preferences_page_v2 : public preferences_page {
public:
    virtual double get_sort_priority() {return 0;}

    FB2K_MAKE_SERVICE_INTERFACE(preferences_page_v2,preferences_page);
};

template<class T>
class preferences_page_factory_t : public service_factory_single_t<T> {};

class NOVTABLE preferences_branch : public service_base {
public:
    virtual const char * get_name() = 0;
    virtual GUID get_guid() = 0;
    virtual GUID get_parent_guid() = 0;
    

    FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(preferences_branch);
};

class preferences_branch_v2 : public preferences_branch {
public:
    virtual double get_sort_priority() {return 0;}

    FB2K_MAKE_SERVICE_INTERFACE(preferences_branch_v2,preferences_branch);
};

class preferences_branch_impl : public preferences_branch_v2 {
public:
    preferences_branch_impl(const GUID & p_guid,const GUID & p_parent,const char * p_name,double p_sort_priority = 0) : m_guid(p_guid), m_parent(p_parent), m_name(p_name), m_sort_priority(p_sort_priority) {}
    const char * get_name() {return m_name;}
    GUID get_guid() {return m_guid;}
    GUID get_parent_guid() {return m_parent;}
    double get_sort_priority() {return m_sort_priority;}
private:
    const GUID m_guid,m_parent;
    const pfc::string8 m_name;
    const double m_sort_priority;
};

typedef service_factory_single_t<preferences_branch_impl> _preferences_branch_factory;

class preferences_branch_factory : public _preferences_branch_factory {
public:
    preferences_branch_factory(const GUID & p_guid,const GUID & p_parent,const char * p_name,double p_sort_priority = 0) : _preferences_branch_factory(p_guid,p_parent,p_name,p_sort_priority) {}
};




class preferences_state {
public:
    enum {
        changed = 1,
        needs_restart = 2,
        needs_restart_playback = 4,
        resettable = 8,

        busy = 16,
    };
};

class preferences_page_callback : public service_base {
    FB2K_MAKE_SERVICE_INTERFACE(preferences_page_callback, service_base)
public:
    virtual void on_state_changed() = 0;
};

class preferences_page_instance : public service_base {
    FB2K_MAKE_SERVICE_INTERFACE(preferences_page_instance, service_base)
public:
    virtual t_uint32 get_state() = 0;
    virtual HWND get_wnd() = 0;
    virtual void apply() = 0;
    virtual void reset() = 0;
};

class preferences_page_v3 : public preferences_page_v2 {
    FB2K_MAKE_SERVICE_INTERFACE(preferences_page_v3, preferences_page_v2)
public:
    virtual preferences_page_instance::ptr instantiate(HWND parent, preferences_page_callback::ptr callback) = 0;
private:
    HWND create(HWND p_parent) {throw pfc::exception_not_implemented();} //stub
    bool reset_query() {return false;} //stub - the new apply-friendly reset should be used instead.
    void reset() {} //stub
};