FeRD (Frank Dana)
9b1026886b
docs/input-handling: Don't leave reader hanging
...
Strangely, the document's last sentence ended with a colon,
giving the impression there's missing text that should follow.
There is not.
Even more strange, it's _always_ ended with a colon,
ever since the file was converted from XML
(in commit 10cd539104
).
BUT, the XML file it was converted _from_ ended that same sentence
with a period! I have no idea where the colon came from.
2023-05-14 05:29:18 -04:00
Matthias Clasen
f99fbab24f
docs: Mention the current build options
...
Some of these got renamed recently.
2023-05-13 21:56:29 -04:00
Matthias Clasen
9bd9847b3f
switch: Expand the docs
...
Add more text and explanation around active vs state,
since people seem easily confused by it.
2023-05-01 15:15:53 -04:00
Matthias Clasen
b310ab7304
Merge branch 'matthiasc/for-main' into 'main'
...
docs: Migration guide updates
See merge request GNOME/gtk!5899
2023-04-30 22:39:57 +00:00
Matthias Clasen
cdbd931dba
docs: Migration guide updates
...
Mention various widget size apis going away.
2023-04-30 18:21:46 -04:00
Daniel Boles
060992aeba
migrating-3to4: Fix unescaped ptr * used as italic
2023-04-30 16:55:31 +01:00
Matthias Clasen
30b12ff890
docs: Mention baselines
...
Add a paragraph about baselines to the coordinates overview.
2023-04-29 13:48:03 -04:00
Daniel Boles
7bea2685e1
migrating-3to4: Don't mention removed Box method &
...
donʼt mention its renamed successor either, as that has its own section
later. We could have another sentence paragraph like ‘In the case of
GtkBox, the pack methods have been renamed to X and lost the trailing
arguments Y’, but that wonʼt help people prepare still on GTK3, which is
the point in the affected section… so just remove the misleading relic.
2023-04-28 21:14:37 +01:00
Daniel Boles
abd4a57031
3to4: Fix we said we replace doubles with doubles,
...
when what we are replacing are ints!
2023-04-26 21:30:10 +01:00
Matthias Clasen
e84ebfbf29
docs: Document new environment variables
...
Add GSK_MAX_TEXTURE_SIZE and GDK_DEBUG=gl-fractional
to the docs.
2023-04-02 13:52:56 -04:00
Matthias Clasen
ce86ec5599
CODING-STYLE: Updates
...
We switched to using #pragma once in headers,
document that.
2023-03-31 20:17:12 -04:00
Matthias Clasen
a9e37c6f2c
Incorporate review feedback
2023-03-25 16:22:45 -04:00
Matthias Clasen
3d35b848d1
docs: Use our own box model illustration
...
This one has a dark mode too.
2023-03-25 16:16:34 -04:00
Matthias Clasen
de3b37d80c
Tweak
2023-03-25 15:29:55 -04:00
Matthias Clasen
1e5dd5db71
Tweak
2023-03-25 15:27:23 -04:00
Matthias Clasen
7bd0fbb47e
More review feedback
2023-03-25 15:26:33 -04:00
Matthias Clasen
2e26932925
docs: Apply review feedback
...
Clarify some points in the coordinate overview.
2023-03-25 15:05:28 -04:00
Matthias Clasen
0b3c979719
Docs: Cosmetics
...
Align section heading better. Now they all follow
the "Using GTK..." pattern.
2023-03-25 12:17:20 -04:00
Matthias Clasen
63ed2a13bf
docs: Add a section about coordinate systems
2023-03-25 12:10:58 -04:00
Matthias Clasen
f0a2d77e0f
docs: Improve markup for keys
...
Consistently use <kbd>x</kbd> to render keys in the docs
and use + for key combinations.
2023-03-24 10:30:07 -04:00
Matthias Clasen
ce983c9495
docs: Some updates
...
Fix some links ot point to docs.gtk.org.
2023-03-24 08:56:06 -04:00
Matthias Clasen
9a7bf66ed4
docs: Tweaks
...
Tweak the wording in the list widget overview to
fix some typos and make things read more smoothly.
2023-03-18 10:25:58 -04:00
Matthias Clasen
31ec095ec7
docs: Update broadway docs
...
Using Broadway without broadwayd hasn't worked since 2013...
Fixes : #5662
2023-03-17 09:00:10 -04:00
Matthias Clasen
cc7d996a5c
Merge branch 'add_visited_state' into 'main'
...
a11y: Add GTK_ACCESSIBLE_STATE_VISITED
See merge request GNOME/gtk!5616
2023-03-15 01:24:18 +00:00
Matthias Clasen
83d14bfa98
CODING-STYLE: Drop mention of g_slice
2023-03-14 14:56:42 -04:00
Lukáš Tyrychtr
9517d3d135
a11y: Add GTK_ACCESSIBLE_STATE_VISITED
...
This state is used for visited link-like widgets.
It has no ARIA equivalent, e. g. can not be set programmatically, but it
exists in the browser environment as well.
2023-03-08 09:24:08 +01:00
Emmanuele Bassi
cd10e5dd1a
Verbiage Change
2023-02-27 16:32:35 +00:00
Bobby Neal
f11d647aa4
Update docs/reference/gtk/getting_started.md
2023-02-26 17:04:17 +00:00
Matthias Clasen
a9f03be588
builder-tool: Try harder to find template parents
...
This will make it work (in some cases) to add extra
libraries via LD_PRELOAD.
Based on work by Julian Sparber,
https://gitlab.gnome.org/GNOME/gtk/-/merge_requests/5084
Fixes : #5232
2023-02-19 18:17:34 -05:00
Matthias Clasen
cd0fe13dae
faq: Add a question about parallel UIs
2023-02-13 08:54:36 -05:00
Matthias Clasen
3dcea74e85
faq: Don't number questions
...
The numbering makes it unnecessarily hard to add
and remove questions, and does not really seem
necessary. Just use bullets.
2023-02-13 08:52:04 -05:00
Matthias Clasen
537c2f6c7a
faq: Some updates
...
Miscellaneous tweaks and changes, after reading
the whole thing.
2023-02-13 08:52:03 -05:00
Matthias Clasen
dfb019509d
docs: Document new build options
2023-02-12 20:36:13 -05:00
Matthias Clasen
157ef1d395
Deprecate GtkVolumeButton
...
Too specialized.
2023-02-12 09:48:49 -05:00
Matthias Clasen
1ff8dad8ec
Deprecate GtkLockButton
...
This is a very specialized widget, and should really just
live with the applications where it is used.
2023-02-02 08:39:25 +01:00
Matthias Clasen
d8cb11ec4a
Deprecate GtkStatusbar
...
The design patterns using statusbar are no longer popular,
and it is pretty easy to make a statusbar yourself with boxes
and labels, if you need one. The only thing special about
GtkStatusbar was its window resize handle, but that has
been gone for a long time.
2023-02-02 08:39:24 +01:00
Matthias Clasen
bf4b40f17e
docs: Update deprecations for gtk_show_uri
...
We have a better replacement now.
2023-01-14 17:39:28 -05:00
Corey Berla
e418656a04
docs: Fix dependency names
...
When gi-docgen added the "related" key, it also began checking
that the dependencies were actually dependencies otherwise they aren't
listed as dependencies. The capitalization needs to match the
namespace.
2023-01-13 14:24:33 -08:00
Matthias Clasen
815b54f3df
Update the build documentation
2023-01-13 07:15:15 -05:00
Matthias Clasen
66c947b86b
Merge branch 'swap-3-4' into 'main'
...
docs: Place example-{3,4} in numerical order
See merge request GNOME/gtk!5319
2023-01-06 18:06:55 +00:00
Matthias Clasen
47b5d0d546
Merge branch 'no-more-installed-tests' into 'main'
...
build: Drop the install-tests option
See merge request GNOME/gtk!5352
2022-12-20 05:33:56 +00:00
Matthias Clasen
3121f88265
build: Drop the install-tests option
...
We no longer use installed tests in CI,
so lets reap the benefit and simplify
our build setup for tests.
2022-12-19 23:12:47 -05:00
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