Commit graph

4530 commits

Author SHA1 Message Date
Vadim Zeitlin
0067ff7753 Improve wxEVT_GRID_SELECT_CELL documentation
Mention that the event can be vetoed and the consequences of that.
2022-09-27 23:26:34 +02:00
Tobias Taschner
cd552b3741 Fix typos in wxWebView docs
Closes #22822.
2022-09-24 15:14:53 +02:00
Tobias Taschner
9ea1423eda
Additional wxWebView documentation tweaks 2022-09-19 20:43:41 +02:00
Tobias Taschner
5ab7151ada
Apply suggestions from code review
Co-authored-by: VZ <vz-github@zeitlins.org>
2022-09-19 19:41:42 +02:00
Tobias Taschner
b7a233753a
Document wxWebView::StartRequest()
Document the new method on associated classes.
2022-09-16 21:00:52 +02:00
Vadim Zeitlin
d8556bf3ee Merge branch 'webview_native_config' of https://github.com/TcT2k/wxWidgets
Add wxWebView::GetNativeConfiguration().

See #22781.
2022-09-10 13:40:07 +02:00
Tobias Taschner
6780383163
Fix wxWebView documentation grouping
Set/GetUserAgent() where grouped under "Dev Tools"
2022-09-09 18:07:00 +02:00
Tobias Taschner
40ff38b63b
Add wxWebView::GetNativeConfiguration()
New method to return the pointer to the native configuration used during
the creation of the web view

This allows for customization that would not be available to the
application otherwise.
2022-09-09 18:00:04 +02:00
PB
e1a56e21bb Remove v2.8 compatibility functions from wxVScrolledWindow docs
Section "wxWidgets 2.8 Compatibility Functions" does not apply anymore,
these deprecated methods were removed in wxWidgets 3.3, therefore the
whole section must be removed.

Closes #22783.
2022-09-09 17:24:36 +02:00
PB
17371d911d Improve wxBitmapBundle documentation, notably mention SVG support
Add an SVG and a wxBitmapBundleImpl to the list of methods that can be
used when creating a wxBitmapBundle.

Remove a generic sentence promising adding other methods of creating
bundles in the future.

Closes #22774.
2022-09-05 20:35:43 +02:00
Vadim Zeitlin
ab2dd24976 Add wxGrid::Enable{Row,Col}Resize()
These functions are needed to allow resizing the rows/columns whose size
was fixed by Disable{Row,Col}Resize() as otherwise the effect of a call
to the latter function can't be undone at all.
2022-09-02 20:52:20 +01:00
Vadim Zeitlin
3d223ee776 Assert if the arguments of FreezeTo() are really out of range
This shouldn't be just silently ignored as it indicates a programming
error, unlike the other conditions being tested here.
2022-09-02 00:05:25 +01:00
Vadim Zeitlin
d914a6ca22 Fix check for parameter validity in wxGrid::FreezeTo()
The number of rows or columns to freeze may be equal to the total number
of rows or columns, it just can't be strictly greater than it.

This is especially important when trying to thaw a grid which doesn't
have any rows, for example: before this change FreezeTo() would simply
return immediately, leaving the number of frozen columns unchanged and
quite possibly invalid (i.e. really out of range). Fix this by ensuring
that we reset it correctly now.

Also fix the types of the parameters in the documentation.
2022-09-02 00:02:58 +01:00
Vadim Zeitlin
6f00c734cd Remove useless check for grid size in wxGrid::FreezeTo()
This resulted in silently doing nothing when calling FreezeTo() on a
grid which hadn't been resized to its full size yet, which seems wrong
and not useful at all, so simply remove this check and freeze the
requested rows/columns in any case -- it's the user responsibility to
make the grid sufficiently big to allow the user to see the non-frozen
parts.
2022-09-01 23:58:24 +01:00
Vadim Zeitlin
ef6ee28876 Merge branch 'gtk-log'
Fix crash when using wxNotebook in applications calling
g_log_set_writer_func() with glib 2.73+

See #22753.
2022-08-30 12:19:31 +02:00
Vadim Zeitlin
b4de847d7b Merge branch 'grid-process-table-message'
Improvement to wxGrid::ProcessTableMessage().

See #22749.
2022-08-30 12:14:22 +02:00
Vadim Zeitlin
de345d33b2 Merge branch 'docview-onclosedoc'
Improvements to closing wxDocument: don't call OnCloseDocument() twice.

See #22627.
2022-08-30 11:12:58 +01:00
Vadim Zeitlin
8af645ed22 Fix crash when using wxNotebook with glib 2.73 or later
Make GTK notebook log suppression opt-in to avoid a fatal error when the
application calls g_log_set_writer_func() itself, as doing it more than
once immediately kills the application with glib 2.73 and there is no
way to check if it had been already done or not (you have to admire the
purity of the API design here).

This is unfortunate as 99% of the wxWidgets applications that do _not_
call g_log_set_writer_func() would now show the spurious diagnostics by
default again, but preferable to making the remaining 1% crash, and
there doesn't seem to be any other solution.

Call the new GTKAllowDiagnosticsControl() function in the notebook
sample to at least still avoid getting the spurious diagnostic messages
described in #22176 there.

See #22717,.
2022-08-29 18:10:15 +02:00
Kenneth Porter
974a7658da Add wxColourDatabase::GetAllNames()
Return all known colour names from this function and show them in the
drawing sample.

Closes #9264.

Closes #22724.
2022-08-29 00:44:49 +02:00
Vadim Zeitlin
7ee384389b Add more convenient wxGrid::ProcessTableMessage() overload
This allows to write the same thing in a shorter way without any loss of
clarity.
2022-08-28 20:53:58 +02:00
Vadim Zeitlin
2dafdbbed0 Document change to wxGrid::ProcessTableMessage() signature
Update the documentation after the change in the previous commit and
improve it to make it more clear what this function does and when it
should be called.
2022-08-28 20:52:44 +02:00
Lauri Nurmi
66916c74a3 Fix double negatives used with 'neither' in docs and comments
In many cases it should be 'either', and 'nor' should be 'or'
accordingly.

No changes to actual code.

Closes #22723.
2022-08-19 16:22:21 +02:00
Vadim Zeitlin
537f11fd4d Improve wxRegEx::GetMatch() return value documentation
Don't imply that the function returns false for the empty capture groups
because this is not the case (and never was).

See #22708.
2022-08-06 18:32:16 +02:00
Vadim Zeitlin
7999102295 Document wxGrid::RefreshBlock()
This function is useful and there is no reason to exclude it from public
API and it should have been done back in 00224e3f30 (Add
wxGrid::RefreshBlock() helper, 2019-07-11) when it was added.
2022-08-03 19:36:22 +02:00
Vadim Zeitlin
c0f1ecf263 Fix another unbalanced Doxygen grouping command after last commit
Add the missing section start to wxString documentation.

See #22248.
2022-08-03 19:36:22 +02:00
Vadim Zeitlin
8ac10d28f8 Fix all the other comments with Doxygen grouping commands too
This is the same thing as bd92523bc5 (Fix use of Doxygen @addtogroup
command, 2022-08-03) except it fixes comments format for all the other
occurrences of "@{" and "@}" too, not just for those used with
@addtogroup which was the problem in #22572.

This fixes many different formatting problems due to attaching various
Doxygen commands to wrong elements because of broken grouping, e.g. all
overloaded functions were documented incorrectly and there were several
problems in wxString documentation.

See #22248.
2022-08-03 18:58:47 +02:00
Vadim Zeitlin
4c46e01b14 Remove stray Doxygen end group marker
This fixes a warning given, after the changes of the last commit, by
Doxygen 1.9.1 but, amazingly, not given by the latest 1.9.4.

See #22572.
2022-08-03 18:35:45 +02:00
Vadim Zeitlin
bd92523bc5 Fix use of Doxygen @addtogroup command
Put Doxygen grouping constructs ("@{" and "@}") in Doxygen comments
rather than plain C++ ones to make them actually take effect. Some old
Doxygen versions (~1.8.5) did recognize them even in plain comments, but
the currently uses 1.9.1 one does not and @addtogroup didn't have any
effect as the result.

This fixes the problem with the "Functions by Category" pages being
empty in the resulting HTML documentation.

See #22572.
2022-08-03 18:28:06 +02:00
Vadim Zeitlin
6917b6b0f1 Document wxTHREAD_WAIT_DEFAULT value change
It has been a long-time coming, see b95a7c3144 (Allow wxThread::Wait()
and Delete() to block, even under wxMSW., 2011-03-14), but do still
document that it has finally changed.
2022-08-03 17:39:48 +02:00
Artur Wieczorek
5e2da5a106 Get rid of v2.8 code 2022-08-02 08:26:29 +02:00
Vadim Zeitlin
57bf9c5af5 Escape all "__" in Doxygen to preserve them in the output
New version of Doxygen interprets __foo__ as Markdown markup and
consumes the underscores, which mangles the identifier.

Prevent this from happening by escaping the leading underscore for all
occurrences of "__" outside of the code blocks, this seems to be the
least intrusive fix.

See #22671.
2022-07-30 14:56:23 +02:00
Vadim Zeitlin
8e2c683bf7 Merge branch 'grid-message'
Improve wxGrid messages documentation and safety.

See #22652.
2022-07-24 15:52:15 +01:00
Vadim Zeitlin
c15c0040db Correct documentation of wxGridTableMessage ctor parameters
Notably explain that the first parameter should contain the number of
rows/columns when appending, not the position.
2022-07-19 16:18:47 +01:00
Vadim Zeitlin
39a226c600 Document customizing shortcuts section title in wxMSW
It's quite non obvious that the "FileDescription" field of the version
information defined in the resource file is used for this, so explain
it.

Co-Authored-By: Mark Roszko <mark.roszko@gmail.com>
2022-07-18 23:57:49 +01:00
Vadim Zeitlin
854599c0bd Add wxFileDialog::AddShortcut() documentation
Also add a comment to the sample explaining the default behaviour.
2022-07-17 22:24:56 +01:00
Vadim Zeitlin
dcee1cd025 Improve behaviour of "force closing" wxDocuments
When the document was forced to close, OnSaveModified() was still called
and allowed the user to cancel closing the document -- but it was still
closed after OnSaveModified() returned.

Be more upfront about it and tell the user that the document will be
closed anyhow, but still propose them to save it if necessary.

An alternative solution might be to just deprecate "force closing"
entirely, as this seems very user-unfriendly.
2022-07-15 00:41:58 +01:00
Vadim Zeitlin
3e195db27e Correct default OnCloseDocument() implementation documentation
Don't say that the version of this function in wxDocument checks whether
the document is modified and asks the user if it should be saved because
this is not the case: this is done in a separate OnSaveModified()
function called earlier.

Also document that this function should always return true.
2022-07-15 00:15:40 +01:00
Vadim Zeitlin
134862a464 Document that wxWindow::SetClientSize() doesn't support -1
Unlike SetSize(), passing -1 to this function doesn't preserve the
existing size in the corresponding direction.
2022-07-15 00:57:53 +02:00
MikeWang000000
d8eddbd115 Fix using non-alphanumeric language ids in MSW resources
The character "@", which can be part of the full language name, e.g. in
the case of "sr@latin", can't be reliably used as part of resource name,
so replace it with "_" in wxResourceTranslationsLoader.

Closes #22589.

Closes #22601.
2022-07-12 15:35:52 +02:00
Tim Stahlhut
4010140491 Don't use non-ASCII characters in interface headers
Replace "’s" with "'s" in interface headers as the former broke wxPython
build with SIP under MSW.

Closes #22605.
2022-07-06 00:26:54 +02:00
Ronny Krüger
8ef6f9fa27 Add a 'revision' component to wxVersionInfo
Some versions consist of four parts with the last part being called the
revision or build number. wxVersionInfo is now able to save such a
fourth number.
2022-06-29 22:50:12 +02:00
Vadim Zeitlin
b95f2b699d Clarify that wxDC::CopyAttributes() doesn't copy scaling factor
Also show an example of setting the scaling factor in wxMemoryDC
documentation.
2022-06-28 22:50:24 +02:00
Vadim Zeitlin
b9a84dcae5 Improve wxMemoryDC documentation
Try to explain the difference between SelectObject() and
SelectObjectAsSource() more clearly.
2022-06-28 22:45:30 +02:00
Vadim Zeitlin
7e1cbe8f79 Merge branch 'bmpbndle-from-xpm'
Allow creating wxBitmapBundle from XPM and use it in wxRichToolTip.

See #22573.
2022-06-27 01:33:28 +02:00
Vadim Zeitlin
e9e22477cc Remove "experimental" warning from wxDisplayChangedEvent docs
There are no known big problems with this event any longer.
2022-06-26 22:18:17 +02:00
Vadim Zeitlin
2fa0bd5b1b Improve documentation of the default wxEVT_DPI_CHANGED handler
Mention that the size may grow unexpectedly.

Co-Authored-By: Maarten Bent <MaartenBent@users.noreply.github.com>
2022-06-26 22:17:15 +02:00
Vadim Zeitlin
74967df874 Take wxBitmapBundle, not just wxIcon, in wxRichToolTip::SetIcon()
Extend this function to allow passing it multi-resolution bitmaps too.
2022-06-26 21:52:30 +02:00
Vadim Zeitlin
f48a13514f Allow constructing wxBitmapBundle from XPM data for compatibility
Add another compatibility implicit constructor to allow the existing
code, directly passing XPM data to various functions that used to take
wxBitmap or wxIcon and now taking wxBitmapBundle, to work.

Closes #22566.
2022-06-26 20:52:13 +02:00
Vadim Zeitlin
f0ea00cd35 Let application determine TLW size after DPI change
Don't change the window size automatically if the application handled
wxEVT_DPI_CHANGED event to allow it to choose a better size than what is
suggested by MSW itself.

Closes #19152.
2022-06-24 02:49:34 +01:00
Vadim Zeitlin
c639226543 Merge branch 'dvc-model-simplify'
Simplify defining classes inheriting from wxDataViewModel.

See #22553.

Closes #17755.
2022-06-20 00:42:54 +02:00