[wx-dev] wx[H/V/HV]ScrolledWindow Documentation

[Vadim Zeitlin]

On Wed, 28 Feb 2007 13:35:34 -0700 Bryan Petty <bryan at ibaku.net> wrote:

BP> I've just submitted an updated version of the wx[H/V/HV]ScrolledWindow 

 Thanks a lot! I still didn't have time to look at this and probably won't
before 2.8.2 release (as I'd like to deal with the patches likely to go
there first) but I don't intend this patch to bit rot for long.

BP> The patch involves a completely refactored variable/virtual scrolled 
BP> window classes that use some new additional mixin classes which beg the 
BP> question: Should these classes be documented separately, or should they 
BP> be duplicated between the docs for all the wx[H/V/HV]ScrolledWindow 
BP> classes?  I'm fairly certain that wxAutoScrollHelper should have it's 
BP> own class listing in the docs (and it would be mentioned that 
BP> wxVScrolledWindow derives from it of course), but what about the 
BP> wxVar[H/V]ScrollHelper classes? I can't say I've seen any examples of 
BP> multiple inheritance used in any of the wxWidgets documentation.

 It's not used much in wx and in a few cases where it is used it's more or
less an implementation detail. So all depends on how public these
wxVar[H/V]ScrollHelper classes are. If the user is supposed to use them on
his own then they should definitely be documented. If they're only used by
wx[H/V]ScrolledWindow then it probably doesn't make much sense to document
them separately.

BP> If we do document these classes in any combined form, is there some way 
BP> to write the function docs in a separate .tex file (ie: varhscroll.tex) 
BP> and include that file in multiple class docs to avoid duplication (ie: 
BP> in hscroll.tex and hvscroll.tex)?

 Yes, sure, just use LaTeX \input command. See noteevt.tex which includes
noteevt.inc like this (also included by notebook.tex).

 Regards,
VZ