Commit Graph

121 Commits

Author SHA1 Message Date
Vadim Zeitlin
5ffb8de44d Mention that wxOSX doesn't implement SetLayoutDirection()
At least avoid wasting people time with debugging why it doesn't work.
2016-11-17 02:02:06 +01:00
Vadim Zeitlin
1c4e20d870 Fix documentation of {From,To}DIP() overloads taking int
They were mistakenly using wxSize (already documented just above).
2016-08-09 01:10:24 +02:00
Paul Kulchenko
25520cbb80 Don't use wxWindowBase in the interface headers
This class is an implementation detail, only wxWindow is public and there are
never objects of wxWindowBase (but not wxWindow) class in wxWidgets programs.

Closes https://github.com/wxWidgets/wxWidgets/pull/279
2016-05-05 02:59:43 +02:00
Vadim Zeitlin
80664c28c8 Discourage the use of wxTAB_TRAVERSAL in the documentation
This style should almost never be used in the application code, it's mostly an
implementation detail (but not quite as it might make sense to turn it off for
some wxPanel, at least in theory).
2016-03-03 23:43:46 +01:00
Vadim Zeitlin
d50abc2d3e Make wxWS_EX_VALIDATE_RECURSIVELY default (and only) behaviour
In practice, almost everybody using validators also seems to use this style,
so make it the default (this hadn't been done when it was originally
introduced because of compatibility concerns, but now, 15+ years later, it's
probably safe enough to change this).
2016-02-09 23:38:23 +01:00
Tobias Taschner
5ba67c67e4 Remove wxOSX/Carbon support.
Cocoa has been the default toolkit in wxWidgets for a long time. There is really no good reason to use Carbon in 2016 and this removes a lot of unused and unmaintained code.
2016-02-01 13:48:48 +01:00
Steve Browne
1af2cdd200 Updated interface file to document wxWindow::ToDIP. 2015-11-24 13:16:20 -05:00
Tobias Taschner
09b23156f5 Remove outdated documentation remarks on Windows prior XP.
Since Windows XP is now the minimum supported target all remarks referencing differences in Windows versions prior XP have been removed or updated.
2015-09-27 19:07:20 +02:00
Vadim Zeitlin
949d2eeaa5 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.
2015-08-02 19:51:57 +02:00
Dimitri Schoolwerth
31145b8e3a Fix some typos, no code changes (besides strings) 2015-06-05 02:54:46 +04:00
Vadim Zeitlin
1c63ec5564 Don't scale the value(s) of -1 in wxWindow::FromDIP().
Using FromDIP() in wxXRC broke creating controls whose width or height was
specified as -1 as it became -2 when sufficiently high DPI was used, and so
lost the special meaning of "unspecified" that -1 had.

Avoid this problem by never scaling -1 in FromDIP(), this is unlikely to ever
be useful and could result in more difficult to debug problems in the future.
2015-05-16 16:03:22 +02:00
Vadim Zeitlin
100d2a5819 Make wxWindow::FromDIP() more flexible and easier to use.
Allow calling this method with either wxSize, wxPoint or just an int.

Also provide a static overload allowing to use it even when no appropriate
wxWindow is available.
2015-04-23 02:20:02 +02:00
Vadim Zeitlin
ad92074535 Update RegisterHotKey() documentation to mention OS X support.
This function is implemented in wxOSX too, not just wxMSW.

See #12354.
2015-04-08 11:56:51 +02:00
Vadim Zeitlin
00748bbaef Add wxWindow::FromDIP() for simpler high DPI support.
This method allows to scale a pixel value by a DPI-dependent factor to the
value used by the underlying toolkit only if necessary, i.e. when not using
GTK+ 3 or OS X which already do this internally.
2015-03-20 00:08:37 +01:00
Vadim Zeitlin
bc492a9e6e Make wxWindow::GetContentScaleFactor() useful for non-OSX platforms.
Return the ration of the current DPI to the standard one to allow using this
function to scale pixel values for the current screen resolution.
2015-03-20 00:08:37 +01:00
Vadim Zeitlin
82051979e7 Fix typo in wxWindow::SetBackgroundStyle() documentation.
s/on order/in order/
2015-02-24 12:32:22 +01:00
Dimitri Schoolwerth
0e6af4ac39 No code changes, fix some typos.
Change several occurrences of "it's" where "its" is meant, as well as a few other minor typos.



git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@78497 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2015-02-15 17:11:44 +00:00
Vadim Zeitlin
a193a6786d Escape space after "e.g." or "i.e." in the manual.
This fixes formatting of the Doxygen-generated docs (maybe we should just
switch to the civilized spelling of "eg" and "ie" instead?).

See #16744.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@78308 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-12-24 13:57:05 +00:00
Vadim Zeitlin
47e8f3e50d Don't use "@overload" to document methods without parameters.
Documentation generated by @overload is misleading in this case as it refers
to the "different argument [the function] accepts", but there are none, the
methods can be overloaded only by const modifier as well.

Use \copydetails instead to reuse the original documentation, this is less
confusing and arguably more useful as well.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@78078 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-10-27 20:09:55 +00:00
Vadim Zeitlin
b49d49435d Document wxWindow::HitTest().
This is not a very useful method, but by providing at least some documentation
for it, we prevent it from inheriting the docs for the next method, which have
nothing to do with it.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@77751 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-09-20 22:12:20 +00:00
Vadim Zeitlin
d11aa4c790 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/trunk@75635 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-16 21:45:00 +00:00
Vadim Zeitlin
a185067a47 Document wxWindow::FindWindow() TLW skipping behaviour.
Explicitly mention that TLW "children" are not searched by this function
(which is the case since r74721).

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@75608 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-13 13:38:34 +00:00
Vadim Zeitlin
cc888915ac Clarify wxGetTopLevelParent() behaviour for TLWs.
It doesn't return the parent of a TLW but TLW itself. Whether this is a good
idea or bad one, this is how it works since a very long time and we don't want
to change it any more.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@75357 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-12-07 11:59:00 +00:00
Vadim Zeitlin
d4a5973900 Fix wxWindow::SetSizeHints() documentation.
Add the missing @overload.

Closes #15707.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@75299 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-11-26 23:31:37 +00:00
Vadim Zeitlin
3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00
Robin Dunn
6481f4ab4c GetMagnificationFactor --> GetContentScaleFactor
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74260 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-06-20 01:02:49 +00:00
Robin Dunn
6b3b86fe4e Add flags for SendSizeEvent
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74259 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-06-20 01:02:20 +00:00
Robin Dunn
96691fcaed Document wxWindow::GetMagnificationFactor
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74258 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-06-20 01:01:51 +00:00
Vadim Zeitlin
1a986642f5 Add wxWindow::BeginRepositioningChildren() and EndRepositioningChildren().
This is just a refactoring of wxMSW code to make it possible to use deferred
window positioning from other places in subsequent commits.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74066 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-05-31 23:21:03 +00:00
Vadim Zeitlin
84c6c2121b Document wxWindow::Get{Min,Max}{Width,Height}().
These methods were not documented and somehow inherited the description of the
first method of the group they were in, which didn't make any sense for them.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73149 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-12-08 13:22:28 +00:00
Vadim Zeitlin
0824e36969 Fix premature truncation of brief descriptions in Doxygen comments.
Don't end the brief description at the first period if it's a period which is
part of "i.e." or "e.g.": escape the space following it to prevent Doxygen
from recognizing it as an end of sentence.

See #14866.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73084 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-12-01 00:14:07 +00:00
Vadim Zeitlin
b9fc07ba8b Document that HasFocus() is new in 2.9.
Closes #14740.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72670 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-10-13 22:54:32 +00:00
Vadim Zeitlin
705c834b75 Mention InvalidateBestSize() in DoGetBestClientSize() documentation.
It is not obvious that it needs to be called when the best size changes, so
give at least a hint.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72652 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-10-10 18:47:19 +00:00
Vadim Zeitlin
5eea1681a6 Document wxWindow InheritsBackgroundColour() and UseBgCol() methods.
These functions were present in the interface header but didn't have their own
documentation and somehow inherited the documentation of the first function in
the same section which didn't make any sense for them. Do document them now.

Closes #14607.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72439 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-09-09 00:42:31 +00:00
Vadim Zeitlin
054fdb68eb Honour window min and max sizes in wxWindow::GetBestSize().
The best size of the window should be at least as large as its min size and
less than its max size. This allows to override the windows own best size
determination with an explicit SetMinSize() or SetMaxSize() call.

See #11497.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72343 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-08-15 23:34:18 +00:00
Robin Dunn
0c3140ca44 Interface fixes for Phoenix
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72330 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-08-14 05:11:59 +00:00
Václav Slavík
958eb28b3f Fix typo introduced in r72167.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72168 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-07-22 10:07:40 +00:00
Václav Slavík
bf12aaa589 Document wxWindow::Close() return value.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72167 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-07-22 09:21:34 +00:00
Robin Dunn
89eeba548c Add wxSHOW_EFFECT_MAX
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72087 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-07-14 21:36:44 +00:00
Vadim Zeitlin
d119983947 Add wxWindow::GetBest{Height,Width}().
These functions will be used when it is necessary to determine the best size
of the control if one of its size components is fixed. Currently none of the
classes implements DoGetBestClient{Height,Width}() yet but wxListCtrl will do
it soon, see #13898.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71392 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-05-09 14:24:37 +00:00
Vadim Zeitlin
386279c3f2 Improve wxWindow best size documentation, mention DoGetBestClientSize().
Custom classes should typically override DoGetBestClientSize() instead of
DoGetBestSize() to avoid having to deal with the borders.

Also don't reference the deprecated SetInitialBestSize() unnecessarily and
document its non-deprecated replacement.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71391 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-05-09 14:24:34 +00:00
Robin Dunn
b83b7724da Document SetDoubleBuffered
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71241 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-20 05:41:39 +00:00
Robin Dunn
e5e10e234e Remove the wxPython-only doc snippets from the C++ docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71170 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-10 03:27:44 +00:00
Vadim Zeitlin
8b2f64c6c1 Added wxWindow::IsDescendant() helper.
This function checks if another window is a direct or indirect child of this
one, which can be needed in a number of situations.

See #3063.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71024 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-03-27 11:58:02 +00:00
Vadim Zeitlin
e94f303173 Deprecate wxWindow::MakeModal().
Using this function was never the right way to show a modal window and it
didn't really work correctly. Instead of futilely trying to fix it, just
deprecate it.

Closes #1561.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70838 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-03-07 23:50:21 +00:00
Vadim Zeitlin
1995d517d7 Use Doxygen comments for wxVisualAttributes members.
Fix documentation of wxVisualAttributes by simply turning the normal comments
into Doxygen ones.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70683 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-25 15:03:23 +00:00
Vadim Zeitlin
1442168125 Implement wxBG_STYLE_TRANSPARENT support for wxGTK.
Use composited windows if supported by GTK+ for wxWindows with this background
style.

Also add wxWindow::IsTransparentBackgroundSupported() and show how to use it
in the sample.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70569 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-11 16:26:52 +00:00
Vadim Zeitlin
bd362275b8 Remove Palm OS port.
The platform targeted by this port doesn't exist any more and the port never
achieved really working state so remove the code to avoid having to maintain
it.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70345 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-01-15 01:05:28 +00:00
Vadim Zeitlin
bf79972894 Document that setting colours for native controls might not work.
Changing colours of the native controls can't be relied on.

See #13745.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69986 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-12-11 23:51:14 +00:00
Robin Dunn
86381d4297 Fix missing and broken interface items for Phoenix
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69051 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-09-11 00:35:32 +00:00