summaryrefslogtreecommitdiff
path: root/doc/classes/Control.xml
AgeCommit message (Collapse)Author
2020-11-26[Complex Text Layouts] Add TextServer documentation. Update Font, ↵bruvzg
CanvasItem, Theme and modified controls documentation.
2020-11-16Merge pull request #42008 from Calinou/theme-rename-node-typeRémi Verschelde
Rename the `type` parameter to `node_type` in Theme and Control
2020-11-03Tooltips: Improve code clarity and docsRémi Verschelde
The return type for `_make_custom_tooltip` is clarified as Control, and users should make sure to return a visible node for proper size calculations. Moreover in the current master branch, a PopupPanel will be added as parent to the provided tooltip to make it a sub-window. Clarifies documentation for `Control._make_custom_tooltip`, and shows how to use the (until now undocumented) "TooltipPanel" and "TooltipLabel" theme types to style tooltips. Fixes #39677.
2020-10-27Rename the `type` parameter to `node_type` in Theme and ControlHugo Locurcio
This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-10-02Updated getters and setters names for toplevelDuroxxigar
2020-10-01Link to demos from within the class referenceAaron Franke
2020-09-26Translate GDScript Code Examples to C# (C)HaSa1002
Translates Code Examples in classes beginning with `C`. Includes: * Callable * CanvasItem * CharFXTransform * Color * ColorRect * ConfigFile * ConfirmationDialog * Control * Crypto
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-04Improve the documentation related to overriding GUI theme itemsHugo Locurcio
Overriding theme items is a common point of confusion. Hopefully, these code samples should clear things up.
2020-07-15Document caveats related to Control scalingHugo Locurcio
This is a common topic of confusion. Clarifying its intended scope should make things easier to understand.
2020-04-10Improve shortcut formatting in docsYuri Sizov
2020-04-09Clarify documentation and indicate that rect_clip_content affects only ↵Markus Sauermann
CanvasItem based nodes. Resolves #37683
2020-03-31doc: Sync classref with DisplayServer/Window changesRémi Verschelde
2020-02-22doc: Sync classref with StringName/Callable changesRémi Verschelde
2020-02-12doc: Sync classref with current sourceRémi Verschelde
Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-10[DOCS] Corrections and clarifications to classrefChris Bradfield
2019-11-07[Doc] Added more details for set_drag_preview()Anthony Rey
2019-11-02Code format for true/false/null to make documentation consistentPouleyKetchoupp
2019-09-19Fix misc. source comment typosluz.paz
Found using `codespell -q 3 -S ./thirdparty,*.po -L ang,ba,cas,dof,doubleclick,fave,hist,leapyear,lod,nd,numer,ois,paket,seeked,sinc,switchs,te,uint -D ~/Projects/codespell/codespell_lib/data/dictionary.txt `
2019-08-29doc: Sync classref with current sourceRémi Verschelde
2019-08-22doc: Sync classref with current sourceRémi Verschelde
Fix wrong hyperlinks in Control and Tree.
2019-08-13doc: Sync classref with current sourceRémi Verschelde
2019-08-07Complete the Control class documentationTomasz Chabora
2019-07-15doc: Sync classref with current sourceRémi Verschelde
2019-07-04DocData: Re-expose parametric setters and gettersRémi Verschelde
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-30doc: Remove null default values that can't be determinedRémi Verschelde
Applying #30187.
2019-06-30doc: Remove hardcoded default values from descriptionsRémi Verschelde
They are now generated automatically by doctool.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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-27doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde
2019-06-03doc: Fix DocData.merge_from copying old setters and gettersRémi Verschelde
This is not necessary and means that some setters and getters can end up wrong if they are changed in the bindings but DocData does not update them when running --doctool. Fixes #29425. Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2019-05-30More accurate description of valid ParentsAspin
I hope this is the right place to edit now.
2019-05-23Change "Return" to "Returns" where necessary in XML documentationSean Heffernan
In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-21doc: Sync classref with current sourceRémi Verschelde
2019-04-22Merge pull request #28125 from KoBeWi/code_true_codeRémi Verschelde
Consistently wrap booleans in [code]
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-17Consistently wrap booleans in [code]Tomasz Chabora
2019-04-05Merge pull request #27465 from ↵Rémi Verschelde
neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-03-29ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-02-20Add tooltip for in-editor FPS display in 3D viewportRémi Verschelde
Also enhance Control/Label documentation about tooltips and mouse filter, as it took me a while to understand why Labels didn't show tooltips. Closes #26082.
2019-02-13Fix typos with codespellRémi Verschelde
Using codespell 1.14.0. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang doubleclick lod nd numer que te unselect EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
2019-01-21Update Control.xmldanboo
The mouse_filter documentation was biased towards button click events, so add more mention of its impact on mouse_entered and mouse_exited signals as well.
2019-01-07doc: Fix wrong references found by Sphinx and new makerst.pyRémi Verschelde
2019-01-07doc: Fix wrong references found by new makerst.pyRémi Verschelde
Thanks @PJB3005
2019-01-06Merge pull request #24608 from PJB3005/18-12-26-control-docsRémi Verschelde
Improve documentation of Control.
2019-01-04Improve documentation of Control.Pieter-Jan Briers
2018-12-29doc: Fix references to setters and misc formattingRémi Verschelde