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

Public Types

enum  ImageGalleryMode {
  IMAGE_GALLERY_MODE_CONTEXT = 0,
  IMAGE_GALLERY_MODE_ALL,
  IMAGE_GALLERY_MODE_COUNT
}
 
typedef bool(* VisibilityCallback )(const OfItem &)
 

Public Member Functions

 GuiItemGallery (GuiWidget &parent, const int &x, const int &y, const int &w, const int &h, const bool &top_toolbar=false)
 
void show () override
 
void set_selection (const CoreVector< OfItemHandle > &selection)
 
void resize (const int &x, const int &y, const int &w, const int &h) override
 
void set_mode (const ImageGalleryMode &mode)
 
const ImageGalleryMode & get_mode () const
 
void load_settings (const ParserGroup &settings) override
 
void save_settings (ParserGroup &settings) override
 
int process_event (const CoreString &event_id) override
 This method is called whenever an event happens on this widget. Override this to catch and process them.
 
void on_context_removed (OfObjectFactory &factory, const EventInfo &event_id, void *data)
 
void set_filter_classes (const CoreVector< const OfClass * > &filter_classes)
 
void set_visibility_callback (VisibilityCallback cb)
 
void set_filter_name (const CoreString &filter_name, const bool &is_issuer=true)
 
const CoreVector< CoreString > & get_filter_name ()
 
void set_hide_items (const CoreSet< const OfItem * > &items)
 
void set_show_image_only (const bool &image_only)
 
void set_show_build_root (const bool &value)
 
void allow_mutable_objects ()
 
void display_build (bool and_vizroot)
 
bool is_displaying_build_and_vizroot () const
 
void do_selection (GuiItemGalleryThumbnailItem *item_selected)
 
bool do_initiate_dnd_event (GuiItemGalleryThumbnailItem *item_selected)
 
ImageIcon::ImageIconSize get_icon_size ()
 
void set_icon_size (ImageIcon::ImageIconSize size)
 
void focus_on_item (GuiWidget &widget)
 
void focus_on_item ()
 
unsigned int get_item_count ()
 
void set_context (const OfContext *context)
 
const OfContextget_context ()
 
void set_context_object (OfConstObjectHandle object, const bool &is_issuer=true)
 
OfConstObjectHandle get_current_context_object ()
 
void set_display_always_obj_with_emdedded_obj (const OfClass *display)
 
const OfClassget_display_always_obj_with_emdedded_obj ()
 
void set_display_only_contexts (const bool &state)
 
void allow_open_in_external_widgets (const bool &value)
 
bool is_allow_open_in_external_widgets ()
 
void set_vizroot (const OfContext *context)
 
void show_shadowed_items (bool show)
 
- Public Member Functions inherited from GuiPanel
 GuiPanel (GuiWidget &parent, const int &x, const int &y, const int &w, const int &h)
 
virtual void draw (GuiDc &dc) override
 This is the main drawing method of the widget.
 
virtual void hide () override
 
const GMathVec3i & get_background_color () const
 
void set_background_color (const GMathVec3i &color)
 
void set_background_color (const unsigned char &r, const unsigned char &g, const unsigned char &b)
 
void set_top_toolbar_visible (const bool &visible)
 
bool is_top_toolbar_visible () const
 
void set_bottom_toolbar_visible (const bool &visible)
 
bool is_bottom_toolbar_visible () const
 
GuiToolbarget_top_toolbar () const
 
GuiToolbarget_bottom_toolbar () const
 
const bool & is_scroll_enabled () const
 
void set_scroll_enabled (const bool &enable)
 
bool is_horizontal_bar_visible () const
 
bool is_vertical_bar_visible () const
 
void reinit_scrollbars_offset ()
 
void reinit_scrollbars ()
 
void set_virtual_size (const int &width, const int &height)
 
const int & get_virtual_width () const
 
const int & get_virtual_height () const
 
virtual void set_clip_region (const int &x, const int &y, const int &w, const int &h) override
 
int get_view_x () const
 
int get_view_y () const
 
int get_view_width () const
 
int get_view_height () const
 
- Public Member Functions inherited from GuiWidget
 GuiWidget (GuiWidget &parent, const int &x, const int &y, const int &w, const int &h)
 
 GuiWidget (GuiApp &app, const int &x, const int &y, const int &w, const int &h)
 
void destroy ()
 
virtual bool is_shown () const
 
bool is_hidden () const
 
bool is_recursive_destroyed () const
 
const bool & is_destroyed () const
 
virtual GuiWidgetget_parent () const
 
const GuiWindowget_root_window () const
 
virtual void set_parent (GuiWidget *parent)
 
GuiWindowget_window () const
 
const int & get_width () const
 
const int & get_height () const
 
const int & get_x () const
 
const int & get_y () const
 
void set_width (int width)
 
void set_height (int height)
 
virtual const GMathVec2i & get_size () const
 
void set_size (int x, int y, int w, int h)
 
void set_position (const int &x, const int &y, bool origin=true)
 sets position , leave size unchanged.
 
virtual const GMathVec2i & get_position () const
 
void set_mouse_cursor (const Gui::MouseCursorId &cursor)
 
const Gui::MouseCursorId & get_mouse_cursor () const
 
void set_font (const GuiFont &font)
 
GuiFontget_font () const
 
const CoreStringget_tooltip () const
 
virtual void set_tooltip (const CoreString &tooltip)
 
void force_tooltip ()
 
virtual bool is_enabled () const
 
virtual void enable ()
 Activate the widget.
 
virtual void disable ()
 Deativate the widget.
 
bool is_active () const
 Get the active state of the widget, without taking the parents into account.
 
void set_enable (bool enable)
 Set the active state of this widget.
 
virtual GuiColorSchemeget_color_scheme () const
 
void set_color (const GuiColorScheme::Group &group, const GuiColorScheme::Role &role, const unsigned char &r, const unsigned char &g, const unsigned char &b)
 
void set_color (const GuiColorScheme::Group &group, const GuiColorScheme::Role &role, const GMathVec3uc &color)
 
void get_color (const GuiColorScheme::Group &group, const GuiColorScheme::Role &role, unsigned char &r, unsigned char &g, unsigned char &b) const
 
const GMathVec3uc & get_color (const GuiColorScheme::Group &group, const GuiColorScheme::Role &role) const
 
GMathVec3uc get_highlighted_color (const GMathVec3uc &, const float &factor=1.2f, const bool &keep_max_gap=true) const
 
bool is_entered () const
 
virtual void set_focus ()
 
bool children_has_focus (GuiWidget *widget) const
 
bool has_focus () const
 
void lose_focus ()
 
bool is_focus_receiver () const
 
void set_focus_receiver (const bool &receiver)
 
bool is_key_receiver () const
 
void set_key_receiver (const bool &receiver)
 
virtual void redraw ()
 This will ask the widget to be drawn again.
 
virtual CtxDrawget_draw_ctx () const
 Return the drawing context needed by ModuleTool to draw in the widget.
 
void set_is_dirty (const bool &value=true)
 
bool get_is_dirty ()
 returns if widget is dirty or not.
 
void compute_children_bbox (GMathVec2i &lo, GMathVec2i &hi) const
 
const CoreVector< GuiWidget * > & get_children () const
 
GuiAppget_application () const
 
GuiActionregister_action (const CoreString &name, GuiAction::Function function, const CoreString &shortcut, const CoreString &tooltip="", void *data=0, const GuiImage *icon=0)
 
const CoreVector< GuiAction * > & get_actions () const
 
GuiActionget_action (const CoreString &name) const
 
void get_actions_recursively (CoreVector< GuiAction * > &actions) const
 
void remove_action (GuiAction *action, bool delete_it)
 
void remove_all_actions ()
 
void register_hotkey (const CoreString &shortcut, const CoreString &tooltip)
 
const CoreVector< Hotkey > & get_hotkeys () const
 
void get_hotkeys_recursively (CoreVector< Hotkey > &hotkeys) const
 
const int & get_top_offset () const
 
const int & get_bottom_offset () const
 
const int & get_left_offset () const
 
const int & get_right_offset () const
 
const Constraint & get_top_constraint () const
 
const Constraint & get_bottom_constraint () const
 
const Constraint & get_left_constraint () const
 
const Constraint & get_right_constraint () const
 
virtual void set_constraints (const Constraint &left, const Constraint &top, const Constraint &right, const Constraint &bottom)
 
void set_active_constraints (const bool &active)
 
virtual const bool & is_active_constraints () const
 
void set_recursive_constraints (const bool &recursive)
 
virtual const bool & is_recursive_constraints () const
 
void disable_clipping ()
 
void enable_clipping ()
 
void get_clip_region (int &x, int &y, int &w, int &h) const
 
const bool & is_clipping_enabled () const
 
void bring_to_front ()
 
void enable_tab_navigation (const bool &enable)
 
const bool & is_tab_navigation_enabled () const
 
virtual bool is_visible () const
 
virtual void paste (const CoreString &clipboard)
 
bool initiate_dnd_event (const CoreVector< CoreBaseObject * > &data)
 Initiate Drag'n drop event.
 
bool initiate_dnd_event (CoreVector< OfHandle > &data)
 
bool initiate_dnd_event (CoreBaseObject *data)
 See initiate_dnd_event.
 
bool initiate_dnd_event (OfHandle data)
 
virtual GuiWidgetget_next_focus_widget () const
 
virtual GuiWidgetget_previous_focus_widget () const
 
void give_focus_to_next_widget ()
 
void give_focus_to_previous_widget ()
 
void get_parent_effective_clip_region (int &x, int &y, int &w, int &h) const
 
const bool & is_widget_visible (GuiWidget &child) const
 
const bool & is_show_children () const
 
void set_show_children (const bool &show_children)
 
template<class WidgetType >
WidgetType * get_parent_widget () const
 Return the first occurence of WidgetType* in the widget parent hierarchy, or 0 if not found.
 
virtual size_t get_memory_size () const override
 
- 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
 

Static Public Member Functions

static CoreString get_show_mode_name (const ImageGalleryMode &mode)
 

Static Public Attributes

static const int thumbnail_space_x = 6
 
static const int thumbnail_space_y = 1
 

Friends

class GuiItemGalleryThumbnailItem
 

Additional Inherited Members

- Protected Types inherited from GuiWidget
typedef void(* CreateWidget )(void *inst)
 
- Protected Member Functions inherited from GuiPanel
virtual void on_add_child (GuiWidget *child) override
 
virtual void on_remove_child (GuiWidget *child) override
 
virtual void on_child_focus (GuiWidget &widget, const EventInfo &event, void *data=0)
 
virtual void on_scroll (GuiWidget &widget, const EventInfo &event, void *data=0)
 
virtual void on_toolbar_minimize (GuiToolbar &toolbar, const EventInfo &event, void *data=0)
 
virtual void on_toolbar_maximize (GuiToolbar &toolbar, const EventInfo &event, void *data=0)
 
virtual void on_toolbar_show (GuiToolbar &toolbar, const EventInfo &event, void *data=0)
 
virtual void on_toolbar_hide (GuiToolbar &toolbar, const EventInfo &event, void *data=0)
 
void set_vertical_bar_offset (const int &offset)
 
const int get_vertical_bar_offset ()
 
- Protected Attributes inherited from GuiWidget
Fl_Widget * m_widget
 
Fl_Window * m_window
 
Fl_Group * m_group
 
GuiAppm_application
 
int m_child_index
 
Constraint m_top_constraint
 
Constraint m_bottom_constraint
 
Constraint m_left_constraint
 
Constraint m_right_constraint
 
int m_top_offset
 
int m_bottom_offset
 
int m_left_offset
 
int m_right_offset
 
int m_clip_x
 
int m_clip_y
 
int m_clip_w
 
int m_clip_h
 
int m_eff_clip_x
 
int m_eff_clip_y
 
int m_eff_clip_w
 
int m_eff_clip_h
 
GMathVec2i m_size
 
GMathVec2i m_position
 
GuiColorSchemem_color_scheme
 
GuiDcm_dc
 

Member Function Documentation

int GuiItemGallery::process_event ( const CoreString event_id)
overridevirtual

This method is called whenever an event happens on this widget. Override this to catch and process them.

Parameters
event_idThe event name.
Returns
1 if the event was consumed, 0 otherwise (to let the other widgets catch it)

Reimplemented from GuiPanel.