Commit Graph

2604 Commits

Author SHA1 Message Date
Scott Talbert
98065821bb Fix wxGetKeyState() on non-X11 wxGTK backends (e.g., Wayland)
wxGetKeyState() does not currently work on non-X11 GTK backends, and in some
cases it has been reported to crash.  It seems that the most likely use case
for wxGetKeyState() is to query the modifier keys, so on non-X11 backends, use
GTK+ calls to retrieve the modifier key state.

Non-modifier keys are not currently implemented, update the documentation to
mention this.

Closes https://github.com/wxWidgets/wxWidgets/pull/322

(this is a combined backport of 1033fb048d,
9f9c09e24a and
a18fe083cc from master)
2016-09-13 13:24:12 +02:00
Scott Talbert
fcb8497def Document wxHLB_XXX constants for wxHtmlListBox styles
Add missing #define's to htmllbox interface header.

Closes https://github.com/wxWidgets/wxWidgets/pull/323

(cherry picked from commit de1aff4117)
2016-09-09 23:46:36 +02:00
Vadim Zeitlin
03903c1e45 Document wxEVT_MEDIA_XXX event types.
See #15768.

(cherry picked from commit 5c1f95bc71 on master)
2016-03-11 03:06:40 +01:00
bogiord
2fdc7196a3 Fix docs for wxGrid and friends
Add a couple of missing @name commands; the corresponding comments were
appearing in the wrong place without them.

Avoid unintended effects of JAVADOC_AUTOBRIEF by using Qt-style comments
instead of Javadoc.

A couple of minor wording corrections.

See https://github.com/wxWidgets/wxWidgets/pull/175

(this is a backport of 9c95b398c8 from master)
2016-01-20 18:58:53 +01:00
Vadim Zeitlin
458bcb9546 Insert missing "@name" tags in wxTreeListCtrl documentation
This fixes the appearance of the different sections in the generated
documentation.

(this is a backport of 50ae059a67 from master)
2015-10-24 23:10:15 +02:00
Cătălin Răceanu
4b9712582c Correct wxThread::Delete() default parameter documentation.
It is actually wxTHREAD_WAIT_DEFAULT and not always wxTHREAD_WAIT_BLOCK.

Closes https://github.com/wxWidgets/wxWidgets/pull/107
2015-10-05 00:32:08 +02:00
Vadim Zeitlin
f0e67ed517 Allow requesting core OpenGL profile and explicit OpenGL version.
Add WX_GL_CORE_PROFILE and WX_GL_{MAJOR,MINOR}_VERSION attributes which can be
used to use modern OpenGL with wxGLCanvas.

See #16402.

(this is a backport of 3c7ba39135 from master)
2015-09-23 03:18:33 +02:00
Vadim Zeitlin
4276726f3c Document "expmode" argument of exported array macros
At least mention the previously missing "expmode" argument in the
documentation.

See #17156.

(this is a backport of 9589eaa113 from master)
2015-09-19 19:58:07 +02:00
Rob Krakora
76ee2fa0a0 Implement sending wxIconizeEvent in wxOSX.
Translate windowDid{Miniaturize,Deminiaturize} callbacks to calls to
SendIconizeEvent().

Closes #16718.

(this is a backport of 31e1387541 from master)
2015-08-26 15:53:39 +02:00
Cătălin Răceanu
e4eb6920fd Improve formatting of identifiers in wxTextCtrl documentation.
Render "std" in fixed-width font.

Closes https://github.com/wxWidgets/wxWidgets/pull/75

(cherry picked from commit 8d4d4c45b1)
2015-08-24 08:05:05 -07:00
Cătălin Răceanu
e9a5d5b7d1 Correct document of wxListView constructor.
The documented default values of constructor arguments didn't correspond to
the reality.

Closes https://github.com/wxWidgets/wxWidgets/pull/74

(cherry picked from commit f3da2e27e9)
2015-08-24 08:03:24 -07:00
Olly Betts
1033ba59d2 Fix typo in GetOperatingSystemDescription() docs.
Fix the case of wxGetOSDescription() in the link.

Closes #17003.

(cherry picked from commit 716656ae47)
2015-08-04 20:40:49 -07:00
Catalin
2bf36da6ba Improved wxStandardPaths docs.
(cherry picked from commit e606d83e88)
2015-08-04 20:38:33 -07:00
Vadim Zeitlin
a5cf08fcbd Correct wxAuiNotebook::SetUniformBitmapSize() documentation.
This function used the same documentation as Split() for some reason, document
it correctly now.

Closes #17049.

(cherry picked from commit b7f3d0d752)
2015-08-04 20:20:21 -07:00
Vadim Zeitlin
6de38c1f0e Document wxDC::{Set,Get}Logical{Scale,Origin}() functions.
They are relatively important, especially the origin-related ones as
SetUserScale() can (should?) be used instead of SetLogicalScale(), but
SetLogicalOrigin() can be more convenient than SetDeviceOrigin(), so provide
at least skeletal documentation for them.

(cherry picked from commit 394b04b7e4)
2015-08-04 20:19:11 -07:00
Vadim Zeitlin
a45354d3ed Correct the documentation of wxFrame ctor parent argument.
It doesn't result in the frame floating over its parent, this is what
wxFRAME_FLOAT_ON_PARENT style is for, it just means that the frame is
minimized/restored when its parent is.

(cherry picked from commit 6339837ffa)
2015-08-04 20:12:57 -07:00
Vadim Zeitlin
417d242e77 Provide correct documentation for wxWindow::SetPosition().
Just refer to Move(), this is trivial but necessary as otherwise Doxygen
"helpfully" reuses the first comment in the section for the otherwise
undocumented SetPosition() which didn't make any sense at all.

(cherry picked from commit 949d2eeaa5)
2015-08-04 20:11:55 -07:00
Robin Dunn
0225897079 Add some missing default ctors and Create methods.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@78511 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2015-02-16 21:42:16 +00:00
Vadim Zeitlin
14c29db79c Correct wxInfoBar::ShowMessage() flags argument documentation.
The default value is wxICON_INFORMATION, not wxICON_NONE.

Closes #16861.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@78486 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2015-02-14 14:46:28 +00:00
Václav Slavík
14f052a768 Allow disabling SetProcessDPIAware() call
Add Windows-specific wxMSWDisableSettingHighDPIAware() function then can
be called before startup (i.e. wxEntry() call) to disable wxWidgets'
handling of DPI awareness. This is useful for code embedded in non-wx
applications as well as for purely wx application that are not
HiDPI-ready (although the latter has the option of forcing
dpiAware=false in the manifest).

See also https://groups.google.com/d/msg/wx-dev/Z0VpgzCY34U/f1FfPqGDppMJ
and #16116.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@78406 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2015-01-24 15:00:03 +00:00
Vadim Zeitlin
9a8aa7899c Document wxGraphicsContext::CreateBitmapFromNativeBitmap() ownership rules.
Mention that it takes ownership of the native bitmap passed to it.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@77721 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-09-18 00:03:04 +00:00
Vadim Zeitlin
1169897404 Mention that wxDialog::SetEscapeId() can't be used for native dialogs.
Native dialogs handling of Esc can't be customized (definitely not easily,
and possibly not at all).

See #16521.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@77528 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-09-03 11:21:41 +00:00
Vadim Zeitlin
e265092879 Remove recursive "see also" link from GetAppDocumentsDir() docs.
This was probably supposed to be "@see GetDocumentsDir()", but as this
function is already mentioned, and auto-linked by Doxygen, just above, another
link to it is unnecessary, so remove it.

Closes #16520.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@77527 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-09-03 11:21:36 +00:00
Vadim Zeitlin
66d9b9e1fe Don't document wxFileType::GetIcon() as unimplemented under OS X.
It is implemented and supposed to work.

See #4562.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@77015 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-08-06 22:59:45 +00:00
Vadim Zeitlin
03fb8ebf7b Add XRC handler for wxSimplebook.
Similar to wxNotebook but even simpler as wxSimplebook doesn't use images.

Also add wxSimplebook::Create() as the version inherited from wxBookCtrlBase
didn't _quite_ work: we need to add wxBK_TOP style to prevent asserts due to
unknown alignment in the base class when creating wxSimplebook.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@77007 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-08-05 22:00:57 +00:00
Vadim Zeitlin
d1471a66b3 Add support for "%V" and "%G" to wxDateTime::Format().
This is useful for creating ISO 8601 week number based stamps.

Closes #11857.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76958 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-07-27 23:04:30 +00:00
Vadim Zeitlin
644af9fa6c Correct the addition of wxLANGUAGE_KABYLE.
Repair (too late?) the ABI breakage for all the language constants following
wxLANGUAGE_KABYLE in alphabetical order by adding this enum element at the end
of the enum instead of in the middle.

Also add wxLANGUAGE_KABYLE to langtabl.txt so that it doesn't disappear when
the generated fragments are updated by running misc/languages/genlang.py the
next time.

This corrects/supersedes r75753.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76871 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-07-07 17:11:37 +00:00
Tim Kosse
254ca4fb22 Fix typo in documentation.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76855 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-07-06 10:05:44 +00:00
Vadim Zeitlin
15ed55e357 Fix typo in wxTreeCtrl::AppendItem() documentation.
The greater sign got lost in Doxygen translation, restore it.

Closes #16366.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76821 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-07-04 12:16:35 +00:00
Vadim Zeitlin
3c2eea9f92 Clarify wxEVT_SLIDER event handler argument type in the documentation.
Unlike all other events generated by wxSlider, this one receives a
wxCommandEvent and not a wxScrollEvent.

Unfortunately @beginEventEmissionTable doesn't handle the case of a class
producing events of different types, perhaps it shouldn't be used at all here.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76719 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-06-17 15:05:52 +00:00
Vadim Zeitlin
5a85e9e98a Document that wxCANCEL_DEFAULT doesn't work in wxOSX/Cocoa.
See #16268.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76646 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-06-01 16:44:22 +00:00
Robin Dunn
8b0f7cb979 Add Get/SetDisabledBitmap methods for msw
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76588 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-05-20 03:16:51 +00:00
Vadim Zeitlin
720b050f41 Fix recursive self-reference in wxRichTextAttr documentation.
Refer to wxTextAttr, not wxRichTextAttr itself.

Closes #16271.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76552 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-05-17 12:28:31 +00:00
Vadim Zeitlin
9d05388454 Minor documentation corrections.
Escape the space after "i.e." (or avoid using it altogether), add missing @ref.

Closes #16235.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76471 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-05-06 18:16:23 +00:00
Vadim Zeitlin
4e61289210 Bring wxMSW wxBitmap::SetBitmapXXX(wxBitmap()) in line with wxGTK.
Remove or reset the corresponding bitmap if the provided one is invalid
instead of asserting, this is what wxGTK does and this behaviour seems to be
more useful.

Also document this behaviour as it's now implemented in both wxMSW and wxGTK.

Closes #13569.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76404 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-04-27 22:38:55 +00:00
Robin Dunn
ff2d1b6dbe Add the CellHighlight getters too.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76332 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-04-14 03:24:49 +00:00
Robin Dunn
358a10a16a Add some missing wxGrid methods
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76330 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-04-14 03:24:27 +00:00
Vadim Zeitlin
9116c0fdfa Document unexpected default wxGraphicsContext interpolation quality.
In 3.0, keep wxINTERPOLATION_GOOD as the default value instead of
wxINTERPOLATION_DEFAULT for compatibility, but at least mention this and warn
about the changes in 3.1.

See #14134.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76304 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-04-08 21:31:32 +00:00
Vadim Zeitlin
de052ac604 Document wxRibbonDisplayMode enum.
See #16133.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76274 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-04-04 15:28:15 +00:00
Vadim Zeitlin
bd2ae0a988 Document Insert() and Prepend() overloads taking wxMenu.
Document these methods in addition to AppendSubMenu().

Closes #16052.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@76090 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-03-07 00:58:17 +00:00
Dimitri Schoolwerth
63501404a5 Added support for wxEVT_COMBOBOX_DROPDOWN and wxEVT_COMBOBOX_CLOSEUP events to wxOSX/Cocoa.
Backport of r75783.

Closes #15762.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75790 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-02-04 16:59:13 +00:00
Robin Dunn
916c5f96f1 Add some of the Draw* methods that have been available in wxPython.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75716 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-27 07:50:41 +00:00
Robin Dunn
1ef5afb429 add SetRGB overload
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75673 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-23 00:16:54 +00:00
Vadim Zeitlin
1612b2f329 wxWindow::SetWindowVariant() does do something under ports other than wxOSX.
Document that this function adjusts the window font size under non-OS X
systems and explain why it should still be used instead of changing the font
size directly.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75632 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-16 21:41:21 +00:00
Robin Dunn
14f0fe8ea9 Add missing GetControl and SetControl methods
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75623 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-14 05:35:42 +00:00
Robin Dunn
7f3cd4d682 add missing GetVeto method
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75622 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-14 05:35:33 +00:00
Vadim Zeitlin
eaa854bc8a Document incompatible change to wxWindow::FindWindow() in 3.0.
We now skip the TLW children in this method, see r74721.

Also explicitly mention that TLW "children" are not searched by this function
in the documentation.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75607 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-13 13:38:05 +00:00
Robin Dunn
fe2ded6292 Add doc for wxFlexGridSizer::GetRowHeights and GetColWidths
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75578 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-10 05:14:12 +00:00
Robin Dunn
66b03f12eb Add missing wxMenuItem methods
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75466 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-12-29 03:37:10 +00:00
Robin Dunn
81a891c036 Slight tweaks for the wxWebKitCtrl doc.
Remove inline function bodies.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75465 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-12-29 03:37:01 +00:00