Commit Graph

157 Commits

Author SHA1 Message Date
Artur Wieczorek
b078e348b7 Fix minor typo in wxPGProperty documentation 2016-08-09 20:56:27 +02:00
Artur Wieczorek
cf033b47b1 Editorial corrections to the documentation.
Added section to group similar functions in the documentation of wxGraphicsContext.
Fixed references to the section describing wxPGProperty attributes.
2016-07-24 21:08:54 +02:00
Artur Wieczorek
cd96c664dd Updated documentation for some wxPropertyGrid classes.
Updated documentation for wxPGEditor, wxPropertyGridPage, wxPropertyGridManager, wx*Property classes.
Removed doxygen-style comments from header files.
2016-07-23 23:38:39 +02:00
Artur Wieczorek
c910085507 Update documentation of some flags used by wxPropertyGridInterface methods. 2016-07-08 19:49:03 +02:00
Artur Wieczorek
4f1e3b7172 Fixed setting colours of wxPGProperty
When wxPGProperty's text or background colours are modified with dedicated wxPropertyGridInterface utility functions (SetPropertyBackgroundColour, SetPropertyTextColour, SetPropertyColoursToDefault) then it is enough to redraw the property with new colours because its internal state remains unmodified and full refreshing is not necessary.

Closes #17588
2016-07-08 19:44:32 +02:00
Artur Wieczorek
7968f37883 Updated documentation of some wxPropertyGrid-related classes.
Updated wxPropertyGridPageState, wxPropertyGridHitTestResult, wxPropertyGridIterator,  documentation.
2016-07-02 23:20:11 +02:00
Artur Wieczorek
2ea7ff3160 Updated documentation for wxPropertyGridInterface.
Updated documentation and removed doxygen-style comments from propgridiface.h header file.
2016-06-25 18:17:57 +02:00
Artur Wieczorek
9bee5e1e2b Updated documentation for several wxPG components.
Updated wxPropertyGrid, wxPropertyGridEvent, wxPropertyGridPopulator documentation and removed doxygen-style comments from propgrid.h header file.
2016-06-23 22:23:03 +02:00
Artur Wieczorek
2ea41cca8d Updated documentation for several wxPG components.
Updated documentation and removed doxygen-style comments from property.h header file.

wxPGPaintData
wxPGProperty
wxPGCell
wxPGAttributeStorage
wxPGChoices
wxPGChoiceEntry
wxPGRootProperty
wxPropertyCategory
2016-06-16 23:55:37 +02:00
Artur Wieczorek
1f696b6110 Updated wxPGDefaultRenderer and wxPGCellRenderer documentation.
Removed doxygen-style comments from the header file, too.

Closes #14788
2016-06-13 18:40:42 +02:00
Artur Wieczorek
9de3f8395c Updated wxPGEditor interface documentation
Editor controls are no longer bound to the fixed ID's wxPG_SUBID1 and wxPG_SUBID2.
2016-06-01 18:52:06 +02:00
Vadim Zeitlin
ba5a0a3878 Fix more typos in comments and wxFAIL messages
Closes https://github.com/wxWidgets/wxWidgets/pull/270
2016-04-14 16:08:28 +02:00
Vadim Zeitlin
f163d4c2ac Remove non existing wxPG_COMPACTOR style from documentation.
No idea what was it supposed to do, but this style doesn't exist and never did
in the version included in wxWidgets, so simply remove it.

Closes #16264.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76526 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-05-14 12:21:04 +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
Vadim Zeitlin
ce7fe42e84 Provide shorter synonyms for wxEVT_XXX constants.
Use the same short names as are used by the event table macros for the event
type constants themselves. This makes them much more comfortable to use, e.g.
Bind(wxEVT_BUTTON) compared to Bind(wxEVT_COMMAND_BUTTON_CLICKED).

The old long names are still kept for backwards compatibility and shouldn't be
removed as it doesn't really cost anything to continue providing them, but all
new event types should only use the short versions.

Closes #10661.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73850 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-04-25 10:11:03 +00:00
Bryan Petty
ce15461608 Fixed appearance images to use Doxygen @image command (Doxygen will now copy files automatically), and cleaned up some more overviews.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72871 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-11-03 18:32:50 +00:00
Vadim Zeitlin
d6cf9064d4 Remove left over conflict markers from documentation.
Closes #14404.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71787 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-06-15 23:23:20 +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
Julian Smart
216b59c66a Added wxPropertyGridManager::SetPageSplitterLeft
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70937 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-03-18 20:35:01 +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
Vadim Zeitlin
8cddee2d0e Fix spelling in the documentation.
Closes #14034.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70668 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-22 13:41:07 +00:00
Vadim Zeitlin
67414f005d Synchronize wxPropertyGridManager documentation with the real API.
Fix GetSelection() return type; remove SetStringSelection() which doesn't seem
to exist any more; other minor fixes.

Closes #13996.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70639 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:06 +00:00
Vadim Zeitlin
5aabd64cf2 Synchronize wxPropertyGrid documentation with the real API.
Document DoRegisterEditorClass() (even though it's not really clear whether it
should be documented); remove the inexistent SetButtonShortcut() documentation
and other minor fixes.

Closes #13995.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70638 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:03 +00:00
Vadim Zeitlin
9e610e1caf Remove non-existent wxPGChoices methods from the documentation.
wxPGProperty::Add(wxArrayString, ValArrItem), GetItemAtY() and HasValue() were
documented but don't actually exist, remove them.

Also correct wxPGProperty::Empty() scope: it's protected and not public.

Closes #13988.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70607 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:40:10 +00:00
Vadim Zeitlin
2d5409f936 Add a property to configure file property dialog kind.
Add wxPG_FILE_DIALOG_STYLE allowing to pass wxFileDialog style that should be
used by the given wxFileProperty. This notably allows to have file properties
accepting not yet existing files, as is needed when using them for the file
names to be saved, not opened.

Closes #13894.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70449 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-01-23 13:59:52 +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
Bryan Petty
57ab6f2314 Extensive documentation typo patch (closes #13063).
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67279 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-03-22 14:08:30 +00:00
Steve Lamerton
3a194bda7b Add missing code tag before lots of wxEventTypes in the documentation. Although most of the documentation did this quite a few were missing.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66611 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-01-06 19:52:14 +00:00
Jaakko Salli
6f3f38980f Added 'HasAlpha' attribute for wxColourProperty. Setting it to true allows user to edit the alpha component.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66520 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-01-02 10:14:29 +00:00
Jaakko Salli
abbd88b52b Added wxPG_ACTION_EDIT, which allows specifying custom key to move focus to the property editor. Also documented wxPG_ACTION_FOOs better.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66432 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-12-22 17:25:45 +00:00
Jaakko Salli
25199f9859 Document how the sign is omitted from wxFloatProperty's displayed value when it is effectively zero (closes #12738).
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66384 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-12-16 16:12:55 +00:00
Jaakko Salli
2e2e62def1 Have wxPropertyGrid inherit from wxControl and wxScrollHelper instead of wxScrolledWindow. This is the approach other scrolled controls use.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65628 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-09-24 14:47:20 +00:00
Jaakko Salli
aae9e5bd56 Changed wxArrayStringProperty default delimiter to comma. It should allow for better looking and more easily editable property values for common cases.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65424 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-08-26 13:51:45 +00:00
Jaakko Salli
6c78066f22 Moved wxPGProperty::SetFlag() to protected API since it does not have any side-effects that are usually desired in the user code. Added wxPGProperty::SetAutoUnspecified() since wxPG_PROP_AUTO_UNSPECIFIED can no longer be set (conveniently) with SetFlag().
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65218 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-08-08 12:22:08 +00:00
Jaakko Salli
9ceed261f8 Added wxPGProperty::Enable() for conveniency. Refactored related code and improved related documentation.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65216 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-08-08 11:41:20 +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
Jaakko Salli
525b29124a Added 'Delimiter' attribute for wxArrayStringProperty. Moved static ArrayStringToString() to wxArrayStringProperty.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64894 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-11 17:04:23 +00:00
Jaakko Salli
4fb5dadb13 Changed wxPropertyGrid default property validation failure behavior to more user-friendly wxPG_VFB_MARK_CELL | wxPG_VFB_SHOW_MESSAGEBOX
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64808 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-04 08:53:07 +00:00
Jaakko Salli
0ea0604a1e Added new wxPropertyGrid property validation failure flags wxPG_VFB_SHOW_MESSAGEBOX and wxPG_VFB_SHOW_MESSAGE_ON_STATUSBAR, which allow defining the default message display behavior more accurately
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64805 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-04 08:22:52 +00:00
Jaakko Salli
2d8d109b6c Eliminated lingering validation failure message on the status bar. Added wxPropertyGrid virtual member functions DoHidePropertyError() and GetStatusBar().
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64796 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-03 12:22:58 +00:00
Jaakko Salli
863d1ce7c2 Documented pythonic iterators
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64576 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-06-13 08:46:30 +00:00
Jaakko Salli
8d2c70414c Added wxPropertyGrid::DedicateKey(), which prevents specific key presses from being eaten by editor controls. This is useful for customizing keyboard navigation. Also added utility function wxPGFindInVector<>(), which is used in the new code, and also in some other places.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64562 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-06-12 09:30:57 +00:00
Francesco Montorsi
b19b28c8fc Implement wx-prefixed macros versions of DECLARE/IMPLEMENT*CLASS macros.
Implement compatibility aliases for non-prefixed macro names.
Require a final semicolon where possible.
Correct a recurring error in the docs: IMPLEMENT/DECLARE_CLASS are alias to the DYNAMIC macros, not to the ABSTRACT macros.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64532 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-06-09 13:55:48 +00:00
Francesco Montorsi
d86f721af3 Fix various doxygen warnings
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63713 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-03-19 22:35:30 +00:00
Jaakko Salli
28756ab9c5 Clarify documentation for wxPropertyGridEvent::GetProperty()
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63711 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-03-18 17:12:40 +00:00
Jaakko Salli
6cf5edea27 Use explicit wxPGPropertyFlags enum type with wxPGProperty::SetFlag() and similar member functions (thus preventing use of incorrect set of flags). Also now document wxPGProperty flags.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63700 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-03-17 18:17:19 +00:00
Jaakko Salli
26b22ae371 Must clear property selection in wxPGProperty::SetChoices() or risk a crash
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63562 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-02-26 15:45:30 +00:00
Jaakko Salli
f231df8aa8 Property removal and deletion done from wxPropertyGrid event handler is now postponed to idle event
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63534 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-02-22 16:44:56 +00:00
Jaakko Salli
76733d4cae Fixed auto-resizing behavior when double-clicking a splitter; Added wxPropertyGrid::ResetColumnSizes(); wxPropertyGrid::GetSplitterPosition() got splitterIndex argument
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63502 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-02-16 16:24:30 +00:00