AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-28 06:21:14 +00:00
Code Issues Projects Releases Wiki Activity
76,276 Commits 1,241 Branches 809 Tags 591 MiB
f99fbab24f
Commit Graph

5734 Commits

Author SHA1 Message Date
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