godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/StyleBoxTexture.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

123 lines
6.9 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 4.1-dev Can't stop, won't stop, they said, huh?
2023-03-01 00:44:37 +00:00
<class name="StyleBoxTexture" inherits="StyleBox" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A texture-based nine-patch [StyleBox].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A texture-based nine-patch [StyleBox], in a way similar to [NinePatchRect]. This stylebox performs a 3×3 scaling of a texture, where only the center cell is fully stretched. This makes it possible to design bordered styles regardless of the stylebox's size.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<method name="get_expand_margin" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="margin" type="int" enum="Side" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
<description>
Rename Control margin to offset
2020-12-22 16:24:29 +00:00
Returns the expand margin size of the specified [enum Side].
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
</description>
</method>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<method name="get_texture_margin" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="margin" type="int" enum="Side" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
<description>
Rename Control margin to offset
2020-12-22 16:24:29 +00:00
Returns the margin size of the specified [enum Side].
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
</description>
</method>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<method name="set_expand_margin">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<param index="0" name="margin" type="int" enum="Side" />
<param index="1" name="size" type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
Sets the expand margin to [param size] pixels for the specified [enum Side].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<method name="set_expand_margin_all">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<param index="0" name="size" type="float" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
<description>
Various classref typo fixes
2023-02-20 03:18:57 +00:00
Sets the expand margin to [param size] pixels for all sides.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
</description>
</method>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<method name="set_texture_margin">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="margin" type="int" enum="Side" />
<param index="1" name="size" type="float" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 02:00:19 +00:00
Sets the margin to [param size] pixels for the specified [enum Side].
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 14:10:09 +00:00
</description>
</method>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<method name="set_texture_margin_all">
Add set_default_margin_all/individual to StyleBox
2022-03-12 04:38:44 +00:00
<return type="void" />
<param index="0" name="size" type="float" />
<description>
Sets the margin to [param size] pixels for all sides.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode" default="0">
Improve the StyleBox class documentations
2019-12-03 14:46:11 +00:00
Controls how the stylebox's texture will be stretched or tiled horizontally. See [enum AxisStretchMode] for possible values.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="axis_stretch_vertical" type="int" setter="set_v_axis_stretch_mode" getter="get_v_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode" default="0">
Improve the StyleBox class documentations
2019-12-03 14:46:11 +00:00
Controls how the stylebox's texture will be stretched or tiled vertically. See [enum AxisStretchMode] for possible values.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled" default="true">
Improve the StyleBox class documentations
2019-12-03 14:46:11 +00:00
If [code]true[/code], the nine-patch texture's center tile will be drawn.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<member name="expand_margin_bottom" type="float" setter="set_expand_margin" getter="get_expand_margin" default="0.0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<member name="expand_margin_left" type="float" setter="set_expand_margin" getter="get_expand_margin" default="0.0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Expands the left margin of this style box when drawing, causing it to be drawn larger than requested.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<member name="expand_margin_right" type="float" setter="set_expand_margin" getter="get_expand_margin" default="0.0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Expands the right margin of this style box when drawing, causing it to be drawn larger than requested.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<member name="expand_margin_top" type="float" setter="set_expand_margin" getter="get_expand_margin" default="0.0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Expands the top margin of this style box when drawing, causing it to be drawn larger than requested.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate" default="Color(1, 1, 1, 1)">
Modulates the color of the texture when this style box is drawn.
</member>
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2(0, 0, 0, 0)">
Species a sub-region of the texture to use.
This is equivalent to first wrapping the texture in an [AtlasTexture] with the same region.
Don't change region_rect when setting texture
2023-01-25 23:44:29 +00:00
If empty ([code]Rect2(0, 0, 0, 0)[/code]), the whole texture will be used.
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
</member>
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
The texture to use when drawing this style box.
</member>
<member name="texture_margin_bottom" type="float" setter="set_texture_margin" getter="get_texture_margin" default="0.0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Increases the bottom margin of the 3×3 texture box.
A higher value means more of the source texture is considered to be part of the bottom border of the 3×3 box.
Improve documentation for StyleBox. I want to just say that the terms used by style boxes are all over the place and quite confusing. It's even worse internally.
2019-02-06 16:18:02 +00:00
This is also the value used as fallback for [member StyleBox.content_margin_bottom] if it is negative.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<member name="texture_margin_left" type="float" setter="set_texture_margin" getter="get_texture_margin" default="0.0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Increases the left margin of the 3×3 texture box.
A higher value means more of the source texture is considered to be part of the left border of the 3×3 box.
Improve documentation for StyleBox. I want to just say that the terms used by style boxes are all over the place and quite confusing. It's even worse internally.
2019-02-06 16:18:02 +00:00
This is also the value used as fallback for [member StyleBox.content_margin_left] if it is negative.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<member name="texture_margin_right" type="float" setter="set_texture_margin" getter="get_texture_margin" default="0.0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Increases the right margin of the 3×3 texture box.
A higher value means more of the source texture is considered to be part of the right border of the 3×3 box.
Improve documentation for StyleBox. I want to just say that the terms used by style boxes are all over the place and quite confusing. It's even worse internally.
2019-02-06 16:18:02 +00:00
This is also the value used as fallback for [member StyleBox.content_margin_right] if it is negative.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Clean-up, harmonize, and improve StyleBox API - Make all margin properties follow the same naming convention (their getter and setter too). - Remove a virtual counterpart of `get_style_margin` from API. - Allow to override `get_minimum_size` from scripting and remove `get_center_size`.
2023-01-19 16:14:09 +00:00
<member name="texture_margin_top" type="float" setter="set_texture_margin" getter="get_texture_margin" default="0.0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Increases the top margin of the 3×3 texture box.
A higher value means more of the source texture is considered to be part of the top border of the 3×3 box.
Improve documentation for StyleBox. I want to just say that the terms used by style boxes are all over the place and quite confusing. It's even worse internally.
2019-02-06 16:18:02 +00:00
This is also the value used as fallback for [member StyleBox.content_margin_top] if it is negative.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode">
Improve the StyleBox class documentations
2019-12-03 14:46:11 +00:00
Stretch the stylebox's texture. This results in visible distortion unless the texture size matches the stylebox's size perfectly.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode">
Improve the StyleBox class documentations
2019-12-03 14:46:11 +00:00
Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode">
Improve the StyleBox class documentations
2019-12-03 14:46:11 +00:00
Repeats the stylebox's texture to match the stylebox's size according to the nine-patch system. Unlike [constant AXIS_STRETCH_MODE_TILE], the texture may be slightly stretched to make the nine-patch texture tile seamlessly.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>