Nirbheek Chauhan
4346a33a63
meson: Require gi-docgen when gtk_doc is required
...
Fixes build with only `-Dgtk_doc=true` without
`-Dintrospection=enabled`:
Program gi-docgen found: NO
Configuring gdk4.toml using configuration
docs/reference/gdk/meson.build:13:2: ERROR: Tried to use not-found external program in "command"
`introspection` is `auto` by default.
The rest of the docs build is only contingent on
`if get_option('gtk_doc')` so we should use the same restriction here.
We check for `build_gir` below already, and the gi-docgen subproject
itself does not need gobject-introspection so it's fine to do it like
this.
2022-12-20 09:27:48 +05:30
Nirbheek Chauhan
cd77936265
meson: Fix find_program and subproject usage
...
Dummy dependencies are not required to execute a subproject
automatically for providing a program, nor do you need to explicitly
call subproject() to do that.
A `[provide]` section in the wrap file is enough.
2022-12-19 03:09:11 +05:30
andy5995
99d6eb9cb4
docs: Emphasize requirement to give filenames as arguments
...
(related to #5430 )
2022-12-12 23:40:07 -06:00
andy5995
9fd4b215ee
docs: Place example-{3,4} in numerical order
2022-12-10 17:39:09 -06:00
andy5995
6e7ecb02f1
docs: Update deprecated G_APPLICATION_FLAGS_NONE
2022-12-10 01:12:13 -06:00
Matthias Clasen
942f8d4b4b
Deprecate GtkInfoBar
...
This widget has a dialog-like API, which is something
we want to get rid of in GTK 5, and libadwaita has
a replacement with AdwBanner incoming.
2022-11-23 13:00:09 -05:00
Emmanuele Bassi
bd66198b88
docs: Add more links to the list widgets description
2022-11-11 11:30:41 +00:00
Emmanuele Bassi
5193846787
docs: Add links to the list widgets table
...
Make it easier for readers to go to the appropriate replacement for the
old GtkTreeView-and-friends API.
2022-11-11 11:21:17 +00:00
Arjan Molenaar
920f49e993
Fix typo in 4 to 5 migration page
2022-11-10 22:41:26 +01:00
Arjan Molenaar
29d7f93e38
Update Common Questions section on tree views
...
Point users to GtkListView instead of the
deprecated GtkTreeView.
2022-11-10 22:41:26 +01:00
Pedro Sader Azevedo
32e138689e
Link the file mentioned as a reference for key values
2022-11-06 01:54:38 +00:00
Matthias Clasen
9948053cd7
Deprecate GtkDialog
...
GtkDialog is too flexible in terms of UI (headerbars vs action bar,
etc), and has archaic APIs. It is time to retire it.
2022-10-29 15:27:53 -04:00
Matthias Clasen
8324a93c73
Update docs
...
Mention new deprecations in the future migration guide.
2022-10-29 14:14:59 -04:00
Emmanuele Bassi
21bc2c5078
docs: Remove mentions of Glade
...
Glade does not support GTK4, so we should not link to it when discussing
developing GTK4 applications.
2022-10-24 20:11:50 +01:00
Matthias Clasen
ac1ea6faca
docs: Remove mention of ~/.gtk-4.0
...
We are not looking there anymore, for a long time.
Fixes : #3266
2022-10-19 14:36:48 -04:00
Matthias Clasen
46c7c0c4e6
docs: Document new buildertool options
2022-10-19 13:36:14 -04:00
Matthias Clasen
cd031de680
docs: Update gtk4-builder-tool docs
...
Mention the new --deprecations option of the
validate command.
2022-10-19 08:50:34 -04:00
Matthias Clasen
9f8abc5d74
docs: Add a cross-reference
...
Note that GtkTreeView is deprecated and link to the
list view introduction from 'Tree and List Widget Overview'.
2022-10-12 22:26:40 -04:00
Matthias Clasen
0c94db7147
Start a migration guide for GTK 5
...
No need to panic, GTK 5 is still years away!
But it is good to write this material down while
it is fresh in mind.
2022-10-12 16:39:28 -04:00
Matthias Clasen
6c95547c3f
docs: Some updates
...
Make the section about environment variables match
current code.
Add a warning about env vars not being stable and
only for debugging.
2022-09-21 21:59:33 -04:00
Mitchell Hentges
fa554a8e85
Update GTK on Windows link: use gtk.org, not wiki
...
The old wiki page has a couple issues:
* It's out-of-date, not having any notes for GTK4 specifically,
and it doesn't link to `gvsbuild`, which (I believe) is
the current official (and best) way to build GTK with MSVC.
* It's "locked", so it's harder for contributors to update. This
is OK, except for one spicy detail:
* It's not clear how to contribute/report issues on the locked wiki
pages, so out-of-date information falls off the radar.
Regardless :) the gtk.org GTK for Windows docs are a much better
springboard, in my opinion.
2022-09-21 20:12:21 +02:00
Chun-wei Fan
f2b85fa1c7
running.md: Mention about issue with Nahimic on Windows
...
Let people know that they will need to use GTK with the Nahimic service
disabled or OpenGL disabled or put their GTK application into the Nahimic
backlist, or try to use GLES, since there is a known issue in the Windows
nVidia graphics drivers and Nahimic that causes GL operations to fail,
causing crashes in operations such as window resizes.
This will close issue #4113--sadly, there is nothing we can do within
GTK to fix the issue.
2022-08-02 13:50:49 +08:00
Manuel Zabelt
93636d4c5a
Update docs/reference/gdk/gdk4-x11.toml.in
2022-05-24 13:37:43 +00:00
Manuel Zabelt
88f761f2c8
GDK is LGPL-2.1-or-later not GPL-2.1-or-later, right?
2022-05-24 13:36:07 +00:00
Matthias Clasen
ad4536e825
Merge branch 'install-node-editor' into 'main'
...
Install gtk4-node-editor
See merge request GNOME/gtk!4701
2022-05-07 12:09:29 +00:00
Matthias Clasen
f9afee0667
Add a man page for gtk4-node-editor
2022-05-07 07:18:36 -04:00
Matthias Clasen
376d95a549
Updated screenshots
...
Produced by running the screenshot command over the
ui files in the same directory.
2022-05-06 23:05:15 -04:00
Matthias Clasen
a3ac414465
Generate screenshots on the fly
...
This commit adds a new meson option -Dupdate_screenshots=true.
When it is enabled, and -Dgtk_doc=true is also used, then the
build will generate images to include in the API docs from
ui files in docs/reference/gtk/images.
Note: we still keep a copy of the images in git, in order to
allow building without a display connection. To update the
images in git, the generated images need to be copied back
from the builddir to the srcdir.
2022-05-06 22:59:22 -04:00
Matthias Clasen
8ee6203e2c
Remove the old doc shooter infrastructure
...
This is no longer used.
2022-05-06 22:59:22 -04:00
Matthias Clasen
499687a11d
gtk-builder-tool: Add a screenshot command
...
This is an obvious variation of the preview
command. It can save a .ui file as either
.png or .node.
2022-04-17 12:57:46 -04:00
aneejit1
91511a80ac
Check for 'rst2man' misses installed 'rst2man.py' ( #4728 )
...
By default, 'docutils' installs 'rst2man' as 'rst2man.py'. Amend the
check for 'rst2man' to look for 'rst2man.py' as well if 'rst2man' is
not found.
2022-03-19 13:58:40 +00:00
Matthias Clasen
88fa226223
Fix a documentation typo
...
It is XDG_DATA_HOME.
Fixes : #4747
2022-03-04 22:18:06 -07:00
Emmanuele Bassi
7a608bda27
docs: Split dependencies from related libraries
...
We currently list everything as a dependencies, regardless of whether
it actually is; this is a source of confusion for users that read the
GTK documentation.
Gi-docgen has a new "related" key in the project configuration which
allows us to list libraries that are merely related to the namespace
we are documenting; the "dependencies" key is used to document the
actual namespace dependencies, now.
2022-02-12 17:28:00 +00:00
Sri Ramkrishna
6633f4e02f
Update docs/reference/gtk/migrating-3to4.md
2022-01-19 19:24:01 +00:00
Emmanuele Bassi
ca2aa52ba9
docs: Point to the correct development branch
...
The default development branch of GTK is now "main".
2022-01-13 14:39:39 +00:00
Emmanuele Bassi
96d28738c9
docs: Point source links to the correct branch
...
The default development branch for GTK is now "main".
2022-01-13 14:39:03 +00:00
Fabian Kirsch
4f36583898
corrected small typo input-handling.md
2022-01-12 09:02:01 +00:00
Matthias Clasen
fb5b2d3d8e
docs; Update supported backends
...
Some strings have changed here.
2022-01-06 14:56:16 -05:00
Jakub Kulík
484c0fdd15
docs: Mention GtkImage and GtkPicture changes
2021-12-17 00:32:08 +00:00
Matthias Clasen
5a42ccc575
docs: Clarify a sentence in the migration guide
...
Make it clear that we are giving examples of
no-longer existing APIs here.
Fixes : #4479
2021-11-30 19:51:22 -05:00
Mohammed Salman
4c8081bafc
Update section-text-widget.md
2021-11-17 22:48:14 +00:00
Emmanuele Bassi
39e4e48fdc
docs: Enable OpenSearch on our references
...
By adding the `docs_url` key in the project configuration file,
gi-docgen will generate an OpenSearch XML file, which allows to add
docs.gtk.org/<reference> as a "search engine" in web browsers.
2021-11-15 15:31:35 +00:00
Matthias Clasen
9f2dbf4fc5
Merge branch 'master' into 'master'
...
Fix typos
See merge request GNOME/gtk!4132
2021-11-09 11:28:35 +00:00
Emmanuele Bassi
0e27a49d1a
docs: Fix typo in link
2021-11-07 23:23:36 +00:00
Emmanuele Bassi
59f45aa30c
docs: Fix wrong fragments in type links
...
Due to a bug in gi-docgen we're not getting a warning if a fragment to a
type does not match the actual type, and we're generating a broken link.
See: https://gitlab.gnome.org/GNOME/gi-docgen/-/merge_requests/120
2021-11-07 18:40:24 +00:00
Hodong Kim
0632e94e68
Fix typos
2021-11-07 16:48:39 +09:00
Emmanuele Bassi
142571d0b8
build: Collect gi-docgen's common arguments
...
And only enable `--fatal-warnings` if `-Dwerror` has been set, just like
we do for the introspection data generation.
2021-11-01 13:00:51 +00:00
Link Dupont
9e0494cf4d
docs: match hello world code to description
...
Add the creation of a GtkBox to the hello-world sample code.
Fixes : #4358
2021-10-19 22:40:20 -04:00
Matthias Clasen
922e6add38
Merge branch 'docs-window-position' into 'master'
...
docs: Mention gtk_window_set_position() being gone
See merge request GNOME/gtk!4048
2021-10-11 06:36:23 +00:00
Emmanuele Bassi
c7bb4a9678
docs: Add GdkPixbuf to the URL map
...
Allow cross-linking to the GdkPixbuf reference.
2021-10-09 10:55:24 +01:00
Emmanuele Bassi
0054f8bd74
docs: Mention gtk_window_set_position() being gone
...
People search for it in the migration guide much more than other
GdkSurface and GtkWindow methods.
2021-10-08 12:27:24 +01:00
Emmanuele Bassi
a816f81ecd
docs: Fix links in the Getting Started page
...
We still have links to old gtk-doc references, as well as links to
developer.gnome.org locations that don't exist any more. On the other
hand, we are missing a bunch of links to existing types and symbols.
2021-10-01 01:44:01 +01:00
Matthias Clasen
83b434d6a5
docs: Mention popovers in the migration guide
...
Things have changed around popovers, we should mention
that.
2021-09-28 15:47:06 -04:00
Emmanuele Bassi
113d546486
docs: Remove the last remaining XML files
2021-09-24 18:01:00 +01:00
Emmanuele Bassi
2c810c747d
Switch man pages to reStructuredFormat
...
It's easier to write than DocBook, and rst2man is faster than xsltproc.
2021-09-24 18:01:00 +01:00
Benjamin Otte
36dd959bf9
build: Check that introspection is enabled for docs build
2021-08-29 04:29:53 +02:00
Matthias Clasen
2d84a1c63e
css: Implement text-transform
...
Implement the text-transform property from
https://www.w3.org/TR/css-text-3/#text-transform-property
using a new Pango attribute.
2021-08-22 15:57:50 -04:00
Matthias Clasen
bbd2b255a3
css: Document line-height as supported
2021-08-22 15:15:50 -04:00
Matthias Clasen
58e65ae7dd
windows: Update the docs for env vars
...
We've replaced some env vars with a new one.
Update the docs to match.
2021-08-19 15:57:44 +02:00
Matthias Clasen
f6659fea8d
imcontext: Improve docs
...
Add some more docs around GtkIMContext.
2021-08-17 22:33:26 -04:00
Emmanuele Bassi
769dc53c05
docs: Update the URLs of related projects for GTK
...
And install the gi-docgen project file as well.
2021-07-31 19:08:34 +01:00
Emmanuele Bassi
1a4554daf3
docs: Update the URLs of related projects for GSK
...
And install the gi-docgen project file.
2021-07-31 19:07:18 +01:00
Emmanuele Bassi
6c0633ef61
docs: Update the URL for related documentation
...
And install the gi-docgen project files for GDK.
2021-07-31 19:05:33 +01:00
Matthias Clasen
c609e2fef9
docs: Improve the gtk4-launch man page
...
Be more precise about where desktop files are found.
Fixes : #4081
2021-07-03 15:23:36 -04:00
Matthias Clasen
bda7557783
Update hello-world.c
...
Simplify the code a bit and make the window
match the existing screenshot.
2021-06-29 08:01:37 -04:00
Matthias Clasen
6a29b64850
Merge branch 'dnd-fixes' into 'master'
...
dnd: Add another assertion
See merge request GNOME/gtk!3689
2021-06-24 15:01:29 +00:00
Emmanuele Bassi
0e29f52841
Merge branch 'migration_patch' into 'master'
...
Add section about `gtk_widget_set_app_paintable`
Closes #4007
See merge request GNOME/gtk!3641
2021-06-23 13:08:07 +00:00
Jaap aarts
02893e37d3
Add section about gtk_widget_set_app_paintable
2021-06-23 13:08:06 +00:00
Matthias Clasen
d7915fbca8
docs: Add a section about Drag-and-Drop
2021-06-19 14:14:57 -07:00
Matthias Clasen
ee34e1acc5
docs: Mention the GtkWidget.destroy vfunc
...
Mention GtkWidget.destroy in the migration guide.
2021-06-11 10:11:53 -04:00
Matthias Clasen
a08fbfa586
docs: Fix a typo in the migration guide
2021-06-11 07:52:30 -04:00
Emmanuele Bassi
71be3a8de1
docs: Mention the ::damage-event signal in the migration guide
...
There is no replacement for damage event tracking.
2021-06-09 18:11:10 +01:00
Emmanuele Bassi
17373c3e77
docs: Mention GdkSurface:mapped
...
It replaces the ::map-event and ::unmap-event signals on GtkWidget.
2021-06-09 18:08:31 +01:00
Emmanuele Bassi
078ada75d4
docs: Mention Window::close-request in the migration guide
...
The Widget::delete-event signal was moved to Window::close-request.
2021-06-09 18:03:12 +01:00
Matthias Clasen
98d2320c93
gtk-builder-tool: Replace can-focus with focusable
...
The focusable property has the meaning that can-focus had
in GTK 3.
Update tests, and mention this in the migration guide.
Fixes : #3638
2021-06-05 17:56:35 -04:00
Matthias Clasen
b6cd97be1e
docs: Escape some xml tags
...
When mentioning xml tags in markdown, we must write
them as `<foo>`, or they will come out mangled.
2021-06-04 08:06:18 -04:00
Matthias Clasen
c4cbd6ec1b
docs: Mention <packing> in migration guide
...
Add another hint for what to do with child properties.
Fixes : #3950
2021-06-04 07:59:07 -04:00
Emmanuele Bassi
f9f9fa6dc6
docs: Fix the license field
...
It's LGPL-2.1-or-later, not GPL.
2021-06-03 09:11:09 +01:00
Emmanuele Bassi
6d06b0f076
Enable fatal warnings when build the docs
...
We want to fail the CI pipeline when the documentation generator emits a
warning.
2021-05-25 13:32:32 +01:00
Matthias Clasen
4c2761302a
doc: Syntax fixes
...
No, we can't have links that say [constructor@...] or
[mehtod@...] or [methoc@...] or [methos@...] or [metohd@...].
And no, not [signals@...] either.
2021-05-25 07:33:55 -04:00
Matthias Clasen
808e5421a9
docs: Convince the widget gallery to reflow
2021-05-24 10:51:02 -04:00
Matthias Clasen
71aac48042
docs: More syntax fixes
...
[`func@Foo`] is not the right link syntax either.
2021-05-22 21:20:10 -04:00
Matthias Clasen
8bcc6b1d96
docs: Fix up syntax
...
There's no [type_func@...[ syntax, it is all [func@...].
2021-05-22 20:56:14 -04:00
Matthias Clasen
40f292cb13
docs: Sync up debug flag information
2021-05-22 20:46:59 -04:00
Matthias Clasen
b617ba1c82
docs: Refer to backend APIs
...
Add links to the backend api docs.
2021-05-22 17:25:26 -04:00
Matthias Clasen
252edbdbc6
docs: Fix a typo
2021-05-22 17:25:26 -04:00
Matthias Clasen
0bba3610c5
docs: Avoid stairstepping
...
If you don't put empty lines between the items in a
definition list, markdown helpfully stairsteps them.
We don't want that!
2021-05-22 17:25:26 -04:00
Matthias Clasen
fc9f580fd3
docs: Update GSK_RENDERER docs
...
This did not mention the opengl and ngl values yet.
2021-05-22 17:25:26 -04:00
Matthias Clasen
2d0957b732
docs: Clean up docs syntax
...
Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-21 15:34:47 -04:00
Matthias Clasen
642f32e14d
Merge branch 'ebassi/for-master' into 'master'
...
Install documentation in the appropriate place
See merge request GNOME/gtk!3408
2021-05-03 19:21:18 +00:00
Emmanuele Bassi
29382360ed
docs: Add missing extra files for gdk4 sub-references
...
The Wayland and X11 references need the gtk-logo.svg and the urlmap.js
extra files.
Fixes : #3905
2021-04-28 01:44:47 +01:00
Eli Schwartz
e5b0d225de
meson: only build demo manpages when demos are enabled
...
Installing them even when manpages are enabled, but the demos are
disabled, produces manpages for unavailable programs...
2021-04-13 22:55:03 -04:00
Emmanuele Bassi
99c7ba7840
Install documentation in the appropriate place
...
We're already installing each reference into its own namespaced
directory, so we don't need to add further path elements.
Additionally, with the changes in:
https://gitlab.gnome.org/GNOME/devhelp/-/merge_requests/20
https://gitlab.gnome.org/GNOME/gi-docgen/-/merge_requests/54
we can browse the GTK API references in DevHelp.
2021-04-07 14:57:31 +01:00
Matthias Clasen
65a061f3c2
Merge branch 'ebassi/broadway-docs' into 'master'
...
docs: Update the Broadway instructions
See merge request GNOME/gtk!3380
2021-03-31 21:42:59 +00:00
Emmanuele Bassi
7bfff6c51e
docs: Update the links to the docs of GTK dependencies
...
Use docs.gtk.org where appropriate.
Fixes : #3817
2021-03-31 20:51:27 +01:00
Emmanuele Bassi
3fdedce8f6
docs: Update the Broadway instructions
...
The Broadway server binary is now versioned, and it's not compatible
with the GTK3 server.
2021-03-31 20:06:54 +01:00
Emmanuele Bassi
7c29847fbf
build: Install the API references
...
We are building them, but not installing them.
2021-03-12 11:32:09 +00:00
Emmanuele Bassi
66f0547ebf
docs: Fix the dependencies links
...
Use the GitLab pages location until we can link to a proper space on
developer.gnome.org.
2021-03-12 11:18:37 +00:00
Emmanuele Bassi
c5ddf5b381
docs: Add URL maps for cross links
2021-03-11 16:46:02 +00:00
Emmanuele Bassi
61712bfb3b
docs: Enable search
2021-03-11 16:37:38 +00:00
Emmanuele Bassi
c3eb3f2943
docs: Update the "running GTK apps" section
...
Style the content a bit better, and use the appropriate links.
2021-03-11 16:37:38 +00:00
Matthias Clasen
d13e592dbf
Small updates to the coding and documentation style
...
Mention summary sentences, and a few other things.
2021-03-11 16:37:38 +00:00
Emmanuele Bassi
90cf6bb686
docs: Show class hierarchy in the API references
2021-03-11 16:37:38 +00:00
Matthias Clasen
102884faf1
docs: Remove anchors from list overview
...
Our markdown doesn't support this.
2021-03-11 16:37:35 +00:00
Matthias Clasen
465aca029e
Add some more widgets to the gallery
...
We already have images for menus, menubars and emoji chooser.
Use them.
2021-03-11 16:37:33 +00:00
Matthias Clasen
b39160243f
aboutdialog: Improve example image
...
Use our logo, and update the copyright years.
2021-03-11 16:37:33 +00:00
Matthias Clasen
a61c677a0d
docs: Add dialogs to the gallery
2021-03-11 16:37:33 +00:00
Matthias Clasen
34443546a8
visual index: Reorder some widgets
...
This improves the alignment a bit.
2021-03-11 16:37:32 +00:00
Emmanuele Bassi
6bc69a12cc
docs: Update the documentation style guide
2021-03-11 16:37:32 +00:00
Matthias Clasen
dfb68fb13d
docs: Split images for check and radio buttons
...
Its the same widget, but two images fit better in the gallery,
and will be easier to use as example images in the docs.
2021-03-11 16:37:31 +00:00
Matthias Clasen
18f525f7b4
docs: Improve the togglebutton image
...
Make it actually show toggles.
2021-03-11 16:37:31 +00:00
Emmanuele Bassi
952fc31dbc
docs: Fix up the 3-to-4 migration guide
2021-03-11 16:37:31 +00:00
Matthias Clasen
93326164e2
docs: Add backend links to the gdk docs
...
These are placeholders for when we know how to
link across namespaces.
2021-03-11 16:37:31 +00:00
Matthias Clasen
b78895e449
docs: Add separate toml files for gdk backends
...
Reusing the same one duplicates the standalone
docs, which doesn't quite seem right.
2021-03-11 16:37:31 +00:00
Matthias Clasen
e82d090bf5
docs: Add some links to the pango chapter
2021-03-11 16:37:31 +00:00
Matthias Clasen
3d04c0f4be
docs: Move GdkEvent docs inline
...
This is not really worth a chapter of its own.
2021-03-11 16:37:31 +00:00
Matthias Clasen
e5bed812f5
docs: Tweak X11 section
...
Remove unsupported heading anchors.
2021-03-11 16:37:31 +00:00
Matthias Clasen
d88a4629f9
docs: Tweaks Windows section
...
Remove unsupported heading anchors.
2021-03-11 16:37:31 +00:00
Matthias Clasen
24c04b5bb9
docs: Tweak Wayland section
...
Remove unsupported heading anchors.
2021-03-11 16:37:31 +00:00
Matthias Clasen
4c3ea25745
docs: Tweak a11y section
...
Convert link syntax.
2021-03-11 16:37:31 +00:00
Matthias Clasen
231814a595
docs: Tweak running chapter
...
Remove unsupported heading anchors, fix definition
list use.
2021-03-11 16:37:31 +00:00
Matthias Clasen
820f37be0b
docs: Tweak input overview
...
Remove unsupported heading anchors.
2021-03-11 16:37:31 +00:00
Matthias Clasen
02ec00dc5a
docs: Tweak drawing model overview
...
Fix link syntax, remove gtk-doc markup.
2021-03-11 16:37:30 +00:00
Matthias Clasen
4d2e4309f0
docs: Tweak css properties section
...
Fix the use of definition lists.
2021-03-11 16:37:30 +00:00
Matthias Clasen
d2ba09ec98
docs: Tweak the actions overview
...
Fix use of definition lists, and remove some gtk-doc
markup.
2021-03-11 16:37:30 +00:00
Matthias Clasen
41ddce152a
building: Minor tweaks
...
Remove unsupported anchors from headings.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
6d489a9e81
docs: Generate the DevHelp file for our namespaces
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
85774d2bcd
docs: Update the "Getting Started" page
...
Drop the Pandoc stuff, add the gi-docgen links, and remove a stray
docbook element.
2021-03-11 16:37:30 +00:00
Matthias Clasen
b9a02b0c24
docs: Bring the widget gallery back
...
We have all the images, lets put them to use.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
701f1b837b
docs: Show summary in the namespace index
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
3ef95b4065
build: Quiet down gi-docgen
...
We are only interested in the warnings and errors.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
d621a37a60
docs: Fix up the style of the X11 content file
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
6f93e63d21
docs: Move detached sections into their own content file
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
b9f0cf1c8b
docs: Move gdkcairo section to an external file
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
abb33bd65f
docs: Move the gtkmain section to its own document
...
The introspection data does not handle unattached sections like gtk-doc
does, so we need to move what was gtkmain into its own Markdown
document.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
f85b847410
docs: Add metadata preamble to GTK's content files
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
a6ee0dd8aa
docs: Drop gtk-doc files
...
We don't use gtk-doc to generate our API reference, so we don't need its
files lying around any more.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
0ba2a3a191
Generate GTK API reference(s) with gi-docgen
...
Stop using gtk-doc, and switch to gi-docgen.
The gi-docgen tool generates API references through the introspection
data, which has various benefits:
- it does not parse C code
- it does not generate and run C code to introspect types at build time
- it does not present a different API from the one we're exporting
Additionally, gi-docgen:
- does not generate DocBook XML in order to generate HTML
- does not go through xsltproc
- parses proper Markdown
Which makes it markedly faster than gtk-doc has ever been.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
676ea489cc
docs: Remove invalid macros
2021-03-07 18:34:53 +00:00
Matthias Clasen
4b9aeaf9e3
imcontext: Add [gs]et_surrounding_with_selection
...
The Wayland text protocol expects to get both ends
of the selection with its surrounding call, so make
that available via GtkIMContext. We add this as new
api and vfuncs, and fall back, so that existing
implementations keep working.
2021-03-04 15:18:30 -05:00
Matthias Clasen
b0a82b1dfe
Merge branch 'popup-shadow-width' into 'master'
...
Support shadows on popovers
See merge request GNOME/gtk!3089
2021-02-14 17:22:50 +00:00
António Fernandes
a810f600bf
docs: Mark heading in migration guide
...
This heading was missing from the index because it was not marked as one
2021-02-14 15:20:54 +00:00
Matthias Clasen
ea19f7c360
popuplayout: Add shadow width
...
Add shadow width to the GdkPopupLayout struct. This
information is needed by the compositor to make correct
positioning decisions about popups.
2021-02-13 21:01:46 -05:00
Matthias Clasen
ea7185bdb1
cssfiltervalue: Implement drop-shadows
...
We have all the pieces, so this is surprisingly easy.
2021-02-06 16:16:43 -05:00
Matthias Clasen
0a0a059397
docs: Mention css drop-shadow filter
...
We don't support this filter, currently.
2021-02-03 22:10:13 -05:00
Matthias Clasen
edeaf9c040
imcontext: Drop GTK_MAX_COMPOSE_LEN
...
Drop GTK_MAX_COMPOSE_LEN from docs. It is no longer
used by GTK at all. We leave the define in place
for now, to avoid breaking 3rd party code that might
use it.
2021-02-01 12:31:23 -05:00
Matthias Clasen
3c66c27caa
docs: Add gtk_widget_grab_default to migration guide
...
Point out the replacement for this api.
2021-01-27 13:50:05 -05:00
Matthias Clasen
5ee7606779
css: Support colors in cross fades
...
The CSS Image Spec (Level 4) allows colors in
cross-fade expressions to specify solid-color images.
Support this.
2021-01-26 21:14:09 -05:00
Matthias Clasen
51122dd287
docs: Cosmetics
...
Tweak the css docs slightly.
2021-01-26 20:33:16 -05:00
Matthias Clasen
40eae298d5
docs: Update border-size docs
...
GtkCenterLayout respected border-size as well.
2021-01-26 10:40:22 -05:00
Matthias Clasen
65a4118d50
css: Support overline
...
We can support text-decoration-line: overline,
since pango supports it now.
2021-01-26 00:04:04 -05:00
Matthias Clasen
344f9fcf05
css: Implement transform-origin
...
Implement most of transform-origin. We only
handle the xy components currently, which lets
us reuse the position value implementation that
is used for background-position.
2021-01-24 22:49:08 -05:00
Matthias Clasen
4c971cd4da
docs: Fix reference for css transform
...
Refer to the canonical location for the css
transform spec.
2021-01-24 22:48:00 -05:00
Matthias Clasen
3a18a6dddf
docs: Update getting started section
...
We were still talking about draw signals here,
which don't exist anymore.
Fixes : #3601
2021-01-20 08:01:54 -05:00
Matthias Clasen
880468f5a3
docs: Fix a heading gotcha
...
One of the many migration guide sections was too
prominent.
2021-01-14 08:13:34 -05:00
Matthias Clasen
6ddbb2a402
doc: Clarify some migration hints
...
Don't mention GdkSurface::layout as replacement for
GtkWindow::configure-event. Instead, explain how to
save window state.
2021-01-14 07:52:36 -05:00
Matthias Clasen
f03acaf7ab
Merge branch 'mcatanzaro/unparent' into 'master'
...
Remove incorrect unparenting guidance from migration guide
See merge request GNOME/gtk!3050
2021-01-07 18:35:37 +00:00
Matthias Clasen
4e7ce9edcf
Merge branch 'mcatanzaro/gtkbuilder-docs' into 'master'
...
Improve GtkBuilder documentation
See merge request GNOME/gtk!3055
2021-01-07 18:00:19 +00:00
Michael Catanzaro
59692599ea
Remove incorrect unparenting guidance from migration guide
...
This rule is almost always wrong, and we're having some trouble agreeing
on replacement text. Let's remove the whole paragraph for now, to avoid
confusion.
2021-01-07 11:39:53 -06:00
Michael Catanzaro
c736deb83b
Add section on GtkBuilder API changes to GTK 4 migration guide
...
Thanks to Benjamin for helping with the language.
2021-01-07 11:34:42 -06:00
Michael Catanzaro
137f32f9ef
Expand event controller API changes section of GTK 4 porting guide
...
There is more to say about changes to GtkEventController.
2021-01-07 10:53:09 -06:00
Emmanuele Bassi
e4d0114e0d
docs: Add migration section for GtkClipboard
...
A simple copy/paste text example, plus directing people towards the
appropriate GType to replace the old convenience API.
2021-01-05 16:51:14 +00:00
Emmanuele Bassi
1995b7f34b
docs: Preformat some symbols
2021-01-05 16:19:21 +00:00
Matthias Clasen
9595d440cf
docs: Flesh out Popup layout docs
...
We have nice illustrations for this, lets use them.
2021-01-05 08:37:23 -05:00
Matthias Clasen
cf623ce774
Merge branch 'window-geometry-info' into 'master'
...
gtk/window: remove GtkWindowGeometryInfo from public header file
See merge request GNOME/gtk!3028
2021-01-04 13:55:08 +00:00
Matthias Clasen
f2e5775380
Merge branch 'matthiasc/for-master' into 'master'
...
Matthiasc/for master
Closes #3506 and #3530
See merge request GNOME/gtk!3024
2021-01-01 22:48:11 +00:00
Matthias Clasen
572649740e
docs: Flesh out the gtk4-builder-tool man page
...
Add some details about the --3to4 conversion, and
set expectations.
2021-01-01 10:14:01 -05:00
David Lechner
4fb70c5e4d
gtk/window: remove GtkWindowGeometryInfo from public header file
...
GtkWindowGeometryInfo is only used by static methods in gtkwindow.c
so it doesn't need to be in the public header file.
2020-12-30 01:32:27 -06:00
Matthias Clasen
878b34fae3
gtk4-encode-symbolic: Add debug output
...
Add a --debug option that makes this tool produce
some debug output that can be helpful in tracking
down why symbolic svgs are broken.
2020-12-29 21:30:52 -05:00
Matthias Clasen
7e579bb59a
Merge branch 'wip/otte/for-master' into 'master'
...
Wip/otte/for master
See merge request GNOME/gtk!2997
2020-12-24 07:13:22 +00:00
Benjamin Otte
f85d939e5e
docs: Put render nodes in their own sections
2020-12-24 06:38:45 +01:00
Emmanuele Bassi
6c31ed53f4
docs: Fix typo and whitespace
2020-12-21 17:03:42 +00:00
wisp3rwind
9521f609d8
docs: backtick fixes
...
- in the gettext() examples, at least the _() triggers italics
- add missing closing backtick
2020-12-18 16:31:41 +01:00
Matthias Clasen
d33062795c
Merge branch 'ebassi/docs-for-master' into 'master'
...
Ebassi/docs for master
See merge request GNOME/gtk!2971
2020-12-17 23:59:41 +00:00
Matthias Clasen
3f56e8191f
Merge branch 'shortcuts' into 'master'
...
docs: Add separation between kinds of shortcuts in Keyboard input
See merge request GNOME/gtk!2964
2020-12-17 19:43:38 +00:00
Chris Mayo
bf4c3dc2c5
docs: Fix list of kinds of shortcuts in Keyboard input
...
Formatting in HTML was mangled.
2020-12-17 19:18:10 +00:00
Emmanuele Bassi
a5365ec8cb
docs: Add missing GTK types
...
If we don't specify the get_type() function, gtk-doc will not collect
properties and signals, and will use a different URL for the page.
2020-12-17 18:30:19 +00:00
Sebastian Keller
02f0681344
settings: Change gtk-cursor-aspect-ratio from float to double
...
Float properties can not be read from keyfiles. This was causing changes
to this property in settings.ini to be ignored. Fix this by changing it
to a double.
Technically this change could be considered an API break, but there are
no users of this property as float yet and it is early enough to expect
there to never be any.
Also document this change in the 3 to 4 migration guide since in gtk 3
this setting will be kept a float.
Fixes https://gitlab.gnome.org/GNOME/gtk/-/issues/3441
2020-12-16 22:35:36 +01:00
Emmanuele Bassi
9fa4c2f5b8
docs: Ignore gtkspinbuttonprivate.h
2020-12-16 16:29:01 +00:00
Emmanuele Bassi
73dda96711
docs: Add missing stanzas for gtk_test_accessible API
2020-12-16 16:29:01 +00:00
Emmanuele Bassi
d711acc954
docs: Ignore gtksorterprivate.h
2020-12-16 16:29:01 +00:00
Emmanuele Bassi
f24429e84a
docs: Remove private symbols
2020-12-16 16:29:00 +00:00
Emmanuele Bassi
fc4402b456
docs: Ignore gtkpasswordentryprivate.h
2020-12-16 16:29:00 +00:00
Emmanuele Bassi
344eb21bee
docs: Complete symbol coverage for GSK
...
100% symbol docs coverage.
241 symbols documented.
0 symbols incomplete.
0 not documented.
2020-12-16 16:29:00 +00:00
Emmanuele Bassi
4fb55b3270
docs: Complete symbol coverage for GDK
...
100% symbol docs coverage.
833 symbols documented.
0 symbols incomplete.
0 not documented.
What's left are just type system macros and windowing system opaque
structures.
2020-12-16 16:28:58 +00:00
Emmanuele Bassi
5d2278a5ca
docs: Add public symbols to the GTK reference
2020-12-15 16:21:20 +00:00
Emmanuele Bassi
ea5e186bb8
Hide GtkTextAttributes functions
...
The type is private, so making functions operating on it public is
pointless.
2020-12-15 16:20:21 +00:00
Emmanuele Bassi
3132b10bc0
docs: Add more private headers
2020-12-15 15:55:06 +00:00
Emmanuele Bassi
91bba794a6
docs: Add missing symbols to the GTK reference
2020-12-15 14:30:32 +00:00
Emmanuele Bassi
a6bd0c7eed
Remove stray mentions of GdkConfigureEvent
...
The event was removed, but some traces of it linger.
2020-12-15 13:58:52 +00:00
Emmanuele Bassi
ff351721b2
docs: Add missing symbols to the GDK reference
2020-12-15 13:47:40 +00:00
Emmanuele Bassi
f546e03d31
docs: Add missing symbols to the GSK reference
2020-12-15 13:35:19 +00:00
Emmanuele Bassi
bdbea0d037
docs: Add more ignored header for GSK
2020-12-15 13:31:02 +00:00
Emmanuele Bassi
99e0929d6c
build: Use a consistent style for Meson files
2020-12-15 12:46:59 +00:00
Emmanuele Bassi
08d52bee14
docs: Add note for the removal of GtkFileChooserButton
...
Point developers in the direction of GtkButton and GtkFileChooserNative.
2020-12-14 16:55:15 +00:00
Emmanuele Bassi
3c9a13e6cf
Update CODEOWNERS
...
Add me as the reference for the accessibility bits of the code base.
2020-12-11 23:42:25 +00:00
Emmanuele Bassi
b8a651df47
Share the popcount() fallback for MSVC
...
We use __builtin_popcount() in a couple of places, so it makes sense to
have it in one header.
2020-12-09 16:06:52 +00:00
Matthias Clasen
1f141c1953
Merge branch 'wip/surface-state-rework' into 'master'
...
Rework surface state and geometry computation
See merge request GNOME/gtk!2885
2020-12-08 15:38:36 +00:00
Matthias Clasen
3b69facf0b
Mention window sizes in the migration guide
2020-12-07 20:37:30 +01:00
Matthias Clasen
a6bc4c95b1
docs: Add gtk_window_is_fullscreen
2020-12-07 20:37:30 +01:00