WoW:UIOBJECT FontString - Revision history

Move page script: Move page script moved page UIOBJECT FontString to WoW:UIOBJECT FontString without leaving a redirect

2023-08-15T04:49:06Z

Move page script moved page UIOBJECT FontString to UIOBJECT FontString without leaving a redirect

← Older revision	Revision as of 04:49, 15 August 2023
(No difference)

Bear at 23:56, 14 February 2015

2015-02-14T23:56:50Z

← Older revision		Revision as of 23:56, 14 February 2015
Line 1:		Line 1:
	{{widget}}		{{widget}}
			''Note: FontString:Get/SetWidth() and Get/SetHeight() behave very differently compared to usual base type funcitonality.''

	== ~~FontStrings and~~ anchor points~~, GetHeight()~~ and ~~SetHeight() =~~=		== anchor points and height ==
	~~<div style~~=~~"margin-left: 3%;">~~

	FontString objects behave a little differently where SetHeight(), GetHeight(), SetWidth() and GetWidth() are concerned.		FontString objects behave a little differently where SetHeight(), GetHeight(), SetWidth() and GetWidth() are concerned.

Line 9:		Line 8:

	=== Anchoring 1 corner ===		=== Anchoring 1 corner ===
	~~<div style="margin-left: 3%;">~~

	Let's assume we have a frame that is 100x100, and that we anchor our fontstring to the topleft corner only, and tell it to display a sizeable chunk of text in a 10 point font, that is ~250 pixels long if nonwrapped (i.e. [[API FontString GetStringWidth\|GetStringWidth()]] would return 250).		Let's assume we have a frame that is 100x100, and that we anchor our fontstring to the topleft corner only, and tell it to display a sizeable chunk of text in a 10 point font, that is ~250 pixels long if nonwrapped (i.e. [[API FontString GetStringWidth\|GetStringWidth()]] would return 250).

Line 45:		Line 42:

	So far, no real surprises, except for the fact that fontstrings will display without a width and height set, while other objects do not. The fun starts when we anchor more points.		So far, no real surprises, except for the fact that fontstrings will display without a width and height set, while other objects do not. The fun starts when we anchor more points.

	~~</div>~~

	=== Anchoring more points ===		=== Anchoring more points ===
	~~<div style="margin-left: 3%;">~~

	When you control the dimensions by anchoring more than one point, the drawn text will obey your points. But GetWidth() and GetHeight() continue to operate in their own little world.		When you control the dimensions by anchoring more than one point, the drawn text will obey your points. But GetWidth() and GetHeight() continue to operate in their own little world.
Line 83:		Line 77:

	If you want to completely clear width or height once set to have WoW start returning computed values for you, you need to call SetWidth(0) or SetHeight(0).		If you want to completely clear width or height once set to have WoW start returning computed values for you, you need to call SetWidth(0) or SetHeight(0).
	~~</div>~~

	=== Code example ===		=== Code example ===
	~~<div style="margin-left: 3%;">~~
	This example will rescale a frame to fit the text. On all four sides a 5px margin is made.		This example will rescale a frame to fit the text. On all four sides a 5px margin is made.
	text:SetPoint("TOPLEFT",frame,"TOPLEFT",5,-5)		text:SetPoint("TOPLEFT",frame,"TOPLEFT",5,-5)
Line 92:		Line 85:
	frame:SetHeight(text:GetHeight() + 15)		frame:SetHeight(text:GetHeight() + 15)
	Note that the number returned by text:GetHeight() will typically be slighly less than the actual height of the text. Including a 5px margin (both top and bottom), the height of the frame is therefor set to the text height plus 15px.		Note that the number returned by text:GetHeight() will typically be slighly less than the actual height of the text. Including a 5px margin (both top and bottom), the height of the frame is therefor set to the text height plus 15px.
	~~</div>~~

	~~</div>~~
	[[Category:Widgets]]		[[Category:Widgets]]

WoWWiki>Anea at 10:58, 26 March 2008

2008-03-26T10:58:20Z

← Older revision		Revision as of 10:58, 26 March 2008
Line 81:		Line 81:

	However, calling SetWidth() with your object's actual width (which you can't get via GetWidth(), but you can try GetLeft()-GetRight()), and calling GetHeight() will still tell you how high the object actually needs to be.		However, calling SetWidth() with your object's actual width (which you can't get via GetWidth(), but you can try GetLeft()-GetRight()), and calling GetHeight() will still tell you how high the object actually needs to be.


	If you want to completely clear width or height once set to have WoW start returning computed values for you, you need to call SetWidth(0) or SetHeight(0).		If you want to completely clear width or height once set to have WoW start returning computed values for you, you need to call SetWidth(0) or SetHeight(0).
			</div>

			=== Code example ===
			<div style="margin-left: 3%;">
			This example will rescale a frame to fit the text. On all four sides a 5px margin is made.
			text:SetPoint("TOPLEFT",frame,"TOPLEFT",5,-5)
			text:SetWidth(frame:GetRight() - frame:GetLeft() - 10)
			frame:SetHeight(text:GetHeight() + 15)
			Note that the number returned by text:GetHeight() will typically be slighly less than the actual height of the text. Including a 5px margin (both top and bottom), the height of the frame is therefor set to the text height plus 15px.
			</div>


	~~</div>~~
	</div>		</div>
	[[Category:Widgets]]		[[Category:Widgets]]

WoWWiki>Drundia: /* Anchoring more points */

2007-08-16T18:59:18Z

Anchoring more points

← Older revision		Revision as of 18:59, 16 August 2007
Line 80:		Line 80:
	If we anchor all sides (e.g. add a "BOTTOM" anchor to the previous fontstring, or change the "TOPRIGHT" to a "BOTTOMRIGHT"), SetWidth() and SetHeight() completely cease to have any effect whatsoever on the output. All output will obey the anchoring points.		If we anchor all sides (e.g. add a "BOTTOM" anchor to the previous fontstring, or change the "TOPRIGHT" to a "BOTTOMRIGHT"), SetWidth() and SetHeight() completely cease to have any effect whatsoever on the output. All output will obey the anchoring points.

	However, calling SetWidth() with your object's actual width (which you can't get via GetWidth()!), and calling GetHeight() will still tell you how high the object actually needs to be.		However, calling SetWidth() with your object's actual width (which you can't get via GetWidth(), but you can try GetLeft()-GetRight()), and calling GetHeight() will still tell you how high the object actually needs to be.


	~~Note that~~ you ~~can never~~ completely ~~''un''-set a~~ width or height once set~~. You can ''change'' it, but if you want to completely clear it~~ to have WoW start returning computed values for you, you need to ~~create a new fonstring~~ or ~~reload the UI.~~ (~~At least at the time of this writing, july 2006, version 1.11.2~~).		If you want to completely clear width or height once set to have WoW start returning computed values for you, you need to call SetWidth(0) or SetHeight(0).

WoWWiki>Hobinbot: demoted headings

2007-01-07T15:24:29Z

demoted headings

← Older revision		Revision as of 15:24, 7 January 2007
Line 1:		Line 1:
	{{widget}}		{{widget}}

	= FontStrings and anchor points, GetHeight() and SetHeight() =		== FontStrings and anchor points, GetHeight() and SetHeight() ==
	<div style="margin-left: 3%;">		<div style="margin-left: 3%;">

Line 8:		Line 8:
	Neither of them necessarily directly work with the area used to paint the fontstring. Rather, they're used to compute what dimensions are needed in one direction, given the size in the other direction.		Neither of them necessarily directly work with the area used to paint the fontstring. Rather, they're used to compute what dimensions are needed in one direction, given the size in the other direction.

	== Anchoring 1 corner ==		=== Anchoring 1 corner ===
	<div style="margin-left: 3%;">		<div style="margin-left: 3%;">

Line 48:		Line 48:
	</div>		</div>

	== Anchoring more points ==		=== Anchoring more points ===
	<div style="margin-left: 3%;">		<div style="margin-left: 3%;">

WoWWiki>Mikk: /* Anchoring 1 corner */ typo

2006-11-03T23:23:44Z

Anchoring 1 corner: typo

← Older revision		Revision as of 23:23, 3 November 2006
Line 39:		Line 39:
	\|		\|
	* The output is clamped to 100 pixels wide and 20 pixels high		* The output is clamped to 100 pixels wide and 20 pixels high
	* GetWidth() will always ~~return~~ return 100 no matter how much text there is		* GetWidth() will always return 100 no matter how much text there is
	* GetHeight() will always ~~return~~ return 20 no matter how much text there is		* GetHeight() will always return 20 no matter how much text there is
	\|}		\|}

Line 47:		Line 47:

	</div>		</div>

	== Anchoring more points ==		== Anchoring more points ==
	<div style="margin-left: 3%;">		<div style="margin-left: 3%;">

WoWWiki>Mbudde at 19:55, 3 November 2006

2006-11-03T19:55:47Z

← Older revision		Revision as of 19:55, 3 November 2006
Line 8:		Line 8:
	Neither of them necessarily directly work with the area used to paint the fontstring. Rather, they're used to compute what dimensions are needed in one direction, given the size in the other direction.		Neither of them necessarily directly work with the area used to paint the fontstring. Rather, they're used to compute what dimensions are needed in one direction, given the size in the other direction.

	== Anchoring 1 corner == <div style="margin-left: 3%;">		== Anchoring 1 corner ==
			<div style="margin-left: 3%;">

	Let's assume we have a frame that is 100x100, and that we anchor our fontstring to the topleft corner only, and tell it to display a sizeable chunk of text in a 10 point font, that is ~250 pixels long if nonwrapped (i.e. [[API FontString GetStringWidth\|GetStringWidth()]] would return 250).		Let's assume we have a frame that is 100x100, and that we anchor our fontstring to the topleft corner only, and tell it to display a sizeable chunk of text in a 10 point font, that is ~250 pixels long if nonwrapped (i.e. [[API FontString GetStringWidth\|GetStringWidth()]] would return 250).
Line 16:		Line 17:
	\|		\|
	* The text runs off as far as it needs to.		* The text runs off as far as it needs to.
	* GetWidth() will ~~return~~ return 250, the same as GetStringWidth()		* GetWidth() will return 250, the same as GetStringWidth()
	* GetHeight() will return 10		* GetHeight() will return 10
	\|}		\|}
Line 46:		Line 47:

	</div>		</div>
	== Anchoring more points == <div style="margin-left: 3%;">		== Anchoring more points ==
			<div style="margin-left: 3%;">

	When you control the dimensions by anchoring more than one point, the drawn text will obey your points. But GetWidth() and GetHeight() continue to operate in their own little world.		When you control the dimensions by anchoring more than one point, the drawn text will obey your points. But GetWidth() and GetHeight() continue to operate in their own little world.
Line 54:		Line 56:
	\|		\|
	* The output gets clamped to 100 pixels wide by the anchor points		* The output gets clamped to 100 pixels wide by the anchor points
	* GetWidth() will ~~return~~ return 250 ('''!''')		* GetWidth() will return 250 ('''!''')
	* GetHeight() will ~~return~~ return 10 ('''!''')		* GetHeight() will return 10 ('''!''')
	\|}		\|}

	Doing SetWidth(100) will result in:		Doing SetWidth(100) will result in:
	* The output remains clamped to 100 pixels wide '''by the anchor points'''		* The output remains clamped to 100 pixels wide '''by the anchor points'''
	* GetWidth() will ~~return~~ return 100		* GetWidth() will return 100
	* GetHeight() will ~~return~~ return 40		* GetHeight() will return 40

	Doing SetWidth(50) will result in:		Doing SetWidth(50) will result in:
	* The output remains clamped to 100 pixels wide '''by the anchor points'''		* The output remains clamped to 100 pixels wide '''by the anchor points'''
	* GetWidth() will ~~return~~ return 50		* GetWidth() will return 50
	* GetHeight() will ~~return~~ return 80 (or something)		* GetHeight() will return 80 (or something)

	Adding a SetHeight(20) will result in:		Adding a SetHeight(20) will result in:

WoWWiki>Mikk: Describing how fontstring wrapping works in relation to anchor points and width/height

2006-07-22T02:28:25Z

Describing how fontstring wrapping works in relation to anchor points and width/height

New page

{{widget}}

= FontStrings and anchor points, GetHeight() and SetHeight() =
<div style="margin-left: 3%;">

FontString objects behave a little differently where SetHeight(), GetHeight(), SetWidth() and GetWidth() are concerned.

Neither of them necessarily directly work with the area used to paint the fontstring. Rather, they're used to compute what dimensions are needed in one direction, given the size in the other direction.

== Anchoring 1 corner == <div style="margin-left: 3%;">

Let's assume we have a frame that is 100x100, and that we anchor our fontstring to the topleft corner only, and tell it to display a sizeable chunk of text in a 10 point font, that is ~250 pixels long if nonwrapped (i.e. [[API FontString GetStringWidth|GetStringWidth()]] would return 250).

{| style="background-color: transparent;"
| [[Image:fontstring-wrapping-100x100-topleft.gif]]
|
* The text runs off as far as it needs to.
* GetWidth() will return return 250, the same as GetStringWidth()
* GetHeight() will return 10
|}

Now, if we explicitly SetWidth(100), the following happens:

{| style="background-color: transparent;"
| [[Image:fontstring-wrapping-100x100-topleft-w100.gif]]
|
* The output is clamped to 100 pixels wide
* GetWidth() will always return return 100 no matter how much text there is
* GetHeight() will return 40 (it needed 4 lines to display the entire text)
|}

And if we add a SetHeight(20), it will do what we expect:

{| style="background-color: transparent;"
| [[Image:fontstring-wrapping-100x100-topleft-w100-h20.gif]]
|
* The output is clamped to 100 pixels wide and 20 pixels high
* GetWidth() will always return return 100 no matter how much text there is
* GetHeight() will always return return 20 no matter how much text there is
|}

So far, no real surprises, except for the fact that fontstrings will display without a width and height set, while other objects do not. The fun starts when we anchor more points.

</div>
== Anchoring more points == <div style="margin-left: 3%;">

When you control the dimensions by anchoring more than one point, the drawn text will obey your points. But GetWidth() and GetHeight() continue to operate in their own little world.

{| style="background-color: transparent;"
| [[Image:fontstring-wrapping-100x100-topleft-topright.gif]]
|
* The output gets clamped to 100 pixels wide by the anchor points
* GetWidth() will return return 250 ('''!''')
* GetHeight() will return return 10 ('''!''')
|}

Doing SetWidth(100) will result in:
* The output remains clamped to 100 pixels wide '''by the anchor points'''
* GetWidth() will return return 100
* GetHeight() will return return 40

Doing SetWidth(50) will result in:
* The output remains clamped to 100 pixels wide '''by the anchor points'''
* GetWidth() will return return 50
* GetHeight() will return return 80 (or something)

Adding a SetHeight(20) will result in:
* The output remains clamped to 100 pixels wide '''by the anchor points'''
* Only the two first lines display (text is truncated)
* GetWidth() will return 50
* GetHeight() will return 20

If we anchor all sides (e.g. add a "BOTTOM" anchor to the previous fontstring, or change the "TOPRIGHT" to a "BOTTOMRIGHT"), SetWidth() and SetHeight() completely cease to have any effect whatsoever on the output. All output will obey the anchoring points.

However, calling SetWidth() with your object's actual width (which you can't get via GetWidth()!), and calling GetHeight() will still tell you how high the object actually needs to be.

Note that you can never completely ''un''-set a width or height once set. You can ''change'' it, but if you want to completely clear it to have WoW start returning computed values for you, you need to create a new fonstring or reload the UI. (At least at the time of this writing, july 2006, version 1.11.2).

</div>
</div>
[[Category:Widgets]]