X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/renderer.h diff --git a/interface/renderer.h b/interface/renderer.h index c82bff47f0..153a95c271 100644 --- a/interface/renderer.h +++ b/interface/renderer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: renderer.h -// Purpose: documentation for wxSplitterRenderParams class +// Purpose: interface of wxSplitterRenderParams // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -42,6 +42,7 @@ public: }; + /** @class wxDelegateRendererNative @wxheader{renderer.h} @@ -51,7 +52,7 @@ public: thus allowing you to only modify some of its methods -- without having to reimplement all of them. - Note that the "normal'', inheritance-based approach, doesn't work with the + Note that the "normal", inheritance-based approach, doesn't work with the renderers as it is impossible to derive from a class unknown at compile-time and the renderer is only chosen at run-time. So suppose that you want to only add something to the drawing of the tree control buttons but leave all the @@ -62,7 +63,7 @@ public: Except for the constructor, it has exactly the same methods as wxRendererNative and their implementation is - trivial: they are simply forwarded to the real renderer. Note that the "real'' + trivial: they are simply forwarded to the real renderer. Note that the "real" renderer may, in turn, be a wxDelegateRendererNative as well and that there may be arbitrarily many levels like this -- but at the end of the chain there must be a real renderer which does the drawing. @@ -96,6 +97,7 @@ public: }; + /** @class wxRendererNative @wxheader{renderer.h} @@ -103,7 +105,7 @@ public: First, a brief introduction to wxRenderer and why it is needed. Usually wxWidgets uses the underlying low level GUI system to draw all the - controls - this is what we mean when we say that it is a "native'' framework. + controls - this is what we mean when we say that it is a "native" framework. However not all controls exist under all (or even any) platforms and in this case wxWidgets provides a default, generic, implementation of them written in wxWidgets itself. @@ -300,7 +302,7 @@ public: not base, class, to detect mismatches between the renderers versions and so you have to implement it anew in all renderers. */ - wxRendererVersion GetVersion(); + wxRendererVersion GetVersion() const; /** Load the renderer from the specified DLL, the returned pointer must be @@ -321,6 +323,7 @@ public: }; + /** @class wxRendererVersion @wxheader{renderer.h} @@ -336,7 +339,7 @@ public: each time a new virtual method is added and so, at least for the compilers using a common C++ object model, the calling program is compatible with any renderer which has the age greater or equal to its age. This verification is - done by IsCompatible method. + done by IsCompatible() method. @library{wxbase} @category{FIXME} @@ -364,3 +367,4 @@ public: The version component. */ }; +