# studio::Dockable Class Reference

`#include <dockable.h>`

Inheritance diagram for studio::Dockable:

List of all members.

## Public Member Functions

void | set_toolbar (Gtk::Toolbar &toolbar)
void | set_use_scrolled (bool x)
| Dockable (const synfig::String &name, const synfig::String &local_name, Gtk::StockID stock_id_=Gtk::StockID(" "))
| ~Dockable ()
sigc::signal< void > & | signal_stock_id_changed ()
const synfig::String & | get_name () const
const synfig::String & | get_local_name () const
const Gtk::StockID & | get_stock_id () const
void | set_stock_id (Gtk::StockID x)
void | set_local_name (const synfig::String &)
void | clear ()
Gtk::Tooltips & | get_tooltips ()
void | add (Gtk::Widget &x)
Gtk::ToolButton * | add_button (const Gtk::StockID &stock_id, const synfig::String &tooltip=synfig::String())
void | detach ()
void | present ()
void | attach_dnd_to (Gtk::Widget &widget)
bool | clear_previous ()
virtual Gtk::Widget * | create_tab_label ()

## Friends

class | DockManager
class | DockBook

## Constructor & Destructor Documentation

Dockable::Dockable | ( | const synfig::String & | name,
|  | const synfig::String & | local_name,
|  | Gtk::StockID | stock_id_ = `Gtk::StockID(" ")` |
| ) |  |  |

References _, attach_dnd_to(), detach(), and set_toolbar().

Dockable::~Dockable | ( |  | ) |

## Member Function Documentation

void Dockable::set_toolbar | ( | Gtk::Toolbar & | toolbar | ) |

Referenced by add_button(), clear(), studio::Dock_History::Dock_History(), studio::Dock_Keyframes::Dock_Keyframes(), studio::Dock_LayerGroups::Dock_LayerGroups(), studio::Dock_Layers::Dock_Layers(), studio::Dock_PalEdit::Dock_PalEdit(), and Dockable().

void studio::Dockable::set_use_scrolled | ( | bool | x | ) | `[inline]`

Referenced by studio::Dock_Info::Dock_Info().

sigc::signal<void>& studio::Dockable::signal_stock_id_changed | ( |  | ) | `[inline]`

Referenced by studio::DockBook::add(), and set_stock_id().

const synfig::String& studio::Dockable::get_name | ( |  | ) | const`[inline]`

Referenced by studio::Dock_Timetrack::changed_canvas_view_vfunc(), studio::Dock_Params::changed_canvas_view_vfunc(), studio::Dock_MetaData::changed_canvas_view_vfunc(), studio::Dock_Layers::changed_canvas_view_vfunc(), studio::Dock_LayerGroups::changed_canvas_view_vfunc(), studio::Dock_Keyframes::changed_canvas_view_vfunc(), studio::Dock_Curves::changed_canvas_view_vfunc(), studio::Dock_Children::changed_canvas_view_vfunc(), studio::DockBook::get_contents(), studio::Dock_Timetrack::init_canvas_view_vfunc(), studio::Dock_Params::init_canvas_view_vfunc(), studio::Dock_MetaData::init_canvas_view_vfunc(), studio::Dock_Layers::init_canvas_view_vfunc(), studio::Dock_LayerGroups::init_canvas_view_vfunc(), studio::Dock_Keyframes::init_canvas_view_vfunc(), studio::Dock_Curves::init_canvas_view_vfunc(), studio::Dock_Children::init_canvas_view_vfunc(), studio::Dock_Params::refresh_selected_param(), and studio::DockManager::unregister_dockable().

const synfig::String& studio::Dockable::get_local_name | ( |  | ) | const`[inline]`

Referenced by create_tab_label(), studio::Toolbox::dockable_registered(), and studio::DockBook::get_local_contents().

const Gtk::StockID& studio::Dockable::get_stock_id | ( |  | ) | const`[inline]`

Referenced by attach_dnd_to(), and create_tab_label().

void studio::Dockable::set_stock_id | ( | Gtk::StockID | x | ) | `[inline]`

References signal_stock_id_changed().

Referenced by studio::Dialog_ToolOptions::clear(), and studio::Dialog_ToolOptions::set_name().

void Dockable::set_local_name | ( | const synfig::String & | local_name | ) |

Referenced by studio::Dialog_ToolOptions::clear().

void Dockable::clear | ( |  | ) |

Reimplemented in studio::Dialog_ToolOptions.

References set_toolbar().

Referenced by studio::Dialog_ToolOptions::clear().

Gtk::Tooltips& studio::Dockable::get_tooltips | ( |  | ) | `[inline]`

void Dockable::add | ( | Gtk::Widget & | x | ) |

References clear_previous().

Gtk::ToolButton * Dockable::add_button | ( | const Gtk::StockID & | stock_id,
|  | const synfig::String & | tooltip = `synfig::String()` |
| ) |  |  |

References set_toolbar().

Referenced by studio::Dock_MetaData::Dock_MetaData().

void Dockable::detach | ( |  | ) |

References studio::DockBook::remove().

Referenced by studio::DockBook::add(), Dockable(), studio::DockBook::tab_button_pressed(), and studio::DockManager::unregister_dockable().

void Dockable::present | ( |  | ) |

References studio::DockBook::add(), studio::DockDialog::get_dock_book(), and studio::DockBook::present().

Referenced by studio::Toolbox::dockable_registered(), studio::Dock_Layers::init_canvas_view_vfunc(), and studio::DockManager::present().

void Dockable::attach_dnd_to | ( | Gtk::Widget & | widget | ) |

References get_stock_id().

Referenced by create_tab_label(), and Dockable().

bool Dockable::clear_previous | ( |  | ) |

Referenced by add(), studio::Dock_Params::changed_canvas_view_vfunc(), studio::Dock_Navigator::changed_canvas_view_vfunc(), studio::Dock_Layers::changed_canvas_view_vfunc(), studio::Dock_LayerGroups::changed_canvas_view_vfunc(), studio::Dock_Keyframes::changed_canvas_view_vfunc(), and studio::Dock_Children::changed_canvas_view_vfunc().

Gtk::Widget * Dockable::create_tab_label | ( |  | ) | `[virtual]`

References attach_dnd_to(), get_local_name(), and get_stock_id().

Referenced by studio::DockBook::refresh_tab().

## Friends And Related Function Documentation

friend class DockManager `[friend]`

friend class DockBook `[friend]`

The documentation for this class was generated from the following files:

- dockable.h
- dockable.cpp