godot/scene/gui/label.h
Rémi Verschelde b16c309f82 Update copyright statements to 2019
Happy new year to the wonderful Godot community!
2019-01-01 12:58:10 +01:00

153 lines
4.2 KiB
C++

/*************************************************************************/
/* label.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
/* */
/* 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"
/**
@author Juan Linietsky <reduzio@gmail.com>
*/
class Label : public Control {
GDCLASS(Label, Control);
public:
enum Align {
ALIGN_LEFT,
ALIGN_CENTER,
ALIGN_RIGHT,
ALIGN_FILL
};
enum VAlign {
VALIGN_TOP,
VALIGN_CENTER,
VALIGN_BOTTOM,
VALIGN_FILL
};
private:
Align align;
VAlign valign;
String text;
String xl_text;
bool autowrap;
bool clip;
Size2 minsize;
int line_count;
bool uppercase;
int get_longest_line_width() const;
struct WordCache {
enum {
CHAR_NEWLINE = -1,
CHAR_WRAPLINE = -2
};
int char_pos; // if -1, then newline
int word_len;
int pixel_width;
int space_count;
WordCache *next;
WordCache() {
char_pos = 0;
word_len = 0;
pixel_width = 0;
next = 0;
space_count = 0;
}
};
bool word_cache_dirty;
void regenerate_word_cache();
float percent_visible;
WordCache *word_cache;
int total_char_cache;
int visible_chars;
int lines_skipped;
int max_lines_visible;
protected:
void _notification(int p_what);
static void _bind_methods();
// bind helpers
public:
virtual Size2 get_minimum_size() const;
void set_align(Align p_align);
Align get_align() const;
void set_valign(VAlign p_align);
VAlign get_valign() const;
void set_text(const String &p_string);
String get_text() const;
void set_autowrap(bool p_autowrap);
bool has_autowrap() const;
void set_uppercase(bool p_uppercase);
bool is_uppercase() const;
void set_visible_characters(int p_amount);
int get_visible_characters() const;
int get_total_character_count() const;
void set_clip_text(bool p_clip);
bool is_clipping_text() const;
void set_percent_visible(float p_percent);
float get_percent_visible() 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() const;
int get_line_count() const;
int get_visible_line_count() const;
Label(const String &p_text = String());
~Label();
};
VARIANT_ENUM_CAST(Label::Align);
VARIANT_ENUM_CAST(Label::VAlign);
#endif