d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
168 lines
6.1 KiB
C++
168 lines
6.1 KiB
C++
/**************************************************************************/
|
|
/* tab_container.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef TAB_CONTAINER_H
|
|
#define TAB_CONTAINER_H
|
|
|
|
#include "scene/gui/container.h"
|
|
#include "scene/gui/popup.h"
|
|
#include "scene/gui/tab_bar.h"
|
|
|
|
class TabContainer : public Container {
|
|
GDCLASS(TabContainer, Container);
|
|
|
|
TabBar *tab_bar = nullptr;
|
|
bool tabs_visible = true;
|
|
bool all_tabs_in_front = false;
|
|
bool menu_hovered = false;
|
|
mutable ObjectID popup_obj_id;
|
|
bool drag_to_rearrange_enabled = false;
|
|
bool use_hidden_tabs_for_min_size = false;
|
|
bool theme_changing = false;
|
|
Vector<Control *> children_removing;
|
|
|
|
struct ThemeCache {
|
|
int side_margin = 0;
|
|
|
|
Ref<StyleBox> panel_style;
|
|
Ref<StyleBox> tabbar_style;
|
|
|
|
Ref<Texture2D> menu_icon;
|
|
Ref<Texture2D> menu_hl_icon;
|
|
|
|
// TabBar overrides.
|
|
int icon_separation = 0;
|
|
int outline_size = 0;
|
|
|
|
Ref<StyleBox> tab_unselected_style;
|
|
Ref<StyleBox> tab_selected_style;
|
|
Ref<StyleBox> tab_disabled_style;
|
|
|
|
Ref<Texture2D> increment_icon;
|
|
Ref<Texture2D> increment_hl_icon;
|
|
Ref<Texture2D> decrement_icon;
|
|
Ref<Texture2D> decrement_hl_icon;
|
|
Ref<Texture2D> drop_mark_icon;
|
|
Color drop_mark_color;
|
|
|
|
Color font_selected_color;
|
|
Color font_unselected_color;
|
|
Color font_disabled_color;
|
|
Color font_outline_color;
|
|
|
|
Ref<Font> tab_font;
|
|
int tab_font_size;
|
|
} theme_cache;
|
|
|
|
int _get_top_margin() const;
|
|
Vector<Control *> _get_tab_controls() const;
|
|
void _on_theme_changed();
|
|
void _repaint();
|
|
void _refresh_tab_names();
|
|
void _update_margins();
|
|
void _on_mouse_exited();
|
|
void _on_tab_changed(int p_tab);
|
|
void _on_tab_selected(int p_tab);
|
|
void _on_tab_button_pressed(int p_tab);
|
|
|
|
Variant _get_drag_data_fw(const Point2 &p_point, Control *p_from_control);
|
|
bool _can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from_control) const;
|
|
void _drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from_control);
|
|
|
|
protected:
|
|
virtual void gui_input(const Ref<InputEvent> &p_event) override;
|
|
virtual void _update_theme_item_cache() override;
|
|
|
|
void _notification(int p_what);
|
|
virtual void add_child_notify(Node *p_child) override;
|
|
virtual void move_child_notify(Node *p_child) override;
|
|
virtual void remove_child_notify(Node *p_child) override;
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
int get_tab_idx_at_point(const Point2 &p_point) const;
|
|
int get_tab_idx_from_control(Control *p_child) const;
|
|
|
|
void set_tab_alignment(TabBar::AlignmentMode p_alignment);
|
|
TabBar::AlignmentMode get_tab_alignment() const;
|
|
|
|
void set_clip_tabs(bool p_clip_tabs);
|
|
bool get_clip_tabs() const;
|
|
|
|
void set_tabs_visible(bool p_visible);
|
|
bool are_tabs_visible() const;
|
|
|
|
void set_all_tabs_in_front(bool p_is_front);
|
|
bool is_all_tabs_in_front() const;
|
|
|
|
void set_tab_title(int p_tab, const String &p_title);
|
|
String get_tab_title(int p_tab) const;
|
|
|
|
void set_tab_icon(int p_tab, const Ref<Texture2D> &p_icon);
|
|
Ref<Texture2D> get_tab_icon(int p_tab) const;
|
|
|
|
void set_tab_disabled(int p_tab, bool p_disabled);
|
|
bool is_tab_disabled(int p_tab) const;
|
|
|
|
void set_tab_hidden(int p_tab, bool p_hidden);
|
|
bool is_tab_hidden(int p_tab) const;
|
|
|
|
void set_tab_button_icon(int p_tab, const Ref<Texture2D> &p_icon);
|
|
Ref<Texture2D> get_tab_button_icon(int p_tab) const;
|
|
|
|
int get_tab_count() const;
|
|
void set_current_tab(int p_current);
|
|
int get_current_tab() const;
|
|
int get_previous_tab() const;
|
|
|
|
Control *get_tab_control(int p_idx) const;
|
|
Control *get_current_tab_control() const;
|
|
|
|
virtual Size2 get_minimum_size() const override;
|
|
|
|
virtual void get_translatable_strings(List<String> *p_strings) const override;
|
|
|
|
void set_popup(Node *p_popup);
|
|
Popup *get_popup() const;
|
|
|
|
void set_drag_to_rearrange_enabled(bool p_enabled);
|
|
bool get_drag_to_rearrange_enabled() const;
|
|
void set_tabs_rearrange_group(int p_group_id);
|
|
int get_tabs_rearrange_group() const;
|
|
void set_use_hidden_tabs_for_min_size(bool p_use_hidden_tabs);
|
|
bool get_use_hidden_tabs_for_min_size() const;
|
|
|
|
virtual Vector<int> get_allowed_size_flags_horizontal() const override;
|
|
virtual Vector<int> get_allowed_size_flags_vertical() const override;
|
|
|
|
TabContainer();
|
|
};
|
|
|
|
#endif // TAB_CONTAINER_H
|