Merge pull request #2449 from leezh/label-valign-fix

reworked Label class

doc/base/classes.xml

@@ -14976,26 +14976,28 @@
 			<argument index="0" name="align" type="int">
 			</argument>
 			<description>
-			Set the alignmend mode to any of the ALIGN_* enumeration values.
+			Sets the alignment mode to any of the ALIGN_* enumeration values.
 			</description>
 		</method>
 		<method name="get_align" qualifiers="const">
 			<return type="int">
 			</return>
 			<description>
-			Return the alignmend mode (any of the ALIGN_* enumeration values).
+			Return the alignment mode (any of the ALIGN_* enumeration values).
 			</description>
 		</method>
 		<method name="set_valign">
 			<argument index="0" name="valign" type="int">
 			</argument>
 			<description>
+			Sets the vertical alignment mode to any of the VALIGN_* enumeration values.
 			</description>
 		</method>
 		<method name="get_valign" qualifiers="const">
 			<return type="int">
 			</return>
 			<description>
+			Return the vertical alignment mode (any of the VALIGN_* enumeration values).
 			</description>
 		</method>
 		<method name="set_text">
@@ -15026,16 +15028,32 @@
 			Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]).
 			</description>
 		</method>
+		<method name="set_clip_text">
+			<argument index="0" name="enable" type="bool">
+			</argument>
+			<description>
+			Cuts off the rest of the text if it is too wide.
+			</description>
+		</method>
+		<method name="is_clipping_text" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+			Return true if text would be cut off if it is too wide.
+			</description>
+		</method>
 		<method name="set_uppercase">
 			<argument index="0" name="enable" type="bool">
 			</argument>
 			<description>
+			Display text in all capitals.
 			</description>
 		</method>
 		<method name="is_uppercase" qualifiers="const">
 			<return type="bool">
 			</return>
 			<description>
+			Return true if text is displayed in all capitals.
 			</description>
 		</method>
 		<method name="get_line_height" qualifiers="const">
@@ -15056,24 +15074,63 @@
 			<return type="int">
 			</return>
 			<description>
+			Return the total length of the text.
 			</description>
 		</method>
 		<method name="set_visible_characters">
-			<argument index="0" name="arg0" type="int">
+			<argument index="0" name="amount" type="int">
 			</argument>
 			<description>
+			Restricts the number of characters to display. Set to -1 to disable.
+			</description>
+		</method>
+		<method name="get_visible_characters" qualifiers="const">
+			<return type="int">
+			</return>
+			<description>
+			Return the restricted number of characters to display. Returns -1 if unrestricted.
 			</description>
 		</method>
 		<method name="set_percent_visible">
 			<argument index="0" name="percent_visible" type="float">
 			</argument>
 			<description>
+			Restricts the number of characters to display (as a percentage of the total text).
 			</description>
 		</method>
 		<method name="get_percent_visible" qualifiers="const">
 			<return type="float">
 			</return>
 			<description>
+			Return the restricted number of characters to display (as a percentage of the total text).
+			</description>
+		</method>
+		<method name="set_max_lines_visible">
+			<argument index="0" name="lines_visible" type="int">
+			</argument>
+			<description>
+			Restricts the number of lines to display. Set to -1 to disable.
+			</description>
+		</method>
+		<method name="get_max_lines_visible" qualifiers="const">
+			<return type="int">
+			</return>
+			<description>
+			Return the restricted number of lines to display. Returns -1 if unrestricted.
+			</description>
+		</method>
+		<method name="set_lines_skipped">
+			<argument index="0" name="lines_skipped" type="int">
+			</argument>
+			<description>
+			Sets the number of lines to skip before displaying. Useful for scrolling text.
+			</description>
+		</method>
+		<method name="get_lines_skipped" qualifiers="const">
+			<return type="int">
+			</return>
+			<description>
+			Return the the number of lines to skipped before displaying.
 			</description>
 		</method>
 	</methods>

scene/gui/label.cpp

@@ -33,15 +33,15 @@
 
 
 void Label::set_autowrap(bool p_autowrap) {
-	
+
 	autowrap=p_autowrap;
 	word_cache_dirty=true;
 	minimum_size_changed();
-	
-	
+	update();
+
 }
 bool Label::has_autowrap() const {
-	
+
 	return autowrap;
 }
 
@@ -51,6 +51,7 @@ void Label::set_uppercase(bool p_uppercase) {
 	uppercase=p_uppercase;
 	word_cache_dirty=true;
 	minimum_size_changed();
+	update();
 }
 bool Label::is_uppercase() const {
 
@@ -66,19 +67,18 @@ int Label::get_line_height() const {
 
 
 void Label::_notification(int p_what) {
-	
+
 	if (p_what==NOTIFICATION_DRAW) {
-		
-		if (clip && !autowrap)
-			VisualServer::get_singleton()->canvas_item_set_clip(get_canvas_item(),true);
 
+		if (clip || autowrap)
+			VisualServer::get_singleton()->canvas_item_set_clip(get_canvas_item(),true);
 
 		if (word_cache_dirty)
 			regenerate_word_cache();
 
-		
+
 		RID ci = get_canvas_item();
-		
+
 		Size2 string_size;
 		Size2 size=get_size();
 
@@ -91,38 +91,43 @@ void Label::_notification(int p_what) {
 		VisualServer::get_singleton()->canvas_item_set_distance_field_mode(get_canvas_item(),font.is_valid() && font->is_distance_field_hint());
 
 		int font_h = font->get_height();
-		int line_from=(int)get_val(); // + p_exposed.pos.y / font_h;
 		int lines_visible = size.y/font_h;
-		int line_to=(int)get_val() + lines_visible; //p_exposed.pos.y+p_exposed.size.height / font_h;
 		int space_w=font->get_char_size(' ').width;
-		int lines_total = get_max();
 		int chars_total=0;
 
 		int vbegin=0,vsep=0;
-		
-		if (lines_total && lines_total < lines_visible) {
 
+		if (lines_visible > line_count) {
+			lines_visible = line_count;
+
+		}
+
+		if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
+			lines_visible = max_lines_visible;
+
+		}
+
+		if (lines_visible > 0) {
 
 			switch(valign) {
 
 				case VALIGN_TOP: {
-
 					//nothing
 				} break;
 				case VALIGN_CENTER: {
-
-					vbegin=(lines_visible-lines_total) * font_h / 2;
+					vbegin=(size.y - lines_visible * font_h) / 2;
 					vsep=0;
+
 				} break;
 				case VALIGN_BOTTOM: {
-					vbegin=(lines_visible-lines_total) * font_h;
+					vbegin=size.y - lines_visible * font_h;
 					vsep=0;
 
 				} break;
 				case VALIGN_FILL: {
 					vbegin=0;
-					if (lines_total>1) {
-						vsep=(lines_visible-lines_total) * font_h / (lines_total-1);
+					if (lines_visible>1) {
+						vsep=(size.y - lines_visible * font_h) / (lines_visible - 1);
 					} else {
 						vsep=0;
 					}
@@ -130,20 +135,21 @@ void Label::_notification(int p_what) {
 				} break;
 			}
 		}
-		
-		
+
+
 		WordCache *wc = word_cache;
 		if (!wc)
 			return;
-		
+
 		int c = 0;
 		int line=0;
+		int line_to=lines_skipped + (lines_visible>0?lines_visible:1);
 		while(wc) {
 		/* handle lines not meant to be drawn quickly */
-			if  (line>line_to)
+			if  (line>=line_to)
 				break;
-			if  (line<line_from) {
-				
+			if  (line<lines_skipped) {
+
 				while (wc && wc->char_pos>=0)
 					wc=wc->next;
 				if (wc)
@@ -151,36 +157,36 @@ void Label::_notification(int p_what) {
 				line++;
 				continue;
 			}
-			
+
 		/* handle lines normally */
-			
+
 			if (wc->char_pos<0) {
 			//empty line
 				wc=wc->next;
 				line++;
 				continue;
 			}
-			
+
 			WordCache *from=wc;
 			WordCache *to=wc;
-			
+
 			int taken=0;
 			int spaces=0;
 			while(to && to->char_pos>=0) {
-				
+
 				taken+=to->pixel_width;
 				if (to!=from && to->space_count) {
 					spaces+=to->space_count;
 				}
 				to=to->next;
 			}
-			
+
 			bool can_fill = to && to->char_pos==WordCache::CHAR_WRAPLINE;
 
 			float x_ofs=0;
-			
+
 			switch (align) {
-				
+
 				case ALIGN_FILL:
 				case ALIGN_LEFT: {
 
@@ -198,16 +204,16 @@ void Label::_notification(int p_what) {
 
 				} break;
 				}
-			
-			int y_ofs=(line-(int)get_val())*font_h + font->get_ascent();
+
+			int y_ofs=(line-lines_skipped)*font_h + font->get_ascent();
 			y_ofs+=vbegin + line*vsep;
-			
+
 			while(from!=to) {
-				
+
 			// draw a word
 				int pos = from->char_pos;
 				if (from->char_pos<0) {
-					
+
 					ERR_PRINT("BUG");
 					return;
 				}
@@ -221,15 +227,15 @@ void Label::_notification(int p_what) {
 
 
 				}
-				
-				
-				
+
+
+
 				if (font_color_shadow.a>0) {
-					
+
 					int chars_total_shadow = chars_total; //save chars drawn
 					float x_ofs_shadow=x_ofs;
 					for (int i=0;i<from->word_len;i++) {
-						
+
 						if (visible_chars < 0 || chars_total_shadow<visible_chars) {
 							CharType c = text[i+pos];
 							CharType n = text[i+pos+1];
@@ -249,7 +255,7 @@ void Label::_notification(int p_what) {
 						}
 					}
 
-					
+
 				}
 				for (int i=0;i<from->word_len;i++) {
 
@@ -268,73 +274,73 @@ void Label::_notification(int p_what) {
 				}
 				from=from->next;
 			}
-			
+
 			wc=to?to->next:0;
 			line++;
-			
-		}		
+
+		}
 	}
-	
+
 	if (p_what==NOTIFICATION_THEME_CHANGED) {
 
 		word_cache_dirty=true;
 		update();
 	}
 	if (p_what==NOTIFICATION_RESIZED) {
-		
+
 		word_cache_dirty=true;
 	}
-	
+
 }
 
 Size2 Label::get_minimum_size() const {
-	
+
 	if (autowrap)
 		return Size2(1,1);
 	else {
-		
+
 		// don't want to mutable everything
-		if(word_cache_dirty) 
+		if(word_cache_dirty)
 			const_cast<Label*>(this)->regenerate_word_cache();
-	
+
 		Size2 ms=minsize;
 		if (clip)
 			ms.width=1;
 		return ms;
-	}		
+	}
 }
 
 int Label::get_longest_line_width() const {
-	
+
 	Ref<Font> font = get_font("font");
 	int max_line_width=0;
 	int line_width=0;
-	
-	for (int i=0;i<text.size()+1;i++) {
-		
-		CharType current=i<text.length()?text[i]:' '; //always a space at the end, so the algo works
+
+	for (int i=0;i<text.size();i++) {
+
+		CharType current=text[i];
 		if (uppercase)
 			current=String::char_uppercase(current);
 
 		if (current<32) {
-						
+
 			if (current=='\n') {
-				
+
 				if (line_width>max_line_width)
 					max_line_width=line_width;
 				line_width=0;
 			}
 		} else {
-			
+
 			int char_width=font->get_char_size(current).width;
-			line_width+=char_width;			
+			line_width+=char_width;
 		}
-		
+
 	}
 
 	if (line_width>max_line_width)
 		max_line_width=line_width;
-	
+
 	return max_line_width;
 }
 
@@ -349,15 +355,15 @@ int Label::get_line_count() const {
 }
 
 void Label::regenerate_word_cache() {
-	
+
 	while (word_cache) {
-		
+
 		WordCache *current=word_cache;
 		word_cache=current->next;
 		memdelete( current );
 	}
-	
-	
+
+
 	int width=autowrap?get_size().width:get_longest_line_width();
 	Ref<Font> font = get_font("font");
 
@@ -368,11 +374,11 @@ void Label::regenerate_word_cache() {
 	int space_width=font->get_char_size(' ').width;
 	line_count=1;
 	total_char_cache=0;
-	
+
 	WordCache *last=NULL;
-	
+
 	for (int i=0;i<text.size()+1;i++) {
-		
+
 		CharType current=i<text.length()?text[i]:' '; //always a space at the end, so the algo works
 
 		if (uppercase)
@@ -429,12 +435,12 @@ void Label::regenerate_word_cache() {
 			if (current_word_size==0) {
 				word_pos=i;
 			}
-			
+
 			char_width=font->get_char_size(current).width;
 			current_word_size+=char_width;
 			line_width+=char_width;
 			total_char_cache++;
-			
+
 		}
 
 		if ((autowrap && (line_width >= width) && ((last && last->char_pos >= 0) || separatable)) || insert_newline) {
@@ -474,29 +480,22 @@ void Label::regenerate_word_cache() {
 			space_count=0;
 
 		}
-		
+
 	}
-	
-	//total_char_cache -= line_count + 1; // do not count new lines (including the first one)
-	
+
 	if (!autowrap) {
-		
 		minsize.width=width;
-		minsize.height=font->get_height()*line_count;
-		set_page( line_count );
-		
-	} else {
-	
-		set_page( get_size().height / font->get_height() );
+		if (max_lines_visible > 0 && line_count > max_lines_visible) {
+			minsize.height=font->get_height()*max_lines_visible;
+		} else {
+			minsize.height=font->get_height()*line_count;
+		}
 	}
-	
-	set_max(line_count);
-	
+
 	word_cache_dirty=false;
 
 }
 
-
 void Label::set_align(Align p_align) {
 
 	ERR_FAIL_INDEX(p_align,4);
@@ -505,7 +504,7 @@ void Label::set_align(Align p_align) {
 }
 
 Label::Align Label::get_align() const{
-	
+
 	return align;
 }
 
@@ -522,24 +521,23 @@ Label::VAlign Label::get_valign() const{
 }
 
 void Label::set_text(const String& p_string) {
-	
+
 	String str = XL_MESSAGE(p_string);
 
 	if (text==str)
 		return;
-	
+
 	text=str;
 	word_cache_dirty=true;
+	if (percent_visible<1)
+		visible_chars=get_total_character_count()*percent_visible;
 	update();
-	if (!autowrap)
-		minimum_size_changed();
-	
+	minimum_size_changed();
+
 }
 
 void Label::set_clip_text(bool p_clip) {
 
-	if (clip==p_clip)
-		return;
 	clip=p_clip;
 	update();
 	minimum_size_changed();
@@ -551,23 +549,39 @@ bool Label::is_clipping_text() const {
 }
 
 String Label::get_text() const {
-	
+
 	return text;
 }
 
 void Label::set_visible_characters(int p_amount) {
 
 	visible_chars=p_amount;
+	if (get_total_character_count() > 0) {
+		percent_visible=(float)p_amount/(float)total_char_cache;
+	}
 	update();
 }
 
+int Label::get_visible_characters() const {
+
+	return visible_chars;
+}
+
 void Label::set_percent_visible(float p_percent) {
 
-	if (p_percent<0)
-		set_visible_characters(-1);
-	else
-		set_visible_characters(get_total_character_count()*p_percent);	
-	percent_visible=p_percent;
+	if (p_percent<0 || p_percent>=1) {
+
+		visible_chars=-1;
+		percent_visible=1;
+
+	} else {
+
+		visible_chars=get_total_character_count()*p_percent;
+		percent_visible=p_percent;
+
+	}
+	update();
+
 }
 
 float Label::get_percent_visible() const{
@@ -575,6 +589,27 @@ float Label::get_percent_visible() const{
 	return percent_visible;
 }
 
+void Label::set_lines_skipped(int p_lines) {
+
+	lines_skipped=p_lines;
+	update();
+}
+
+int Label::get_lines_skipped() const{
+
+	return lines_skipped;
+}
+
+void Label::set_max_lines_visible(int p_lines) {
+
+	max_lines_visible=p_lines;
+	update();
+}
+
+int Label::get_max_lines_visible() const{
+
+	return max_lines_visible;
+}
 
 int Label::get_total_character_count() const {
 
@@ -585,7 +620,7 @@ int Label::get_total_character_count() const {
 }
 
 void Label::_bind_methods() {
-	
+
 	ObjectTypeDB::bind_method(_MD("set_align","align"),&Label::set_align);
 	ObjectTypeDB::bind_method(_MD("get_align"),&Label::get_align);
 	ObjectTypeDB::bind_method(_MD("set_valign","valign"),&Label::set_valign);
@@ -594,14 +629,21 @@ void Label::_bind_methods() {
 	ObjectTypeDB::bind_method(_MD("get_text"),&Label::get_text);
 	ObjectTypeDB::bind_method(_MD("set_autowrap","enable"),&Label::set_autowrap);
 	ObjectTypeDB::bind_method(_MD("has_autowrap"),&Label::has_autowrap);
+	ObjectTypeDB::bind_method(_MD("set_clip_text","enable"),&Label::set_clip_text);
+	ObjectTypeDB::bind_method(_MD("is_clipping_text"),&Label::is_clipping_text);
 	ObjectTypeDB::bind_method(_MD("set_uppercase","enable"),&Label::set_uppercase);
 	ObjectTypeDB::bind_method(_MD("is_uppercase"),&Label::is_uppercase);
 	ObjectTypeDB::bind_method(_MD("get_line_height"),&Label::get_line_height);
 	ObjectTypeDB::bind_method(_MD("get_line_count"),&Label::get_line_count);
 	ObjectTypeDB::bind_method(_MD("get_total_character_count"),&Label::get_total_character_count);
-	ObjectTypeDB::bind_method(_MD("set_visible_characters"),&Label::set_visible_characters);
+	ObjectTypeDB::bind_method(_MD("set_visible_characters","amount"),&Label::set_visible_characters);
+	ObjectTypeDB::bind_method(_MD("get_visible_characters"),&Label::get_visible_characters);
 	ObjectTypeDB::bind_method(_MD("set_percent_visible","percent_visible"),&Label::set_percent_visible);
 	ObjectTypeDB::bind_method(_MD("get_percent_visible"),&Label::get_percent_visible);
+	ObjectTypeDB::bind_method(_MD("set_lines_skipped","lines_skipped"),&Label::set_lines_skipped);
+	ObjectTypeDB::bind_method(_MD("get_lines_skipped"),&Label::get_lines_skipped);
+	ObjectTypeDB::bind_method(_MD("set_max_lines_visible","lines_visible"),&Label::set_max_lines_visible);
+	ObjectTypeDB::bind_method(_MD("get_max_lines_visible"),&Label::get_max_lines_visible);
 
 	BIND_CONSTANT( ALIGN_LEFT );
 	BIND_CONSTANT( ALIGN_CENTER );
@@ -617,18 +659,21 @@ void Label::_bind_methods() {
 	ADD_PROPERTYNZ( PropertyInfo( Variant::INT, "align", PROPERTY_HINT_ENUM,"Left,Center,Right,Fill" ),_SCS("set_align"),_SCS("get_align") );
 	ADD_PROPERTYNZ( PropertyInfo( Variant::INT, "valign", PROPERTY_HINT_ENUM,"Top,Center,Bottom,Fill" ),_SCS("set_valign"),_SCS("get_valign") );
 	ADD_PROPERTYNZ( PropertyInfo( Variant::BOOL, "autowrap"),_SCS("set_autowrap"),_SCS("has_autowrap") );
+	ADD_PROPERTYNZ( PropertyInfo( Variant::BOOL, "clip_text"),_SCS("set_clip_text"),_SCS("is_clipping_text") );
 	ADD_PROPERTYNZ( PropertyInfo( Variant::BOOL, "uppercase"),_SCS("set_uppercase"),_SCS("is_uppercase") );
 	ADD_PROPERTY( PropertyInfo( Variant::REAL, "percent_visible", PROPERTY_HINT_RANGE,"0,1,0.001"),_SCS("set_percent_visible"),_SCS("get_percent_visible") );
+	ADD_PROPERTY( PropertyInfo( Variant::INT, "lines_skipped", PROPERTY_HINT_RANGE,"0,999,1"),_SCS("set_lines_skipped"),_SCS("get_lines_skipped") );
+	ADD_PROPERTY( PropertyInfo( Variant::INT, "max_lines_visible", PROPERTY_HINT_RANGE,"-1,999,1"),_SCS("set_max_lines_visible"),_SCS("get_max_lines_visible") );
 
 }
 
 Label::Label(const String &p_text) {
-	
+
 	align=ALIGN_LEFT;
 	valign=VALIGN_TOP;
 	text="";
 	word_cache=NULL;
-	word_cache_dirty=true;	
+	word_cache_dirty=true;
 	autowrap=false;
 	line_count=0;
 	set_v_size_flags(0);
@@ -636,20 +681,22 @@ Label::Label(const String &p_text) {
 	set_ignore_mouse(true);
 	total_char_cache=0;
 	visible_chars=-1;
-	percent_visible=-1;
+	percent_visible=1;
+	lines_skipped=0;
+	max_lines_visible=-1;
 	set_text(p_text);
 	uppercase=false;
 }
 
 
 Label::~Label() {
-	
+
 	while (word_cache) {
-		
+
 		WordCache *current=word_cache;
 		word_cache=current->next;
 		memdelete( current );
-	}	
+	}
 }
 
 

scene/gui/label.h

@@ -29,17 +29,17 @@
 #ifndef LABEL_H
 #define LABEL_H
 
-#include "scene/gui/range.h"
+#include "scene/gui/control.h"
 /**
 	@author Juan Linietsky <[email protected]>
 */
-class Label : public Range {
-	
-	OBJ_TYPE( Label, Range );	
-public:	
-	
+class Label : public Control {
+
+	OBJ_TYPE( Label, Control );
+public:
+
 	enum Align {
-		
+
 		ALIGN_LEFT,
 		ALIGN_CENTER,
 		ALIGN_RIGHT,
@@ -63,11 +63,11 @@ private:
 	Size2 minsize;
 	int line_count;
 	bool uppercase;
-	
+
 	int get_longest_line_width() const;
-	
+
 	struct WordCache {
-		
+
 		enum {
 			CHAR_NEWLINE=-1,
 			CHAR_WRAPLINE=-2
@@ -78,23 +78,25 @@ private:
 		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;
-protected:		
+	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);
@@ -105,7 +107,7 @@ public:
 
 	void set_text(const String& p_string);
 	String get_text() const;
-	
+
 	void set_autowrap(bool p_autowrap);
 	bool has_autowrap() const;
 
@@ -113,6 +115,7 @@ public:
 	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);
@@ -121,6 +124,11 @@ public:
 	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;