Commit Graph

2034 Commits

Author SHA1 Message Date
Robin Dunn
54c45be005 Add a bit of docs for the FS Handlers
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70722 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-27 23:51:05 +00:00
Robin Dunn
f115bfec38 Phoenix needs to see the implementation of pure virtuals so it knows that this class is not abstract.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70721 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-27 23:50:59 +00:00
Robin Dunn
fb3b60978f Add missing RemoveHandler
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70720 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-27 23:50:54 +00:00
Robin Dunn
3507d2d43f Add interface declarations for stock file system handlers.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70719 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-27 23:50:49 +00:00
Vadim Zeitlin
27674b66c0 Document more events in wxAuiNotebookEvent documentation.
This is the second part of r70691.

Closes #14040.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70708 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-27 15:26:54 +00:00
Vadim Zeitlin
8b89611217 Document more wxAuiNotebook events.
Add descriptions of several previously undocumented
wxEVT_COMMAND_AUINOTEBOOK_XXX events and the corresponding event table entries.

Closes #14040.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70691 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-25 23:49:49 +00:00
Vadim Zeitlin
fe9b56985f Minor fixes to wxMessageBox() documentation.
Correct the default parameters values.

Closes #14043.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70689 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-25 23:49:42 +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
29a3f6548e No changes, just remove functions bodies from interface docs.
Omit the implementations, even trivial ones, from the documentation.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70682 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-25 15:03:20 +00:00
Vadim Zeitlin
05fbf0e75e Don't use _T() in the documentation.
This is mainly necessary in order to be able to commit the subsequent changes
to this file as otherwise the commit is refused by the svn post-commit hook
that checks for _T() presence.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70681 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-25 15:03:17 +00:00
Julian Smart
12f5219fac Added functionality for disabling the vertical scrollbar.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70676 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-23 17:01:30 +00:00
Vadim Zeitlin
bf973818a3 Remove duplicate wxFileKind definition from documentation.
Also move wxSeekMode from interface/wx/ffile.h to filefn.h to be consistent
with the header in which this enum is really defined. And document it better.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70675 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-23 16:33:13 +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
96b57f0d2a Mention event type corresponding to EVT_CLOSE in wxFrame documentation.
Closes #14030.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70670 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-22 13:41:15 +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
83189c3b0e Correct wxWinCE port name in @onlyfor in the documentation.
The name used here should be the same as the label used for the corresponding
port in docs/doxygen/mainpages/platdetails.h

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70666 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-21 22:02:21 +00:00
Vadim Zeitlin
cb8ae61385 Minor fixes to wxDateTime documentation.
Use @onlyfor{wxmsw} for MSW-specific methods; fix the return type of
operator+=().

Closes #14024.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70655 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:57:13 +00:00
Vadim Zeitlin
a0bf1b587f Remove documentation of inexistent wxEvtHandler::TryThis().
This method existed only briefly and was replaced by Try{Before,After}().

Closes #14012.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70652 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:59 +00:00
Vadim Zeitlin
1e26459c5e Document wxNotificationMessage::Timeout_XXX values.
Closes #14009.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70650 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:52 +00:00
Vadim Zeitlin
c9069ea343 Fix typos in wxRibbonButtonBar documentation.
Closes #14008.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70649 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:46 +00:00
Vadim Zeitlin
5c54f4e9c8 Minor documentation fixes to wxHelpController.
Fix the methods signatures to match the real ones.

Closes #14007.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70648 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:42 +00:00
Vadim Zeitlin
1f165e7432 Add skeleton documentation for wxMessageDialog::ButtonLabel.
This class shouldn't be really used directly but document it just to make the
interface header valid C++ as this class was used as parameter type but never
defined.

Closes #14006.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70647 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:38 +00:00
Vadim Zeitlin
0eb1fbf01b Fix wxRichTextBuffer::InsertParagraphsWithUndo() documentation.
Use the same parameters order as in the real header file.

Closes #14005.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70646 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:34 +00:00
Vadim Zeitlin
184abb52a8 Add @onlyfor tag to wxToolBar::SetBitmapResource() documentation.
Closes #14004.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70645 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:30 +00:00
Vadim Zeitlin
52cd518033 Add @onlyfor tags for Unix-specific wxStandardPaths methods.
Closes #14003.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70644 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:25 +00:00
Vadim Zeitlin
f85d2074fb Add @onlyfor tag for wxSound::IsPlaying() documentation.
This is not totally precise as the method is available in all Unix-based ports
but currently there doesn't seem to be any way to specify this so just mention
its availability in wxGTK which is what counts.

Closes #14002.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70643 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:22 +00:00
Vadim Zeitlin
267c55c377 Fix wrong spelling of wxRegKey::HasSubkeys() in the documentation.
This method is currently called HasSubkeys() and not HasSubKeys() even though
the latter would have been more consistent with HasSubKey() so we might
consider renaming it in the future. But for now just fix the documentation.

Closes #13998.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70641 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:14 +00:00
Vadim Zeitlin
fa60451416 Remove inexistent wxPropertySheetDialog::SetInnerSizer() from documentation.
Closes #13997.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70640 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:56:10 +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
96dc06fdce Remove wxDialog::OnSysColourChanged() documentation.
This event handler is a private implementation detail and shouldn't be
documented.

Closes #13964.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70635 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 21:55:49 +00:00
Julian Smart
c9f18835ab Added wxEVT_WIZARD_BEFORE_PAGE_CHANGED event to allow the application to influence
the return value of GetNext after Next is clicked.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70630 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-20 11:38:52 +00:00
Stefan Neis
c44db939d6 Fixed spelling errors, fixes #14021.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70624 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-18 19:59:59 +00:00
Julian Smart
81702b39d3 Removed OnSelect
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70617 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-18 14:24:38 +00:00
Julian Smart
51795e3399 Fixed name of GetCombinedStyleForLevel
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70616 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-18 14:22:56 +00:00
Julian Smart
d2ae3af890 Applied #14000 (wxRichTextXMLHandler interface fixes)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70615 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-18 14:20:01 +00:00
Vadim Zeitlin
c66a675a5e Remove wrong "const" from wxPosition::operator{+,-}=() documentation.
Closes #13991.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70609 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:40:18 +00:00
Vadim Zeitlin
ee094b632d Fix the name of wxPersistentTreeBookCtrl in the documentation.
It was misspelt as wxPersistentTreeBook.

Closes #13990.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70608 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:40:14 +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
6dea83846b Fix typo in wxOwnerDrawnComboBox ctor documentation.
"[]" was in the wrong place.

Closes #13987.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70606 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:40:07 +00:00
Vadim Zeitlin
c68b896746 Fix typo in wxMultiChoiceDialog::GetSelections() name in the documentation.
Closes #13986.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70605 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:40:04 +00:00
Vadim Zeitlin
9b026e3159 Mark Mac-specific wxMenuBar methods with @onlyfor{wxosx}.
Closes #13985.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70604 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:40:00 +00:00
Vadim Zeitlin
0364ac987d Document the default size of new wxMemoryBuffer correctly.
Documenting it as DefBufSize wasn't really helpful, so just use its value
instead (an alternative would be to document DefBufSize -- with its value --
but it doesn't seem very useful to make it part of the public API).

Closes #13984.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70603 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:39:56 +00:00
Vadim Zeitlin
16205a28d2 Fix wxMediaCtrl::GetPlaybackRate() method name in the documentation.
Closes #13983.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:39:53 +00:00
Vadim Zeitlin
0c2bed825d Document wxConvFileName variable, not wxMBConvFile class.
The class doesn't exist (and the documentation even says that much) but the
global variable does exist, so document it instead.

Closes #13982.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70601 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:39:49 +00:00
Vadim Zeitlin
996d3fe3f8 Added wxFileName::Exists().
This function checks for existence of anything with the given name, not
necessarily just a file or a directory.

Extend the unit test to verify that it returns true for /dev/null on Unix
systems.

Closes #953.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70600 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:39:46 +00:00
Vadim Zeitlin
06bfd04527 Explicitly document that hidden windows get wxEVT_IDLE events.
This wasn't always the case and could be unexpected so document this behaviour
clearly, also explain the rationale for it.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70598 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 15:39:37 +00:00
Vadim Zeitlin
21371c1df0 Document wxLogGui::DoShow{Single,Multiple}LogMessage() as private.
These methods should be documented because they can be overridden but they're
private so document them as such.

Closes #13981.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70594 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:36:02 +00:00
Vadim Zeitlin
b5176f6d75 Don't document wxListCtrl::SetColumnsOrder() as being const.
Because it isn't.

Closes #13980.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70593 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:58 +00:00
Vadim Zeitlin
659334e17f Clean up wxListBox documentation.
Remove the methods inherited from the base class, there is no need to
re-document them here, especially as this was done incorrectly for Set().

Do document EnsureVisible() and IsSorted().

Closes #13979.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70592 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:55 +00:00