wxWidgets/interface/wx/containr.h
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

68 lines
2.5 KiB
C++

/////////////////////////////////////////////////////////////////////////////
// Name: wx/containr.h
// Purpose: documentation of wxNavigationEnabled<>
// Author: Vadim Zeitlin
// Created: 2011-07-23
// Copyright: (c) 2011 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
A helper class implementing TAB navigation among the window children.
This class contains the functionality needed to correctly implement TAB
navigation among the children of the window. Its exact contents is not
important and is intentionally not documented as the only way to use this
class is to inherit from it instead of inheriting from the usual base class
directly. For example, if some class needs to inherit from wxControl but
contains multiple sub-windows and needs to support keyboard navigation, it
is enough to declare it in the following way:
@code
class MyControlWithSubChildren :
public wxNavigationEnabled<wxControl>
{
public:
// Default constructor is implemented in the same way as always.
MyControlWithSubChildren() { }
// Non-default constructor can't use wxControl ctor any more as
// wxControl is not its direct base class, but it can use Create().
MyControlWithSubChildren(wxWindow *parent, wxWindowID winid)
{
wxControl::Create(parent, winid);
// More creation code...
}
// Everything else as usual ...
};
@endcode
@library{wxcore}
@since 2.9.3
*/
template <class W>
class wxNavigationEnabled : public W
{
public:
/// The name of the real base window class that this class derives from.
typedef W BaseWindowClass;
/**
Default constructor.
This class provides only the default constructor as it's not possible,
in general, to provide all the constructors of the real base class
BaseWindowClass.
This is however not usually a problem for wxWindow-derived classes as,
by convention, they always define a Create() method such that calling
it on an object initialized using the default constructor is equivalent
to using a non-default constructor directly. So the classes inheriting
from wxNavigationEnabled<W> should simply call W::Create() in their
constructors.
*/
wxNavigationEnabled();
};