Commit Graph

79 Commits

Author SHA1 Message Date
Vadim Zeitlin
83396e54b5 Extend and improve wxSizer::SetSizeHints() documentation
Notably explicitly mention that the parameter of this method does not
need to be the window using this sizer.
2021-07-24 17:21:39 +01:00
Vadim Zeitlin
1d6c740f3b Disable sizer flag checks if WXSUPPRESS_SIZER_FLAGS_CHECK is set
This provides a less intrusive, and also usable by the end users rather
than only by the developers, way of doing the same thing as the just
added wxSizerFlags::DisableConsistencyChecks() does.
2021-05-20 13:27:08 +01:00
Vadim Zeitlin
2e289d7231 Add wxSizerFlags::DisableConsistencyChecks()
This allows to (hopefully temporarily) disable size flag check asserts.
2021-05-20 13:27:06 +01:00
Ian McInerney
6c9f9af7fc Minor updates to the wxSizer docs
Don't mention inexistent "recursive" parameter of GetItem() overload not
taking it.

Closes https://github.com/wxWidgets/wxWidgets/pull/2302
2021-04-04 14:17:41 +02:00
Blake Madden
28d705424b Fix double words and article mismatches in docs. 2021-03-10 14:28:20 -05:00
Vadim Zeitlin
3c92573dd7 Recommend using wxStaticBox as parent more strongly
Not doing it, i.e. creating the window inside the static box as its
siblings, rather than children, may appear to work, but actually doesn't
always do it, for example the windows are not shown correctly when using
RTL locale.

Closes #19086.
2021-03-05 22:53:27 +01:00
Vadim Zeitlin
9130f8bfc6 Don't change orthogonal alignment in wxSizerFlags::CenterXXX()
It was unexpected that using wxSizerFlags().Right().CentreVertical()
didn't right-align the item because CentreVertical() reset the alignment
in the horizontal direction rather than just setting it in the vertical
one, so change this, document the new behaviour explicitly and add a new
unit test checking for it.

Closes #18989.
2021-01-25 12:58:04 +01:00
Vadim Zeitlin
f259f4152b Merge branch 'safer-sizers'
Improvements to the safety of wxSizer API.

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

Closes #18611.
2020-07-06 17:54:46 +02:00
Vadim Zeitlin
65d890f33e Document important requirements of wxSizerItem::AssignWindow()
Failure to call SetContainingSizer() on the window passed to it can have
catastrophic consequences, so make sure to document the need to do it.
2020-07-05 23:28:28 +02:00
Tobias Taschner
1666f58bc6 Change documentation references from OS X to macOS (#1927)
Since OS X 10.12 it has been named macOS so it makes sense
to reference it in documentation as such, even when it
sometimes refers to older versions which were called (Mac) OS X.
2020-07-04 22:08:24 +02:00
Vadim Zeitlin
de2fba540b Document wxSizer::RecalcSizes() and RepositionChildren() better
Mention that RecalcSizes() shouldn't be called any more, after the
changes of 622deec262 (Replace wxSizer::RecalcSizes() with
RepositionChildren(), 2015-10-11), and that RepositionChildren()
replacing it shouldn't be directly called neither.
2020-06-08 13:26:59 +02:00
Vadim Zeitlin
cbe21c0cc9 Recommend SetMinSize() instead of wxSizerItem::SetInitSize()
It's not really clear why do we have this function at all, but
SetMinSize() name is more clear and consistent with wxWindow, so prefer
using it instead.
2020-06-02 18:33:57 +02:00
Ian McInerney
68561ecea8 Minor doc fixes for wxSizerItem methods
Fix typo in GetRatio() documentation and add documentation for
SetInitSize().

Closes https://github.com/wxWidgets/wxWidgets/pull/1882
2020-06-02 18:33:02 +02:00
Maarten Bent
918e102533 Support DPI change in sizers
Return the size of DoGetDefaultBorderInPx as float, so no precision is lost
when multiplying it for DoubleBorder and TripleBorder.

Closes #18551.
2019-11-01 21:07:15 +01:00
Robin Dunn
c30eb8f2ff Add missing and fix broken interface items for wxPython 2019-05-23 21:26:14 -07:00
Vadim Zeitlin
8fbca5cb70 Remove all trailing spaces
No real changes, just clean up sources by removing trailing spaces from
all the non-generated files.

This should hopefully avoid future commits mixing significant changes
with insignificant whitespace ones.
2019-01-30 17:35:54 +01:00
Vadim Zeitlin
c9b240e893 Try to better explain what wxFIXED_MINSIZE does
Don't mention the non-existent GetAdjustedBestSize() function and do
explain what setting wxFIXED_MINSIZE achieves and how it can be done
without it.

Closes #18315.
2018-12-30 15:40:00 +01:00
Vadim Zeitlin
622deec262 Replace wxSizer::RecalcSizes() with RepositionChildren()
The new method takes minimal size just computed by RecalcSizes() as its
argument making it unnecessary to store it as a member variable in the derived
classes such as wx{Box,FlexGrid}Sizer.

The old method can still be overridden for compatibility and by the derived
class that don't need minimal size when updating children.
2018-12-20 23:36:51 +01:00
Robin Dunn
c40f782fae Fix typo 2016-10-21 16:54:28 -07:00
Tobias Taschner
baa47dc435 Drop Mac prefix on remaining instances of OS X in docs.
This should have been part of df33c0c491 but somehow where missed.
2016-02-23 13:05:44 +01:00
Vadim Zeitlin
af01ef1bb0 Make default wxSizer border DPI-aware.
Scale the (still hard-coded) border in pixels by the content scale factor for
the platforms where this needs to be done, i.e. not wxGTK nor wxOSX where the
underlying toolkit already does it.
2015-04-23 19:18:10 +02:00
Vadim Zeitlin
9aaa38c7c8 Make it possible to combine wxEXPAND and alignment in wxGridSizer.
Allow overriding wxEXPAND effect in one of the directions by specifying
wxALIGN_{RIGHT,BOTTOM} or wxALIGN_CENTRE_{HORIZONTAL,VERTICAL} together with
it (unfortunately this doesn't work for wxALIGN_{LEFT,TOP} as their value is 0
and so their presence in flags can't be detected).
2015-04-08 23:35:19 +02:00
Vadim Zeitlin
233a7fe77b Add wxSizerFlags::Cent{er,re}{Vertical,Horizontal}().
Provide CentreVertical() and CentreHorizontal() methods in wxSizerFlags which
are useful for 2D sizers (for 1D ones just Centre() can be used anyhow).
2015-04-08 23:35:19 +02:00
Robin Dunn
a7288e4179 Add doc for wxFlexGridSizer::GetRowHeights and GetColWidths
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@75579 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-01-10 05:15:46 +00:00
Vadim Zeitlin
be1c0bc6ba Mention that wxSizer::Clear() always deletes child sizers.
The existence of "delete_windows" argument could mislead people into thinking
that sizers were not deleted neither when it had false value, see #15475.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74809 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-09-15 00:14:46 +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
dec0a353ff Fix missing or broken interface items for Phoenix
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73300 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-12-29 02:32:16 +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
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
Robin Dunn
e6273b919b Interface fixes for Phoenix.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72013 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-07-11 04:23:58 +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
f090e4ef67 No real changes, just fix spelling errors in the documentation.
Closes #14038.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70673 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-23 13:56:10 +00:00
Robin Dunn
5eb16fe200 Use default values for some parameters of wxSizerItem and wxGBSizerItem ctors
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69970 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-12-10 04:34:06 +00:00
Robin Dunn
7106fc4674 Fix missing or broken interface items for Phoenix
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69644 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-11-02 20:22:29 +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
Robin Dunn
8ff9b17d57 Fix some broken or add some missing interface declarations for Phoenix
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@68973 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-09-03 01:39:02 +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
df7d641d63 Explain wxSizer::SetVirtualSizeHints() deprecation.
Tell people that FitInside() should be used instead.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66884 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-02-14 11:59:13 +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
Robert Roebling
0e92a846e4 Don't use grouping of different methods as this creates confusing output
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63694 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-03-16 19:13:36 +00:00
Vadim Zeitlin
61503542be More wx(Flex)GridSizer constructors documentation improvements.
Mention that the number of columns may also be automatically deduced.

Don't duplicate the same documentation in wxGridSizer and wxFlexGridSizer as
this inevitably results in forgetting to update one of the versions (as in the
previous commit). Instead, just link to wxGridSizer from wxFlexGridSizer.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63157 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-01-14 22:51:04 +00:00
Vadim Zeitlin
b4c1fe36b9 Minor corrections to wxFlexGridSizer ctor documentation.
Be more clear about what does it mean to specify the number of rows. Don't use
@code for inline expressions. Remove an extraneous "it".

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63156 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-01-14 22:43:23 +00:00
Vadim Zeitlin
16e40259d6 Document wxSizerItem::Assign{Window,Sizer,Spacer}() methods.
Also explain why SetSpacer() and SetSizer() are deprecated.

Closes #11555.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62944 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-12-19 12:00:04 +00:00
Robert Roebling
d7bb29260e Revert wxFlexGridSizer constr. change
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62659 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-11-15 09:40:30 +00:00
Robert Roebling
7aab7176f1 Restore ability to create wxFlexGridSizer with 2 params (number of columns and vertical gap)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62651 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-11-14 21:50:50 +00:00
Vadim Zeitlin
1a2df6a75b Change wxBoxSizer::AddSpacer() to only add space in sizer direction.
It used to add a spacer with the given size in both directions but this was
counter-intuitive and wasn't expected even by the original author of this code
so change it to behave more reasonably.

Closes #11197.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61939 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-09-15 17:05:32 +00:00
Vadim Zeitlin
0274a7973d Added wxGridSize::GetEffective{Cols,Rows}Count().
These functions return the number of columns or rows being currently used and
not 0, unlike the existing Get{Cols,Rows}(), if the corresponding number is
determined dynamically.

Closes #10254.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61750 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-08-23 22:24:48 +00:00
Vadim Zeitlin
58c69c44d0 Reorganize and improve wxSizer::SetItemMinSize() documentation.
Closes #11093.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61638 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-08-10 11:18:45 +00:00
Vadim Zeitlin
f81114dcd7 Correct wxSizer::InsertSpacer() description.
Closes #11092.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61637 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-08-10 11:18:38 +00:00
Vadim Zeitlin
4a00e77ce6 Update wxFlexGridSizer ctors to match (new) wxGridSizer ones.
Confusing wxFlexGridSizer(int cols, int vgap = 0, int hgap = 0) was removed as
well as corresponding wxGridSizer ctor overload. New ctor overloads taking gap
as wxSize were added.

See #11040.

Closes #11091.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61635 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-08-10 11:18:23 +00:00