/////////////////////////////////////////////////////////////////////////////
// Name: window.h
-// Purpose: documentation for wxWindow class
+// Purpose: interface of wxWindow
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{FIXME}
- @seealso
- @ref overview_eventhandlingoverview, @ref overview_windowsizingoverview "Window
- sizing overview"
+ @see @ref overview_eventhandlingoverview, @ref overview_windowsizingoverview
+ "Window sizing overview"
*/
class wxWindow : public wxEvtHandler
{
/**
Call this function to force one or both scrollbars to be always shown, even if
the window is big enough to show its entire contents without scrolling.
- This function is new since wxWidgets version 2.9.0
+
+ @wxsince{2.9.0}
@param hflag
Whether the horizontal scroll bar should always be visible.
static wxWindow* GetCapture();
/**
- Returns the caret associated with the window.
+ Returns the caret() associated with the window.
*/
wxCaret* GetCaret() const;
/**
Returns the next window after this one among the parent children or @NULL if
this window is the last child.
- This function is new since wxWidgets version 2.8.8
+
+ @wxsince{2.8.8}
@see GetPrevSibling()
*/
Returns the previous window before this one among the parent children or @c
@NULL if
this window is the first child.
- This function is new since wxWidgets version 2.8.8
+
+ @wxsince{2.8.8}
@see GetNextSibling()
*/
The parameters of this function are the same as for
ShowWithEffect(), please see their
description there.
- This function is new since wxWidgets version 2.9.0
+
+ @wxsince{2.9.0}
*/
virtual bool HideWithEffect(wxShowEffect effect,
unsigned timeout = 0,
/**
Create a new ID or range of IDs that are not currently in use. The
- IDs will be reserved until assigned to a wxWindowIDRef
+ IDs will be reserved until assigned to a wxWindowIDRef()
or unreserved with UnreserveControlId().
See @ref overview_windowidsoverview "Window IDs overview" for more information.
virtual void SetCanFocus(bool canFocus);
/**
- Sets the caret associated with the window.
+ Sets the caret() associated with the window.
*/
void SetCaret(wxCaret* caret) const;
for the current platform is used.
Currently this function is only implemented in wxMSW and does the same thing as
Show() in the other ports.
- This function is new since wxWidgets version 2.9.0
+
+ @wxsince{2.9.0}
@see HideWithEffect()
*/
virtual void Update();
/**
- This function sends wxUpdateUIEvents to
+ This function sends wxUpdateUIEvents() to
the window. The particular implementation depends on the window; for
example a wxToolBar will send an update UI event for each toolbar button,
and a wxFrame will send an update UI event for each menubar menu item.
};
+
// ============================================================================
// Global functions/macros
// ============================================================================