Skip to content

Commit

Permalink
[TASK] Revise GIFBUILDER object WORKAREA (#894)
Browse files Browse the repository at this point in the history
- Replace container table-row with a sphinx object type
- Add a TOC for the properties
- Sort properties alphabetically

Releases: main, 12.4, 11.5
  • Loading branch information
brotkrueml authored Nov 12, 2023
1 parent 9fb6e2c commit 719fe0a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 26 deletions.
46 changes: 20 additions & 26 deletions Documentation/Gifbuilder/ObjectNames/Workarea/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,41 @@
WORKAREA
========

Sets another workarea.
Sets another work area.


Properties
==========

.. ### BEGIN~OF~TABLE ###
.. container:: table-row

Property
set
.. contents::
:local:

Data type
x,y,w,h + calc /:ref:`stdWrap <stdwrap>`
.. _gifbuilder-workarea-clear:

Description
Sets the dimensions of the workarea.
clear
-----

x,y is the offset.
.. t3-gifbuilder-workarea:: clear

w,h are the dimensions.
:Data type: string

For the usage of "calc" see the according note at the beginning of the
section "GIFBUILDER".
Sets the current work area to the default work area.

The value is checked for using :php:`isset()`: If :php:`isset()` returns
:php:`true`, the work area is cleared, otherwise it is not.

.. container:: table-row

Property
clear
.. _gifbuilder-workarea-set:

Data type
string
set
---

Description
Sets the current workarea to the default workarea.
.. t3-gifbuilder-workarea:: set

The value is checked for using isset(): If isset() returns TRUE, the
workarea is cleared, otherwise it is not.
:Data type: x,y,w,h :ref:`+calc <gifbuilder-calc>` / :ref:`stdWrap <stdwrap>`

Sets the dimensions of the work area.

.. ###### END~OF~TABLE ######
x,y is the offset.

[tsref:->GIFBUILDER.(GBObj).WORKAREA]
w,h are the dimensions.
1 change: 1 addition & 0 deletions Documentation/Settings.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ t3-gifbuilder-image = t3-gifbuilder-image // t3-gifbuilder-image // GIFBUILDER o
t3-gifbuilder-outline = t3-gifbuilder-outline // t3-gifbuilder-outline // GIFBUILDER object OUTLINE
t3-gifbuilder-scale = t3-gifbuilder-scale // t3-gifbuilder-scale // GIFBUILDER object SCALE
t3-gifbuilder-shadow = t3-gifbuilder-shadow // t3-gifbuilder-shadow // GIFBUILDER object SHADOW
t3-gifbuilder-workarea = t3-gifbuilder-workarea // t3-gifbuilder-workarea // GIFBUILDER object WORKAREA

t3-menu-tmenu = t3-menu-tmenu // t3-menu-tmenu // TMENU
t3-menu-tmenu-state = t3-menu-tmenu-state // t3-menu-tmenu-state // TMENU state
Expand Down

0 comments on commit 719fe0a

Please sign in to comment.