Commit Graph
4596 Commits
Author SHA1 Message Date
Vadim Zeitlin 14c2b46bb0 Minor corrections to standard IDs documentation
Remove misleading Doxygen comments copied from the comments in C++
header which didn't make sense here.

Improve the documentation of menu ID ranges.

(cherry picked from commit 5a95c14a39)
2026-02-04 23:03:30 +01:00
Vadim Zeitlin 81ebf59adb Document wxGetStockHelpString() function
It was added back in 345319d60c (fixes to menu stock items support
(patch 1547639), 2006-09-05) and even if it's not particularly useful,
it still should be documented, so add documentation for it.

See #8090.

(cherry picked from commit e80d78c2c9)
2026-02-04 23:03:23 +01:00
Vadim Zeitlin 01752e95a4 Improve documentation of null wxDialog parent
Mention wxDIALOG_NO_PARENT in the documentation of the parent parameter
as people who don't know about this style are not going to see this
style documentation either.

See #23560.

(cherry picked from commit 8245e1073a)
2026-01-25 01:45:04 +01:00
Vadim Zeitlin c2f6005452 Regenerate interface docs for wxSTC after gen_iface.py fix
This fixes member groups comments.
2026-01-24 20:05:35 +01:00
Vadim Zeitlin bba76b7e07 Document actual behaviour of wxPoint ctor from wxRealPoint
The changes of 1f7a8a8 (Round, rather than truncate, in wxSize and
wxPoint operations, 2018-03-06) have invalidated the documentation that
had been previously added in 4c20f3d (Document that wxPoint(wxRealPoint)
ctor truncates, not rounds., 2013-04-16) to document the old behaviour.

Changing the behaviour once again doesn't seem to be desirable, but at
least synchronize the documentation with it again.

See #26099.

(cherry picked from commit eb64d55ea9)
2026-01-15 18:44:08 +01:00
Vadim Zeitlin 73f6213c7c Update copyright years to 2026
ABI check / ABI check (push) Has been cancelled
Unix builds / Ubuntu 24.04 wxGTK with ASAN (push) Has been cancelled
Unix builds / Ubuntu 22.04 wxGTK ANSI (push) Has been cancelled
Unix builds / Ubuntu 18.04 wxGTK UTF-8 (push) Has been cancelled
Unix builds / Ubuntu 18.04 wxMotif (push) Has been cancelled
Unix builds / Ubuntu 18.04 wxQt (push) Has been cancelled
Unix builds / Ubuntu 18.04 wxX11 (push) Has been cancelled
Unix builds / Ubuntu 18.04 wxGTK 2 (push) Has been cancelled
Unix builds / Ubuntu 20.04 wxGTK 3 with clang (push) Has been cancelled
Unix builds / Ubuntu 18.04 wxGTK 3 static with gcc 4.8 (push) Has been cancelled
Unix builds / Ubuntu 18.04 wxGTK 3 STL (push) Has been cancelled
Unix builds / Ubuntu 18.04 wxDFB (push) Has been cancelled
CMake builds / macOS 14 wxOSX (push) Has been cancelled
CMake builds / Windows MSVC (push) Has been cancelled
CMake builds / macOS 14 wxIOS (push) Has been cancelled
CMake builds / Ubuntu 22.04 wxGTK 3 (push) Has been cancelled
MSW builds / wxMSW vs2022 DLL Debug x64 (push) Has been cancelled
MSW builds / wxMSW vs2022 DLL Release x64 (push) Has been cancelled
MSW builds / wxMSW vs2022 Debug Win32 (push) Has been cancelled
MSW cross-builds / wxMSW 32 bits (push) Has been cancelled
MSW cross-builds / wxMSW 64 bits (push) Has been cancelled
Code Checks / Check Spelling (push) Has been cancelled
Code Checks / Check Whitespace (push) Has been cancelled
Code Checks / Check Mixed EOL (push) Has been cancelled
Code Checks / Check C++ Style (push) Has been cancelled
Update Documentation / Update Online Documentation (push) Has been cancelled
Just run misc/scripts/inc_year and commit the results.

See #18690.
2026-01-01 17:41:46 +01:00
Scott Talbert 8b6d46ef09 Document wxObjectRefData as a typedef (vs class)
While this is actually more true to reality, this also helps work around
an issue with Doxygen 1.15.0 (and wxPython builds).  See:
https://github.com/doxygen/doxygen/issues/11889

See #26033.

(cherry picked from commit cf49b6a220)
2025-12-15 03:32:56 +01:00
Robert Roebling eec6c4ddf8 Use better name for wxSpinCtrl::SetIncrement() arg in the docs
Call it "inc" instead of "value" because this is what it actually is and
for consistency with the actual header and SetIncrement() in
wxSpinCtrlDouble.

See #26002.

(cherry picked from commit 666966acbf)
2025-12-06 18:16:12 +01:00
Blake-Madden ed76f502c1 Clarify wxLog::SetActiveTarget()
See #25852.

(cherry picked from commit 5de9ceb603)
2025-10-03 09:48:27 +02:00
Vadim Zeitlin 82da38723c Document wxIMPLEMENT_APP_NO_MAIN() too
This was mentioned in the documentation of other macros but not
documented itself, do document it now.

(cherry picked from commit 212bfaf977)
2025-09-08 23:10:48 +02:00
Vadim Zeitlin c84d53012f Fix wrong documentation of wxObjectDataPtr ctor
This ctor was wrongly documented back in cfa9866bf5 (revision
contributed by Utensil Candel, 2008-03-30) to call IncRef() on the
pointer passed to it but in fact it just takes ownership of it.

See #25692.

(cherry picked from commit ea0a01879f)
2025-08-13 23:13:28 +02:00
Vadim Zeitlin 99daac0eea Make wxPlatformInfo::Get() thread-safe
Protect gs_platInfo initialization with a critical section to ensure
that we don't try to do it in parallel from more than one thread,
resulting in crashes.

See #25459, #25464.

(cherry picked from commit a26eda72e8)
2025-07-30 23:38:01 +02:00
Vadim Zeitlin d63adfdda3 Don't assert in wxGridSizer::Calc{Cols,Rows}() if sizer is empty
When the sizer is completely empty, it makes more sense to return 0
from these functions without asserting.

See #25642, #25641.

(cherry picked from commit d1be72aa8e)
2025-07-28 16:25:25 +02:00
Miguel Gimenez e04485ddf0 Improve wxPropertyGrid::SetSortFunction() documentation
Information about the returned value was incomplete, list all the
possibilities.

See #25452.

(cherry picked from commit ce7273b3ba)
2025-05-26 17:54:22 +02:00
Blake-Madden 600803a6dc Add @USER@ macro to HTML and RichText printers
Replace it with the result of wxGetUserName().

See #25318.

(cherry picked from commit abb59d3103)
2025-04-11 16:47:01 +02:00
DietmarSchwertberger 5a102b41f1 Fix some event macro arguments in interface declarations
Remove the non-existent arguments and unnecessary backslashes.

See #25278.

(cherry picked from commit 0b8049e577)
2025-03-30 16:57:31 +02:00
Vadim Zeitlin 98c158577f Improve key events generation in wxGTK
Rewrite key events generation in wxGTK to make it more logical and
consistent with wxMSW.

See #25200.

(cherry picked from commit 9b1818d534)
2025-03-08 18:08:04 +01:00
Vadim Zeitlin 26b7fd5c36 Improve wxWindow::Update() documentation
Explain that this function shouldn't be used and document that it does
nothing when using wxGTK with Wayland.

(cherry picked from commit dc05681242)
2025-03-08 16:30:30 +01:00
Vadim Zeitlin d929174eb6 Document wxDocManager::GetDocumentManager()
This function exists since always, but somehow was never documented.

Do it now, better late than never.

(cherry picked from commit 8a6efbf5bb91e8fec7f77c4f5096daa663f74520)
2025-02-19 01:45:41 +01:00
Lauri Nurmi d647d8a558 Add subitem support to wxGenericListCtrl::HitTest()
See #25153.

(cherry picked from commit 580df3d670)
2025-02-15 15:37:10 +01:00
Scott Talbert 89ba8f190b Add missing documentation for wxBoxSizer::InformFirstDirection()
See #25122.

(cherry picked from commit 428f9b44b0)
2025-01-26 21:47:35 +01:00
Blake-Madden 7cef03e0cf Minor wording improvements in wxTextCtrl documentation
See #25119.

(cherry picked from commit fc423ab47f)
2025-01-26 21:47:24 +01:00
Vadim Zeitlin 7ab94474f3 Fix documentation of wxArrayString ctors taking C arrays
Don't an unnecessary documentation group, this results in these ctors
being documented in a separate documentation section from all the other
ctors.

See #25113.

(cherry picked from commit d1aa050721)
2025-01-26 21:47:04 +01:00
Vadim Zeitlin a25b58d0b4 Use Win32 ReplaceFile() to implement wxRenameFile(overwrite=true)
This function should be atomic, unlike our own code doing copy+remove if
rename fails (as it always will under MSW if the destination exists).

(cherry picked from commit 02e6ad2560)
2025-01-21 19:49:26 +01:00
PB d8545cc61f Recognize Windows Server 2025 in wxGetOsDescription()
Recognize Windows Server 2025 in wxGetOsDescription()
and update Windows OS table in wxGetOsVersion() docs.

See #25066.

(cherry picked from commit c88c86ece9)
2025-01-12 15:50:27 +01:00
PB 2b4bfeef66 Improve window sizing documentation
Fix the flag name in wxSizerFlags::Shaped() description.

Add a reference to Windows Sizing Overview to Window Layout page and
Sizers Overview.

Add a reference to Sizers Overview to Window Sizing Overview.

Closes #25044.

(cherry picked from commit e0b055e53b)
2025-01-06 22:21:01 +01:00
Vadim Zeitlin 7d43d6b9c6 Allow setting the exit code when returning false from OnInit()
Unfortunately returning false from the (overridden) wxApp::OnInit() has
a side effect of exiting the application with inconsistent error code:
255 under Unix but 127 under MSW with MSVC.

While changing the default exit code in this case is probably a bad idea
because there are surely people relying on the current values, at least
allow changing it by explicitly calling the new SetErrorExitCode()
function.

Unlike the version in master, this commit uses a global variable for the
exit code value to avoid changing the ABI.

(cherry picked from commit e2de7dc625)
2025-01-01 23:27:54 +01:00
Vadim Zeitlin 1500a05b4c Update copyright years to 2025 in 3.2 branch too
Just run misc/scripts/inc_year and commit the results.

See #18690.
2025-01-01 22:13:44 +01:00
Vadim Zeitlin ac371abb7a Use the standard naming convention for WX_GL_COMPAT_PROFILE
Use "WX" prefix for it, just as for all the other constants in the same
enum instead of the lower-case "wx" (which is still preserved for
compatibility).

See #24964, #24965.

(cherry picked from commit 7af7c55ed0)
2024-11-27 01:14:55 +01:00
Daniel Collins dc86045658 Implement wxCursor::GetHotSpot() in wxOSX/Cocoa
Forward it to the corresponding NSCursor accessor.

See #24961.

(cherry picked from commit c3ee8a4ad1)
2024-11-20 14:27:12 +01:00
Lauri Nurmi f5da2bbf8b Make wxWARN_UNUSED an opt-in feature in 3.2
Define wxWARN_UNUSED always as nothing, unless wxNO_UNUSED_VARIABLES is
defined by the library user.

Also opt-in for wxWARN_UNUSED when building wxWidgets itself, i.e. when
WXBUILDING is defined.
2024-10-18 19:40:55 +02:00
Lauri Nurmi fa876c3f74 Add macro wxWARN_UNUSED to stand for the attribute 'warn_unused'
Also known as [[gnu::warn_unused]].

Use __has_attribute to check availability of the attribute. (Is available
on recent GCC and Clang versions, not available on MSVC.)

(cherry picked from commit a2e2bc57c9)
2024-10-13 18:34:29 +03:00
Scott Talbert f99b2ff012 Fix docs generation for datetime with doxygen 1.11.0
It seems that as of the below commit, doxygen changed its handling of
parsing backticks in comments such that it now fails to properly
generate documentation for the entire datetime.h file.  Fix this by
closing the open backtick.

Also update the actual, non-documentation, header to match for
consistency, even if non-matching backticks are not a problem there.

See: https://github.com/doxygen/doxygen/commit/f18767307be20ca8d2ca81f74cc1f3446205282b

See #24814.

(cherry picked from commit 2d79dfc7a2)
2024-09-20 17:56:20 +02:00
Vadim Zeitlin 8ba12f0e4a Docs fixes for wxTreeCtrl and wxGrid
See #24766.

(cherry picked from commit f4d00c1082)
2024-08-20 19:03:56 +02:00
valid-ptrandVadim Zeitlin c4f5d6fd5c Handle wxNOT_FOUND in wxDataViewChoiceByIndexRenderer correctly
Map this value to an empty string instead of crashing.

See #24741.

Co-authored-by: Vadim Zeitlin <vadim@wxwidgets.org>

(cherry picked from commit 1b6bfff1d8)
2024-08-01 14:18:35 +02:00
Vadim Zeitlin f1ceebd30f Add wxSystemSettings::SelectLightDark() and use it
Add a convenient helper allowing to select between the two colours
depending on whether we're using light or dark mode.

Use this in a couple of places instead of manual tests for IsDark().

No real changes.

(cherry picked from commit 30dc3350dc)
2024-07-23 16:09:49 +02:00
Václav Slavík d7f6a7e8d2 Fix AddAvailableCatalog() API
Knowing msgIdLanguage is necessary for correct evaluation of preferred
languages order; without it, it would be possible to load undesirable
translation file.

See 2af36e9560 for details.
2024-07-13 16:26:30 +02:00
Václav Slavík d36f3a8baf Clarify GetAvailableTranslations() return value
Add a note explaining that the msgid language is not included.
2024-07-12 19:53:15 +02:00
Václav Slavík 0eab2878e2 Warn about a GetBestAvailableTranslation() quirk 2024-07-12 19:53:15 +02:00
PB 7712b0ce78 Update the Windows versions table in wxGetOsVersion() docs
Update Windows Server information.

Additionally, add a note to wxGetOsDescription() source to
keep the table in docs in the sync with the code.

See #24653.

(cherry picked from commit 73e28e2b65)
2024-07-04 01:20:10 +02:00
Vadim Zeitlin 3771c5d046 Don't claim that wxDateTime uses strptime() in the documentation
This isn't the case any more since a long time, see 89a7e1ff98 (Added
wxLOCALE_DATE/TIME_FMT support to wxLocale::GetInfo()., 2009-03-29).

(cherry picked from commit 0cc5c37429)
2024-05-19 20:48:38 +02:00
PB a7a387a291 Document all supported styles in wxSpinCtrlDouble docs
Document all available styles, i.e., just like with wxSpinCtrl, list
also wxTE_PROCESS_ENTER and the three text alignment options.

See #24488.

(cherry picked from commit 86e4660ba6)
2024-04-24 20:52:03 +02:00
Vadim Zeitlin 3b3a72e3e7 Return false from wxKeyEvent::IsKeyInCategory(WXK_TAB) for Ctrl+I
Although TAB and Ctrl+I generate the same key code in the events passed
to wxEVT_CHAR handlers, it seems more reasonable to only consider the
former to be in "TAB category", but not the latter.

See #10268, #24254, #24258.

(cherry picked from commit 460c35ff0e)
2024-03-12 14:02:57 +01:00
DietmarSchwertberger 23ad1a9251 Add hint about wxBusyInfo to wxBusyCursor documentation
This is often a (more) useful alternative.

See #24364.

(cherry picked from commit a62d2dc9d9)
2024-02-29 16:10:34 +01:00
Vadim Zeitlin 935d120cd6 Improve native MSW dialog DPI awareness
Only show the native dialogs using system dpi-awereness, when there are
displays with different DPI.

And add the msw.native-dialogs-pmdpi option to also show the dialogs
using per-monitor dpi-awareness when there are displays with different
DPI.

This is a combined cherry-pick of 5ae3b771ad (Merge branch
'win32-native-dialogs-pmdpi' of https://github.com/MaartenBent/wxWidgets,
2024-01-19) and c72f4efc9c (Fix crash when closing a wxColourDialog
under MSW, 2024-02-06)

See #24121, #24196, #24288.
2024-02-29 16:10:34 +01:00
Vadim Zeitlin acc844771e Allow passing -1 to wxPGProperty::SetChoiceSelection() again
This used to be possible in 3.0 but was disallowed back in 29bf859fae
(Check if new index is in range before selecting new value in
wxPGProperty::SetChoiceSelection., 2014-11-29). However there doesn't
seem to be any real harm in still allowing to do this, so handle -1 as a
special case here.

See #24279, #24281.

(cherry picked from commit a6cc89777b)
2024-02-09 17:22:35 +01:00
DietmarSchwertberger bd899c6671 Add missing documentation of wxWindow accessibility functions
Ensure they're present in the interface header as this is also required
for wrapping them in other languages, such as Python.

See #24209.

(cherry picked from commit 81e9373efa)
2024-01-12 00:36:03 +01:00
David Miguel Susano Pinto b8f41e41b0 Correct wxRealPoint and wxPoint operator return types in the docs
Use the correct types instead of wxSize which was erroneously used
there ever since a5664fd6ef (Increase interoperability between wxPoint
and wxRealPoint introducing constructors which convert between the two
classes., 2010-06-09).

See #23804, #24186.

(cherry picked from commit a8b14edc40)
2024-01-03 20:29:22 +01:00
Vadim Zeitlin 6ad7092d25 Update copyright years to 2024 in 3.2 branch too
Just run misc/scripts/inc_year and commit the results.

See #18690.
2023-12-31 19:00:22 +01:00
PB e4617e6f58 Fix confusing argument names in wxPersistentWindow docs
Use the same argument name as in the actual code in the class
constructor as well as the convenience function, instead of
wrongly copypasted "book".

See also 33de6dc (Fix confusing wxPersistentTLW ctor argument name,
2023-12-22).

See #24158.

(cherry picked from commit 24952d0203)
2023-12-25 21:04:36 +01:00