Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Attributes | List of all members
GuiFloatingWindow Class Reference

This Widget is used as holder window for Clarisse floating widgets. The following parenting schema has to be followed: GuiFloatingWindow <- m_viewport_widget <- GuiContextSelectionToolbar <- content_widget (module widget) GuiViewportWidget MUST in any case be found in module widget parent hierarchy because it is used to ask and set selection. More...

Inheritance diagram for GuiFloatingWindow:
GuiWindow GuiWidget EventObject CoreCustomData CoreBaseObject CoreBaseType

Public Member Functions

 GuiFloatingWindow (GuiWindow &parent, const int &x, const int &y, const int &w, const int &h, const CoreString &title, void *viewport_custom_data=0)
 
 GuiFloatingWindow (GuiWindow &parent, const int &x, const int &y, const int &w, const int &h, const CoreString &title, const CoreString &class_name, const bool &update_selection=true, void *viewport_custom_data=0)
 
 GuiFloatingWindow (GuiWindow &parent, const int &x, const int &y, const int &w, const int &h, const CoreString &title, ModuleWidget &module_widget, const bool &update_selection=true, void *viewport_custom_data=0)
 
GuiBasicViewportWidgetget_viewport_widget (const unsigned int &index) const
 
GuiViewportget_viewport () const
 
GuiWidgetget_content_widget (const unsigned int &index) const
 
ModuleWidgetget_module_widget (const unsigned int &index) const
 
unsigned int get_widget_count () const
 
virtual int process_event (const CoreString &evt) override
 This method is called whenever an event happens on this widget. Override this to catch and process them.
 
void get_layout (ParserGroup &group, const bool &get_settings) const
 
void set_layout (ParserEntry &entry)
 
void restore_view ()
 
void maximize_view (GuiViewport *view)
 
virtual bool is_enabled () const override
 
- Public Member Functions inherited from GuiWindow
 GuiWindow (GuiApp &app, const int &x, const int &y, const int &w, const int &h, const CoreString &title="")
 
 GuiWindow (GuiWindow &parent, const int &x, const int &y, const int &w, const int &h, const CoreString &title="")
 
bool is_border_drawn () const
 
void set_border_drawn (const bool &draw_border)
 
bool is_resizable () const
 
void set_resizable (const bool &resizable)
 
virtual void set_parent (GuiWidget *parent) override
 
virtual GuiWidgetget_parent () const override
 
virtual bool is_shown () const override
 
bool is_minimized () const
 
virtual void show_modal ()
 
virtual void show () override
 
virtual void hide () override
 
virtual GuiColorSchemeget_color_scheme () const override
 
virtual void resize (const int &x, const int &y, const int &w, const int &h) override
 
virtual const GMathVec2i & get_size () const override
 
virtual const GMathVec2i & get_position () const override
 
virtual void draw (GuiDc &dc) override
 This is the main drawing method of the widget.
 
const CoreStringget_title () const
 
void set_title (const CoreString &title)
 
const CoreVector< GuiWindow * > & get_subwindows () const
 
virtual bool is_visible () const override
 
const bool & is_modal () const
 
virtual void update_color_scheme (const GuiColorScheme &scheme) override
 
void maximize ()
 
void minimize ()
 
bool is_maximized () const
 
void popup (GuiWidget &widget, const bool &destroy_on_hide=true)
 
virtual size_t get_memory_size () const override
 
GuiWidgetadd_default_background ()
 
- 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)
 
virtual void load_settings (const ParserGroup &settings)
 
virtual void save_settings (ParserGroup &settings)
 
void destroy ()
 
bool is_hidden () const
 
bool is_recursive_destroyed () const
 
const bool & is_destroyed () const
 
const GuiWindowget_root_window () const
 
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)
 
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.
 
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 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.
 
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.
 
virtual void widget_update ()
 This method is called just before draw() if set_is_dirty() has been called before.
 
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
 
virtual void set_clip_region (const int &x, const int &y, const int &w, const int &h)
 
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 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.
 
- 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 Attributes

static char s_do_not_save_in_layout = 'F'
 
static char s_do_not_allow_disable = 'D'
 
static CoreString s_has_custom_data = "has_custom_data"
 

Additional Inherited Members

- Public Types inherited from GuiWidget
enum  Roundness {
  ROUNDNESS_NONE = 0,
  ROUNDNESS_TOP_LEFT = 1,
  ROUNDNESS_TOP_RIGHT = 2,
  ROUNDNESS_BOTTOM_LEFT = 4,
  ROUNDNESS_BOTTOM_RIGHT = 8,
  ROUNDNESS_LEFT = ROUNDNESS_TOP_LEFT | ROUNDNESS_BOTTOM_LEFT,
  ROUNDNESS_RIGHT = ROUNDNESS_TOP_RIGHT | ROUNDNESS_BOTTOM_RIGHT,
  ROUNDNESS_TOP = ROUNDNESS_TOP_LEFT | ROUNDNESS_TOP_RIGHT,
  ROUNDNESS_BOTTOM = ROUNDNESS_BOTTOM_LEFT | ROUNDNESS_BOTTOM_RIGHT,
  ROUNDNESS_ALL = ROUNDNESS_TOP | ROUNDNESS_BOTTOM
}
 
enum  Constraint {
  CONSTRAINT_LEFT,
  CONSTRAINT_RIGHT,
  CONSTRAINT_TOP,
  CONSTRAINT_BOTTOM,
  CONSTRAINT_COUNT
}
 
enum  Justify {
  JUSTIFY_LEFT,
  JUSTIFY_RIGHT,
  JUSTIFY_CENTER,
  JUSTIFY_COUNT
}
 
enum  IconPosition {
  ICON_POSITION_LEFT,
  ICON_POSITION_RIGHT,
  ICON_POSITION_COUNT
}
 
- Static Public Member Functions inherited from GuiWidget
static CoreString open_file (GuiApp &app, const CoreString &directory="", const CoreString &title="Open file", const CoreString &filter="")
 
static CoreArray< CoreStringopen_files (GuiApp &app, const CoreString &directory="", const CoreString &title="Open files", const CoreString &filter="")
 
static CoreString open_folder (GuiApp &app, const CoreString &directory="", const CoreString &title="Choose folder")
 
static CoreString save_file (GuiApp &app, const CoreString &directory="", const CoreString &title="Save file", const CoreString &filter="", int *filter_selected=0)
 
static CoreVector< OfItemHandlepick_objects (GuiApp &app, const CoreVector< OfItemHandle > &current_selection, const CoreVector< OfClass * > &filter_classes, OfContext *context=0, const CoreVector< OfItem * > &hidden_items=CoreVector< OfItem * >(), const bool &enable_multi_selection=false)
 
static CoreVector< OfItemHandlepick_objects (GuiApp &app, const CoreVector< OfClass * > &filter_classes, OfContext *context=0, const bool &enable_multi_selection=false)
 
static const char * get_roundness_name (const Roundness &roundness)
 
static const char * get_constraint_name (const Constraint &constraint)
 
static const char * get_justify_name (const Justify &justification)
 
static const char * get_icon_position_name (const IconPosition &position)
 
static GuiWidgetget_focused_widget ()
 
static GuiWidgetget_last_focused_widget ()
 
static GuiWidgetget_last_event_widget ()
 
static void intersect_box (const int &x1, const int &y1, const int &w1, const int &h1, const int &x2, const int &y2, const int &w2, const int &h2, int &x, int &y, int &w, int &h)
 
static bool intersect_box (const int &x1, const int &y1, const int &w1, const int &h1, const int &x2, const int &y2, const int &w2, const int &h2)
 
static void on_dnd_timeout (void *data)
 
static const CoreVector
< CoreBaseObject * > & 
get_dnd_event_data ()
 Return the data associated with the current Drag'n drop. The data is only valid if a widget is currently calling initiate_dnd_event, otherwise it is empty.
 
static GuiWidgetget_dnd_widget ()
 Return the GuiWidget that initiated the Drag'n drop. Null otherwise.
 
static GuiWidgetget_dnd_accepting_widget ()
 Return the GuiWidget that accepts the Drag'n drop. Null otherwise.
 
- Protected Types inherited from GuiWidget
typedef void(* CreateWidget )(void *inst)
 
- Protected Member Functions inherited from GuiWindow
virtual void widget_redraw () override
 
virtual bool process_actions () override
 
int modal_blocking_loop ()
 
virtual int on_modal_loop ()
 
virtual void apply_constraints (const int &px, const int &py, const int &pw, const int &ph) override
 
virtual void apply_clipping () override
 
virtual Fl_Widget * get_widget () const override
 
virtual Fl_Group * get_group () const override
 
virtual void widget_focus_changed ()
 
- Protected Attributes inherited from GuiWindow
GuiWindowm_parent_window
 

Detailed Description

This Widget is used as holder window for Clarisse floating widgets. The following parenting schema has to be followed: GuiFloatingWindow <- m_viewport_widget <- GuiContextSelectionToolbar <- content_widget (module widget) GuiViewportWidget MUST in any case be found in module widget parent hierarchy because it is used to ask and set selection.

Member Function Documentation

bool GuiFloatingWindow::is_enabled ( ) const
overridevirtual

Return true if the widget and all its parent are active, false if it's inactive or any of its parent, grand-parent, etc. is inactive.

Reimplemented from GuiWindow.

int GuiFloatingWindow::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 GuiWidget.