docs/latex/wx/hvscrolledwindow.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        hvscrolledwindow.tex
   3 %% Purpose:     wxHVScrolledWindow Documentation
   4 %% Author:      Bryan Petty
   5 %% Modified by:
   6 %% Created:     2007-04-04
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) 2007 wxWidgets Team
   9 %% License:     wxWindows Licence
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxHVScrolledWindow}}\label{wxhvscrolledwindow}
  13
  14 This window inherits all functionality of both vertical and horizontal,
  15 variable scrolled windows. It automatically handles everything needed to
  16 scroll both axis simultaneously with both variable row heights and variable
  17 column widths.
  18
  19 This is a generalization of the \helpref{wxScrolledWindow}{wxscrolledwindow}
  20 class which can be only used when all rows and columns are the same size. It
  21 lacks some other wxScrolledWindow features however, notably it can't scroll
  22 only a rectangle of the window and not its entire client area.
  23
  24 To use this class, you must derive from it and implement both the
  25 \helpref{OnGetRowHeight()}{wxvarvscrollhelperongetrowheight} and
  26 \helpref{OnGetColumnWidth()}{wxvarhscrollhelperongetcolumnwidth} pure virtual
  27 methods to let the base class know how many rows and columns it should
  28 display. You also need to set the total rows and columns the window contains,
  29 but from that moment on the scrolling is handled entirely by
  30 wxHVScrolledWindow. You only need to draw the visible part of contents in
  31 your {\tt OnPaint()} method as usual. You should use
  32 \helpref{GetVisibleBegin()}{wxvarhvscrollhelpergetvisiblebegin}
  33 and \helpref{GetVisibleEnd()}{wxvarhvscrollhelpergetvisibleend} to select the
  34 lines to display. Note that the device context origin is not shifted so the
  35 first visible row and column always appear at the point $(0, 0)$ in physical
  36 as well as logical coordinates.
  37
  38 \wxheading{Derived from}
  39
  40 \helpref{wxPanel}{wxpanel}\\
  41 \helpref{wxWindow}{wxwindow}\\
  42 \helpref{wxEvtHandler}{wxevthandler}\\
  43 \helpref{wxObject}{wxobject}
  44
  45 \helpref{wxVarHVScrollHelper}{wxvarhvscrollhelper}
  46
  47 \helpref{wxVarVScrollHelper}{wxvarvscrollhelper}\\
  48 \helpref{wxVarScrollHelperBase}{wxvarscrollhelperbase}
  49
  50 \helpref{wxVarHScrollHelper}{wxvarhscrollhelper}\\
  51 \helpref{wxVarScrollHelperBase}{wxvarscrollhelperbase}
  52
  53 \wxheading{Include files}
  54
  55 <wx/vscroll.h>
  56
  57 \wxheading{See also}
  58
  59 \helpref{wxHScrolledWindow}{wxhscrolledwindow},
  60 \rtfsp\helpref{wxVScrolledWindow}{wxvscrolledwindow}
  61
  62 \latexignore{\rtfignore{\wxheading{Members}}}
  63
  64
  65 \membersection{wxHVScrolledWindow::wxHVScrolledWindow}\label{wxhvscrolledwindowwxhvscrolledwindow}
  66
  67 \func{}{wxHVScrolledWindow}{\void}
  68
  69 Default constructor, you must call \helpref{Create()}{wxhvscrolledwindowcreate}
  70 later.
  71
  72 \func{}{wxHVScrolledWindow}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxString\& }{name = wxPanelNameStr}}
  73
  74 This is the normal constructor, no need to call {\tt Create()} after using this one.
  75
  76 Note that {\tt wxHSCROLL} and {\tt wxVSCROLL} are always automatically added
  77 to our styles, there is no need to specify it explicitly.
  78
  79 \wxheading{Parameters}
  80
  81 \docparam{parent}{The parent window, must not be {\tt NULL}}
  82
  83 \docparam{id}{The identifier of this window, {\tt wxID\_ANY} by default}
  84
  85 \docparam{pos}{The initial window position}
  86
  87 \docparam{size}{The initial window size}
  88
  89 \docparam{style}{The window style. There are no special style bits defined for
  90 this class.}
  91
  92 \docparam{name}{The name for this window; usually not used}
  93
  94
  95 \membersection{wxHVScrolledWindow::Create}\label{wxhvscrolledwindowcreate}
  96
  97 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxString\& }{name = wxPanelNameStr}}
  98
  99 Same as the \helpref{non-default constuctor}{wxhvscrolledwindowwxhvscrolledwindow}
 100 but returns status code: {\tt true} if ok, {\tt false} if the window couldn't
 101 be created.
 102
 103 Just as with the constructor above, the {\tt wxHSCROLL} and {\tt wxVSCROLL}
 104 styles are always used, there is no need to specify it explicitly.
 105