Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Member Functions | List of all members
GuiImageHistory Class Reference
Inheritance diagram for GuiImageHistory:
EventObject CoreCustomData CoreBaseObject CoreBaseType

Classes

struct  EventHistoryData
 

Public Member Functions

 GuiImageHistory (GuiApp *app)
 
unsigned int add_image (ImageHandle image, OfObjectHandle object, const CoreString &color_space, const CoreString &image_name="", unsigned long computed_time=-1)
 
bool remove_image (const unsigned int &id)
 
void clear ()
 
void clear_unlocked ()
 
const bool is_suspended () const
 
void suspend (const bool &is_suspending)
 
const unsigned int is_item_name_already_exists (const CoreString &name)
 
const CoreStringget_item_name (const unsigned int &id)
 
void set_item_name (const unsigned int &id, const CoreString &name)
 
void set_is_auto_removable (const unsigned int &id, const bool &value)
 
const CoreStringget_item_comment (const unsigned int &id)
 
void set_item_comment (const unsigned int &id, const CoreString &comment)
 
unsigned int get_item_count () const
 
const GuiImageHistoryItemget_item_by_index (unsigned int index) const
 
unsigned int get_last_image_index () const
 
const GuiImageHistoryItemget_item (unsigned int id)
 
ImageHandle get_image_handle (unsigned int id)
 
ModuleProjectItemget_image_module (unsigned int id)
 
void set_item_image (const unsigned int &id, const ImageHandle &image)
 
long get_mode () const
 
void set_mode (long mode)
 
void set_max_history_size (const unsigned int &size)
 
const unsigned int & get_max_history_size () const
 
void set_empty_on_new_project (const bool &value)
 
const bool & get_empty_on_new_project () const
 
const bool & is_autosave () const
 
void set_autosave (const bool &enable)
 
const CoreStringget_history_cache_path () const
 
void set_history_cache_path (const CoreString &value)
 
void create_history_cache_folder ()
 
const unsigned int & get_history_cache_max_count () const
 
void set_history_cache_max_count (const unsigned int &value)
 
const unsigned int & get_history_cache_max_size () const
 
void set_history_cache_max_size (const unsigned int &value)
 
void add_image_to_save (const CoreString fullpath)
 
const unsigned int get_image_list_saved_count ()
 
void set_snapshot_mode (const unsigned int &mode)
 
const unsigned int & get_snapshot_mode () const
 
void set_empty_cache_on_exit (const bool &value)
 
const bool & get_empty_cache_on_exit () const
 
void set_empty_cache_on_new_project (const bool &value)
 
const bool & get_empty_cache_on_new_project () const
 
bool is_enabled () const
 
void check_clear_history (const bool &force=false)
 
void check_clear_history_cache ()
 
void clear_history_cache (bool exit)
 
void on_remove_object_from_factory (OfObjectFactory &factory, const EventInfo &evt, void *data)
 
virtual size_t get_memory_size () const override
 
void save_images_changed ()
 
void check_cache_folder_files ()
 
void remove_older_autosave_image_history (CoreString directory)
 
- Public Member Functions inherited from EventObject
 EventObject ()
 Constructor.
 
 EventObject (const EventObject &src)
 Copy Constructor.
 
virtual ~EventObject () override
 Destructor.
 
void connect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen to a specific event.
 
void connect (EventObject &sender, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events.
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
 
bool disconnect_all (EventObject &sender)
 Disconnects from all objects sender was listening on.
 
void disconnect_all ()
 Disconnects from all objects we were listening on.
 
void remove_all_connection ()
 Disconnects object from other objects it is listening to, and also disconnects all objects listening to it.
 
void raise_event (const CoreString &event_id) const
 sends an event
 
void raise_event (const EventInfo &event_info) const
 sends an event
 
bool is_connected (EventObject &sender, const CoreString &event_id, void *data)
 
void set_mute (const bool &mute)
 Asks for object muting. This will increase or decrease the muting counter. Unmuting may not be immediat since it will happen only when counter reaches 0.
 
bool is_mute () const
 Returns if object is muted.
 
CoreArray< EventObject * > get_senders () const
 
unsigned int get_sender_count () const
 
unsigned int get_receiver_count () const
 
void connect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Connects this to an object to listen to a specific event.
 
void connect (EventObject &sender, EventMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events.
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Disconnects this from an object for a specific event.
 
- Public Member Functions inherited from CoreCustomData
 CoreCustomData (const CoreCustomData &src)
 
void add_custom_data (void *key, const bool &data)
 
void add_custom_data (void *key, const int &data)
 
void add_custom_data (void *key, const unsigned int &data)
 
void add_custom_data (void *key, const char *data)
 
void add_custom_data (void *key, const CoreString &data)
 
void add_custom_data (void *key, const double &data)
 
void add_custom_data (void *key, void *data)
 
void remove_custom_data (void *key)
 
void remove_all_custom_data ()
 
void set_custom_data (void *key, const bool &data)
 
void set_custom_data (void *key, const int &data)
 
void set_custom_data (void *key, const unsigned int &data)
 
void set_custom_data (void *key, const double &data)
 
void set_custom_data (void *key, const char *data)
 
void set_custom_data (void *key, const CoreString &data)
 
void set_custom_data (void *key, void *data)
 
void get_custom_data (void *key, bool &data) const
 
void get_custom_data (void *key, int &data) const
 
void get_custom_data (void *key, unsigned int &data) const
 
void get_custom_data (void *key, double &data) const
 
void get_custom_data (void *key, CoreString &data) const
 
void get_custom_data (void *key, void *&data) const
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
CoreString get_class_info_name () const
 
const unsigned long & get_class_info_id () const
 
virtual bool is_kindof (const CoreClassInfo &cinfo) const
 
virtual const CoreClassInfoget_class_info () const
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Additional Inherited Members

- Public Types inherited from EventObject
typedef void(* EventInfoFunction )(EventObject &, const EventInfo &, void *)
 event callback signature for free functions / static methods.
 
typedef void(EventObject::* EventInfoMethod )(EventObject &, const EventInfo &, void *)
 event callback signature for methods.
 
typedef void(* EventFunction )(EventObject &, const CoreString &, void *)
 
typedef void(EventObject::* EventMethod )(EventObject &, const CoreString &, void *)
 
- Static Public Member Functions inherited from EventObject
static void connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen to a specific event.
 
static void connect (EventObject &sender, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen any of its events.
 
static bool disconnect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
 
static void raise_event (EventObject &sender, const CoreString &event_id)
 Sends an event.
 
static void raise_event (EventObject &sender, const EventInfo &event_info)
 Sends an event.
 
static void connect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
 Connects to an object to listen to a specific event.
 
static void connect (EventObject &sender, EventFunction event_cb, void *data=0)
 Connects to an object to listen any of its events.
 
static void connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, EventObject &receiver, EventMethod event_cb, void *data=0)
 Static version of the above function.
 
static bool disconnect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
 Disconnects this from an object for a specific event.
 

Class Documentation

struct GuiImageHistory::EventHistoryData
Class Members
unsigned int event_id
unsigned int id