Commit Graph

1720 Commits

Author SHA1 Message Date
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
Vadim Zeitlin
cda337fbb0 Make documentation of wxIcon::ConvertToDisabled() more explicit.
Use @onlyfor{wxmsw} and explain how can the same task be done under the other
platforms.

Closes #13977.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70591 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:52 +00:00
Vadim Zeitlin
0e1cd9bedb Document wxFTP::TransferMode enum in the correct scope.
It's declared inside wxFTP class and not in global scope.

Closes #13976.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70590 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:47 +00:00
Vadim Zeitlin
fc910c50d9 Document wxGB{Position,Size}::operator!=(), remove operator!().
The latter doesn't exist (any more?), the former does.

Closes #13975.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70589 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:43 +00:00
Vadim Zeitlin
8d2f4cb986 Remove documentation of non-existent wxFontMapper::SetConfig().
Closes #13974.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70588 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:39 +00:00
Vadim Zeitlin
ccca2121ef Document Mac-only wxFileName methods as being Mac-only.
Use @onlyfor for them for consistency and to help the automated code
generators.

Closes #13971.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70587 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:36 +00:00
Vadim Zeitlin
0b64c2ad63 Document wxFileType::MessageParameters class.
Documentation is not really very helpful but better than nothing.

Closes #13972.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70586 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:32 +00:00
Vadim Zeitlin
b3a3a879c3 Fix wrong type of wild card parameter in wxFileCtrl documentation.
It is a string, not a point.

Closes #13970.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70585 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:29 +00:00
Vadim Zeitlin
82b30473f9 Make wxDragImage ctors taking hot spot point really deprecated in wxMSW.
They were documented as deprecated and deprecated in the generic version (and
actually not even available there any more without WXWIN_COMPATIBILITY_2_6)
but not in wxMSW, where we just had the weird wxLogDebug() statements that
were inconsistent with our handling of deprecation everywhere else.

Do deprecate them now, remove wxLogDebug() and also remove the deprecated
ctors and Create() overloads from the documentation.

Finally, remove the documentation of deprecated and available in the generic
version only ctor taking only wxCursor (closes #13967).

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70584 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:25 +00:00
Vadim Zeitlin
c3a0b0d876 Document wxDocManager::CreatePreviewFrame() as being protected, not public.
Simply move the function documentation to the correct class section.

Closes #13966.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70583 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:21 +00:00
Vadim Zeitlin
02f5e7631d Don't document private event handlers in doc/view frame classes.
wxDoc[MDI]ParentFrame::OnCloseWindow(), wxDoc[MDI]ChildFrame::OnActivate() and
OnCloseWindow() are all private, don't document them as public. Just mention
that the wxEVT_CLOSE_WINDOW and wxEVT_ACTIVATE should be left for the
processing in the frame classes to let the default handling take place.

Closes #13965.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70582 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-15 00:35:18 +00:00
Vadim Zeitlin
ec8823e77a Remove the mention of non-existing wxPrintf_l() from the documentation.
This function doesn't exist (yet), so don't advise people to use it.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70580 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-14 23:09:33 +00:00
Vadim Zeitlin
9c1fed55d7 Don't document deprecated wxComboCtrl::SetValueWithEvent().
This method shouldn't be used at all, either SetValue() or ChangeValue()
should be used instead, so don't document it.

Closes #13961.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70577 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-12 22:19:07 +00:00
Robin Dunn
aef060ab6c remove some wxPython-only methods that were accidentally added to the interface file
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70573 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-11 20:32:32 +00:00
Vadim Zeitlin
400930d344 Document wxDateTime::GregorianAdoption enum and TimeZone class.
These types are referenced by the other documented functions so should be
documented themselves.

Closes #13959.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70571 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-11 18:36:44 +00:00
Vadim Zeitlin
6f65f436e5 Fix "wxEmptyStr" typo in wxChoicebook and wxToolbook documentation.
It should be "wxEmptyString".

Closes #13955.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70570 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-11 18:36:41 +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
8d9eee8320 Fix wxHash{Set,Map} compilation with g++ 4.7 in C++11 mode.
Fully qualify the hasher and comparator classes used with
WX_DECLARE_HASH_{SET,MAP} macros as they're used as base classes by the
standard library implementation in g++ 4.7 and using them without the scope
operator results in compilation errors because they're interpreted as being
(inaccessible) base classes and not the global ones.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70556 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-10 10:22:45 +00:00
Vadim Zeitlin
37fff49cf1 Document MSW-only wxEVT_MOVING event.
As we documented EVT_MOVE_{START,END}, we should do it for this one as well.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70554 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-09 16:22:04 +00:00
Vadim Zeitlin
ab6a33b4ad Fix wrong signature of wxBitmap(bits) ctor in the documentation.
This ctor takes just a "char* bits" (spelt as "char bits[]" for some reason),
not "char* bits[]".

Closes #13947.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70545 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-08 23:45:32 +00:00
Vadim Zeitlin
419b20032b Restrict button size restrictions documentation to OSX/Carbon only.
OSX/Cocoa doesn't have these restrictions.

Closes #13122.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70544 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-08 12:59:20 +00:00
Vadim Zeitlin
f9afe2fece Document that wxStandardPaths::GetUserConfigDir() doesn't use app info.
Explicitly mention this instead of just relying on the examples to convey it.

Closes #11275.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70543 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-08 02:09:58 +00:00
Vadim Zeitlin
f549e3dad9 Use wxSTC_INVALID_POSITION in wxStyledTextCtrl documentation.
Comments -- copied from the generated header file -- used INVALID_POSITION
which is not actually defined, replace it with wxSTC_INVALID_POSITION that is
defined.

Closes #11454.

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