2023-01-10 15:26:54 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef TAB_CONTAINER_H
|
|
|
|
#define TAB_CONTAINER_H
|
|
|
|
|
2018-06-11 00:10:32 +02:00
|
|
|
#include "scene/gui/container.h"
|
2015-06-14 03:12:53 +02:00
|
|
|
#include "scene/gui/popup.h"
|
2018-06-11 00:10:32 +02:00
|
|
|
class TabContainer : public Container {
|
|
|
|
GDCLASS(TabContainer, Container);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2014-02-10 02:10:30 +01:00
|
|
|
enum TabAlign {
|
|
|
|
|
|
|
|
ALIGN_LEFT,
|
|
|
|
ALIGN_CENTER,
|
|
|
|
ALIGN_RIGHT
|
|
|
|
};
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
private:
|
2017-01-21 19:11:33 +01:00
|
|
|
int first_tab_cache;
|
2014-02-10 02:10:30 +01:00
|
|
|
int tabs_ofs_cache;
|
|
|
|
int last_tab_cache;
|
|
|
|
int current;
|
2017-03-01 18:23:19 +01:00
|
|
|
int previous;
|
2014-02-10 02:10:30 +01:00
|
|
|
bool tabs_visible;
|
2020-12-05 19:12:24 +01:00
|
|
|
bool all_tabs_in_front;
|
2014-02-10 02:10:30 +01:00
|
|
|
bool buttons_visible_cache;
|
2019-09-23 04:07:00 +02:00
|
|
|
bool menu_hovered;
|
|
|
|
int highlight_arrow;
|
2014-02-10 02:10:30 +01:00
|
|
|
TabAlign align;
|
|
|
|
int _get_top_margin() const;
|
2020-06-24 19:14:30 +02:00
|
|
|
mutable ObjectID popup_obj_id;
|
2018-02-07 14:01:45 +01:00
|
|
|
bool drag_to_rearrange_enabled;
|
2019-01-26 19:41:36 +01:00
|
|
|
bool use_hidden_tabs_for_min_size;
|
2018-02-07 14:01:45 +01:00
|
|
|
int tabs_rearrange_group;
|
2015-06-14 03:12:53 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Vector<Control *> _get_tabs() const;
|
2017-01-21 19:11:33 +01:00
|
|
|
int _get_tab_width(int p_index) const;
|
2017-12-11 12:46:33 +01:00
|
|
|
void _on_theme_changed();
|
2020-06-14 00:15:47 +02:00
|
|
|
void _repaint();
|
2019-09-23 04:07:00 +02:00
|
|
|
void _on_mouse_exited();
|
2018-02-06 22:32:03 +01:00
|
|
|
void _update_current_tab();
|
2020-10-13 15:05:26 +02:00
|
|
|
void _draw_tab(Ref<StyleBox> &p_tab_style, Color &p_font_color, int p_index, float p_x);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
protected:
|
|
|
|
void _child_renamed_callback();
|
2017-05-20 17:38:03 +02:00
|
|
|
void _gui_input(const Ref<InputEvent> &p_event);
|
2014-02-10 02:10:30 +01:00
|
|
|
void _notification(int p_what);
|
|
|
|
virtual void add_child_notify(Node *p_child);
|
2021-08-04 22:10:06 +02:00
|
|
|
virtual void move_child_notify(Node *p_child);
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual void remove_child_notify(Node *p_child);
|
|
|
|
|
2018-02-07 14:01:45 +01:00
|
|
|
Variant get_drag_data(const Point2 &p_point);
|
|
|
|
bool can_drop_data(const Point2 &p_point, const Variant &p_data) const;
|
|
|
|
void drop_data(const Point2 &p_point, const Variant &p_data);
|
|
|
|
int get_tab_idx_at_point(const Point2 &p_point) const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
static void _bind_methods();
|
|
|
|
|
|
|
|
public:
|
|
|
|
void set_tab_align(TabAlign p_align);
|
|
|
|
TabAlign get_tab_align() const;
|
|
|
|
|
2020-01-25 01:34:47 +01:00
|
|
|
void set_tabs_visible(bool p_visible);
|
2014-02-10 02:10:30 +01:00
|
|
|
bool are_tabs_visible() const;
|
|
|
|
|
2020-12-05 19:12:24 +01:00
|
|
|
void set_all_tabs_in_front(bool p_is_front);
|
|
|
|
bool is_all_tabs_in_front() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_tab_title(int p_tab, const String &p_title);
|
2014-02-10 02:10:30 +01:00
|
|
|
String get_tab_title(int p_tab) const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_tab_icon(int p_tab, const Ref<Texture> &p_icon);
|
2014-02-10 02:10:30 +01:00
|
|
|
Ref<Texture> get_tab_icon(int p_tab) const;
|
|
|
|
|
2017-02-27 19:07:50 +01:00
|
|
|
void set_tab_disabled(int p_tab, bool p_disabled);
|
|
|
|
bool get_tab_disabled(int p_tab) const;
|
|
|
|
|
2019-04-09 00:18:03 +02:00
|
|
|
void set_tab_hidden(int p_tab, bool p_hidden);
|
|
|
|
bool get_tab_hidden(int p_tab) const;
|
|
|
|
|
2023-04-12 02:24:52 +02:00
|
|
|
void set_tab_metadata(int p_tab, const Variant &p_metadata);
|
|
|
|
Variant get_tab_metadata(int p_tab) const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
int get_tab_count() const;
|
|
|
|
void set_current_tab(int p_current);
|
|
|
|
int get_current_tab() const;
|
2017-03-01 18:23:19 +01:00
|
|
|
int get_previous_tab() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Control *get_tab_control(int p_idx) const;
|
|
|
|
Control *get_current_tab_control() const;
|
2015-06-14 03:12:53 +02:00
|
|
|
|
2015-01-03 02:34:22 +01:00
|
|
|
virtual Size2 get_minimum_size() const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual void get_translatable_strings(List<String> *p_strings) const;
|
|
|
|
|
2015-06-14 03:12:53 +02:00
|
|
|
void set_popup(Node *p_popup);
|
2017-03-05 16:44:50 +01:00
|
|
|
Popup *get_popup() const;
|
2015-06-14 03:12:53 +02:00
|
|
|
|
2018-02-07 14:01:45 +01:00
|
|
|
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;
|
2019-01-26 19:41:36 +01:00
|
|
|
void set_use_hidden_tabs_for_min_size(bool p_use_hidden_tabs);
|
|
|
|
bool get_use_hidden_tabs_for_min_size() const;
|
2018-02-07 14:01:45 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
TabContainer();
|
|
|
|
};
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
VARIANT_ENUM_CAST(TabContainer::TabAlign);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
#endif // TAB_CONTAINER_H
|