Commit Graph

101 Commits

Author SHA1 Message Date
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
Vadim Zeitlin
013b02092f Mention that wxNotebook page must be removed before reparenting it.
At least in wxGTK it is necessary to remove the page from the notebook first
as reparenting it doesn't work otherwise currently.

This should ideally be fixed but in the meanwhile at least document it.

See #13305.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@68214 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-07-09 23:37:09 +00:00
Dimitri Schoolwerth
d13b34d3f2 No code changes, fixed various typos.
Applied patch by snowleopard2 fixing typos in interface/. Extended the fixes throughout trunk.

Closes #13076.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67384 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-04-03 20:31:32 +00:00
Dimitri Schoolwerth
4c51a665c6 Fixed various typos.
Applied patch by snowleopard2 fixing a bunch of typos such as misspellings and double words in the documentation. Combined the patch with some local queued typos waiting to be committed as well as adding new typo fixes inspired by the patch.

Function names with American spelling were not changed nor was third-party code touched. The only code changes involve some changes in strings that are translated ("Can not" -> "Cannot").

Closes #13063 (again).

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67280 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-03-22 14:17:38 +00:00
Vadim Zeitlin
ff45048665 Document EVT_CHAR_HOOK.
Explain that it is sent to the active TLW and not the focus window and that
handling it suppresses all the normal keyboard events.

Mention that it is not generated by wxOSX/Cocoa currently, see #12431.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67190 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-03-14 11:54:55 +00:00
Robin Dunn
05b0355af8 Fix various missing or broken stuff needed for Project Phoenix
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66474 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-12-27 20:47:12 +00:00
Vadim Zeitlin
51b729af92 Add default value for GetPopupMenuSelectionFromUser() position argument.
Let the menu be popped up at the system-determined position, just as it can
already be done with PopupMenu() itself.

Closes #12530.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65692 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-09-30 14:33:53 +00:00
Vadim Zeitlin
a183ec7094 Improve EVT_SHOW documentation.
Mention that it applies to the TLWs only and explain when it is generated (and
not generated).

Closes #12353.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65316 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-08-15 21:14:11 +00:00
Francesco Montorsi
9b756edd0d mention wxSystemSettings::GetColour() in wxWindow::SetBackgroundColour() docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65115 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-27 09:21:22 +00:00
Vadim Zeitlin
526954c596 Globally use "wxWindows licence" consistently.
Use "wxWindows licence" and not "wxWidgets licence" (the latter doesn't
exist) and consistently spell "licence" using British spelling.

See #12165.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64940 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-13 13:29:13 +00:00
Vadim Zeitlin
d9c83ba829 Document that wxWindow::FindWindowByXXX() functions may return NULL.
This seems obvious but apparently isn't completely so to everybody.

Closes #12074.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64352 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-05-19 21:03:49 +00:00
Vadim Zeitlin
f6b4a1b98d Don't use wxWindow::ClearBackground() in the image sample and explain why.
Painting on both wxPaintDC and wxClientDC simultaneously doesn't work well,
e.g. under Windows the client DC can be actually erased after we finished
painting the window contents, overwriting it.

Simply use wxDC::Clear() instead of wxWindow::ClearBackground() to avoid this
and document the danger of using ClearBackground() from EVT_PAINT handler.

Closes #10700.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64277 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-05-10 21:02:30 +00:00
Vadim Zeitlin
512220b67b Replace public wxEvtHandler::ProcessEventHere() with private TryHere().
ProcessEventHere() doesn't have to be public any more now that we have
ProcessEventLocally() which is safe to call from the outside (i.e. doesn't
forget about the chained event handlers and validators).

Still keep this function because it makes the code more modular and also
because we might want to make it virtual for consistency with TryBefore() and
TryAfter() later. Also rename it to TryHere() to make the symmetry with these
functions more manifest.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64264 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-05-09 14:55:46 +00:00
Vadim Zeitlin
396e9eb8e2 Add wxWindow::ProcessWindowEventLocally() and use it in wxMSW MDI code.
Add ProcessWindowEventLocally() which wraps ProcessEventLocally() in the same
way as ProcessWindowEvent() wraps ProcessEvent(). I.e. it allows to process
the event in this window only, without propagating it upwards, but taking into
account any event handlers associated with it.

Use the new method in wxMDIParentFrame code in wxMSW to ensure that event
handlers pushed on MDI children frames are taken into account. Add a test for
this to the MDI sample.

Closes #11225.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64262 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-05-09 14:55:33 +00:00
Vadim Zeitlin
4582ed9478 Clarify that Raise() is only a request to raise the window.
Calling Raise() doesn't guarantee that the window will be raised.

Closes #11974.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64099 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-04-22 11:20:45 +00:00
Vadim Zeitlin
75504144d2 Minor corrections to the documentations.
Use the correct "override" instead of "overload". Remove unnecessary "virtual"
keyword occurrences.

Closes #11949.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63998 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-04-16 12:47:31 +00:00
Vadim Zeitlin
e439048875 Document wxWindow::DoCentre() and wxCENTRE_ON_SCREEN flag.
See #11949.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63996 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-04-16 12:47:21 +00:00
Václav Slavík
0e7f59ab29 Make ConvertPixelsToDialog() and ConvertDialogToPixels() const.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63193 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-01-19 17:53:29 +00:00
Vadim Zeitlin
ccd4e1bc1e Minor fixes and enhancements to wxWindowID documentation.
Document NewControlId() more precisely. Fix various spelling and grammar
problems.

Closes #11613.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63103 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-01-09 17:39:45 +00:00
Vadim Zeitlin
464c1f9467 Add or fix descriptions of return values from SetFont/XXXColour().
Add the same kind of description to SetBackground/ForegroundColour() as in
SetFont() and fix typo in the latter.

Closes #11352.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62462 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-10-21 09:44:07 +00:00
Mattia Barbon
1058f65203 Copy wxPerl notes from the LaTeX documentation.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62451 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-10-18 17:47:01 +00:00