Skip to content

Update widget.rst - #5131

Open
JorjMcKie wants to merge 1 commit into
mainfrom
more-doc-updates
Open

JorjMcKie wants to merge 1 commit into
mainfrom
more-doc-updates

Conversation

@JorjMcKie

Copy link
Copy Markdown
Collaborator

No description provided.

Comment thread docs/widget.rst
* combo box (`PDF_WIDGET_TYPE_COMBOBOX`)
* list box (`PDF_WIDGET_TYPE_LISTBOX`)
* radio button (`PDF_WIDGET_TYPE_RADIOBUTTON`): PyMuPDF now supports the creation and update of Radio Button Groups (RBGs). Adding a new radio button widget with the same (full) name as an existing one anywhere in the PDF will automatically create or extend an RBG.
* radio button (`PDF_WIDGET_TYPE_RADIOBUTTON`): PyMuPDF now supports the creation and update of Radio Button Groups (RBGs). Adding a new radio button widget with the same (full) name as an existing one anywhere in the PDF will automatically create or extend an RBG. There currently still exist some limitations [#f3]_.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are currently some limitations?

"There currently still exist some" sounds overly complicated!

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't uploaded all novelties regarding form fields. Once I have (in a next PR), most of the limitations will be gone.
So I guess we must decide whether telling the final truth or a the current one.

Comment thread docs/widget.rst

.. [#f2] Among other purposes, ``Parent`` objects are also used to facilitate multiple occurrences of a field (on the same or on different pages). The ``Kids`` array in this ``Parent`` object contains the cross references of all widgets that are "copies" of the same field. Whenever the field value of any "kid" widget is changed, all the other kids are immediately updated too. This is a very efficient way to handle multiple copies of the same field, e.g. for filling out forms. This simultaneous update only happens for :attr:`Widget.field value`. The new parameter ``sync_flags`` extends this to :attr:`Widget.field_flags`. This cannot be automated in the same way as for the field value to allow for more flexibility.

.. [#f3] Radio Button Groups (RBGs) come in (at least) three technical variants. Please note that the actual PDF Form Field is the RBG - not the individual widgets. Each RB widget represents one of the possible "values" of the Form Field parent. Widgets in general do not need to exist all on the same page.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to exist -> to be

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants