fixed links to global variables; fixed categories; use @see instead of @seealso

[wxWidgets.git] / interface / toolbook.h

/////////////////////////////////////////////////////////////////////////////
// Name:        toolbook.h
// Purpose:     documentation for wxToolbook class
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxToolbook
    @wxheader{toolbook.h}

    wxToolbook is a class similar to wxNotebook but which
    uses a wxToolBar to show the labels instead of the
    tabs.

    There is no documentation for this class yet but its usage is
    identical to wxNotebook (except for the features clearly related to tabs
    only), so please refer to that class documentation for now. You can also
    use the @ref overview_samplenotebook "notebook sample" to see wxToolbook in
    action.

    @beginStyleTable
    @style{wxTBK_BUTTONBAR}:
           Use wxButtonToolBar-based implementation under Mac OS (ignored
           under other platforms.)
    @style{wxTBK_HORZ_LAYOUT}:
           Shows the text and the icons alongside, not vertically stacked
           (only implement under Windows and GTK 2 platforms as it relies on
           wxTB_HORZ_LAYOUT flag support).
    @endStyleTable

    @library{wxcore}
    @category{FIXME}

    @seealso
    wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample"
*/
class wxToolbook : public wxBookCtrl overview
{
public:

};