mirror of
https://github.com/godotengine/godot.git
synced 2024-11-27 09:16:35 +08:00
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".
159 lines
5.7 KiB
C++
159 lines
5.7 KiB
C++
/**************************************************************************/
|
|
/* label.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 LABEL_H
|
|
#define LABEL_H
|
|
|
|
#include "scene/gui/control.h"
|
|
#include "scene/resources/label_settings.h"
|
|
|
|
class Label : public Control {
|
|
GDCLASS(Label, Control);
|
|
|
|
private:
|
|
HorizontalAlignment horizontal_alignment = HORIZONTAL_ALIGNMENT_LEFT;
|
|
VerticalAlignment vertical_alignment = VERTICAL_ALIGNMENT_TOP;
|
|
String text;
|
|
String xl_text;
|
|
TextServer::AutowrapMode autowrap_mode = TextServer::AUTOWRAP_OFF;
|
|
bool clip = false;
|
|
TextServer::OverrunBehavior overrun_behavior = TextServer::OVERRUN_NO_TRIMMING;
|
|
Size2 minsize;
|
|
bool uppercase = false;
|
|
|
|
bool lines_dirty = true;
|
|
bool dirty = true;
|
|
bool font_dirty = true;
|
|
RID text_rid;
|
|
Vector<RID> lines_rid;
|
|
|
|
String language;
|
|
TextDirection text_direction = TEXT_DIRECTION_AUTO;
|
|
TextServer::StructuredTextParser st_parser = TextServer::STRUCTURED_TEXT_DEFAULT;
|
|
Array st_args;
|
|
|
|
TextServer::VisibleCharactersBehavior visible_chars_behavior = TextServer::VC_CHARS_BEFORE_SHAPING;
|
|
int visible_chars = -1;
|
|
float visible_ratio = 1.0;
|
|
int lines_skipped = 0;
|
|
int max_lines_visible = -1;
|
|
|
|
Ref<LabelSettings> settings;
|
|
|
|
struct ThemeCache {
|
|
Ref<StyleBox> normal_style;
|
|
Ref<Font> font;
|
|
|
|
int font_size = 0;
|
|
int line_spacing = 0;
|
|
Color font_color;
|
|
Color font_shadow_color;
|
|
Point2 font_shadow_offset;
|
|
Color font_outline_color;
|
|
int font_outline_size;
|
|
int font_shadow_outline_size;
|
|
} theme_cache;
|
|
|
|
void _update_visible();
|
|
void _shape();
|
|
void _invalidate();
|
|
|
|
protected:
|
|
virtual void _update_theme_item_cache() override;
|
|
|
|
void _notification(int p_what);
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
virtual Size2 get_minimum_size() const override;
|
|
virtual PackedStringArray get_configuration_warnings() const override;
|
|
|
|
void set_horizontal_alignment(HorizontalAlignment p_alignment);
|
|
HorizontalAlignment get_horizontal_alignment() const;
|
|
|
|
void set_vertical_alignment(VerticalAlignment p_alignment);
|
|
VerticalAlignment get_vertical_alignment() const;
|
|
|
|
void set_text(const String &p_string);
|
|
String get_text() const;
|
|
|
|
void set_label_settings(const Ref<LabelSettings> &p_settings);
|
|
Ref<LabelSettings> get_label_settings() const;
|
|
|
|
void set_text_direction(TextDirection p_text_direction);
|
|
TextDirection get_text_direction() const;
|
|
|
|
void set_language(const String &p_language);
|
|
String get_language() const;
|
|
|
|
void set_structured_text_bidi_override(TextServer::StructuredTextParser p_parser);
|
|
TextServer::StructuredTextParser get_structured_text_bidi_override() const;
|
|
|
|
void set_structured_text_bidi_override_options(Array p_args);
|
|
Array get_structured_text_bidi_override_options() const;
|
|
|
|
void set_autowrap_mode(TextServer::AutowrapMode p_mode);
|
|
TextServer::AutowrapMode get_autowrap_mode() const;
|
|
|
|
void set_uppercase(bool p_uppercase);
|
|
bool is_uppercase() const;
|
|
|
|
void set_visible_characters_behavior(TextServer::VisibleCharactersBehavior p_behavior);
|
|
TextServer::VisibleCharactersBehavior get_visible_characters_behavior() const;
|
|
|
|
void set_visible_characters(int p_amount);
|
|
int get_visible_characters() const;
|
|
int get_total_character_count() const;
|
|
|
|
void set_visible_ratio(float p_ratio);
|
|
float get_visible_ratio() const;
|
|
|
|
void set_clip_text(bool p_clip);
|
|
bool is_clipping_text() const;
|
|
|
|
void set_text_overrun_behavior(TextServer::OverrunBehavior p_behavior);
|
|
TextServer::OverrunBehavior get_text_overrun_behavior() const;
|
|
|
|
void set_lines_skipped(int p_lines);
|
|
int get_lines_skipped() const;
|
|
|
|
void set_max_lines_visible(int p_lines);
|
|
int get_max_lines_visible() const;
|
|
|
|
int get_line_height(int p_line = -1) const;
|
|
int get_line_count() const;
|
|
int get_visible_line_count() const;
|
|
|
|
Label(const String &p_text = String());
|
|
~Label();
|
|
};
|
|
|
|
#endif // LABEL_H
|