An abstract representation of a system window. More...
#include <vgui_window.h>
Public Member Functions | |
| vgui_window () | |
| Default constructor. | |
| virtual | ~vgui_window () |
| Destructor. | |
| virtual void | set_menubar (vgui_menu const &) |
| Put the given menu in the menubar (if it exists). | |
| virtual void | set_statusbar (bool) |
| If true, activate the statusbar (if it exists). | |
| virtual void | set_adaptor (vgui_adaptor *) |
| Set the default adaptor (if it exists) to the given vgui_adaptor. | |
| virtual vgui_adaptor * | get_adaptor () |
| Get the default adaptor (if it exists). | |
| virtual vgui_statusbar * | get_statusbar () |
| Get the status bar (if it exists). | |
| virtual void | show () |
| Display the window. | |
| virtual void | hide () |
| Hide the window from view. | |
| virtual void | iconify () |
| Turn the window into an icon. | |
| virtual void | enable_hscrollbar (bool) |
| If true, activate horizontal scrollbar (if it exists). | |
| virtual void | enable_vscrollbar (bool) |
| If true, activate vertical scrollbar (if it exists). | |
| virtual void | reshape (unsigned, unsigned) |
| Change window shape to new given width and height. | |
| virtual void | reposition (int, int) |
| Move the window to the new given x,y position. | |
| virtual void | set_title (vcl_string const &) |
| Use the given text as the window title (if the window has a title). | |
| virtual int | set_hscrollbar (int pos) |
| Set the position of the horizontal scrollbar, returns old position. | |
| virtual int | set_vscrollbar (int pos) |
| Set the position of the vertical scrollbar, returns old position. | |
Detailed Description
An abstract representation of a system window.
It is not necessarily the application's top level window, but it may have a menubar, or the concept of an application menubar, which is accessed using set_menubar.
Possibly not all GUI toolkits using this representation will have menus, statusbars, scrollbars or titles, though there wouldn't be much point in implementing this if you couldn't at least display an OpenGL area (vgui_adaptor) in your window.
Definition at line 33 of file vgui_window.h.
Constructor & Destructor Documentation
| vgui_window::vgui_window | ( | ) | [inline] |
Default constructor.
Definition at line 37 of file vgui_window.h.
| virtual vgui_window::~vgui_window | ( | ) | [inline, virtual] |
Destructor.
Definition at line 40 of file vgui_window.h.
Member Function Documentation
| void vgui_window::enable_hscrollbar | ( | bool | ) | [virtual] |
If true, activate horizontal scrollbar (if it exists).
Reimplemented in vgui_wx_window, vgui_win32_window, and vgui_mfc_window.
Definition at line 50 of file vgui_window.cxx.
| void vgui_window::enable_vscrollbar | ( | bool | ) | [virtual] |
If true, activate vertical scrollbar (if it exists).
Reimplemented in vgui_wx_window, vgui_win32_window, and vgui_mfc_window.
Definition at line 55 of file vgui_window.cxx.
| vgui_adaptor * vgui_window::get_adaptor | ( | void | ) | [virtual] |
Get the default adaptor (if it exists).
Reimplemented in vgui_gtk2_window, vgui_gtk_window, vgui_mfc_window, vgui_wx_window, vgui_win32_window, vgui_qt_window, vgui_qt_window, and vgui_glut_window.
Definition at line 30 of file vgui_window.cxx.
| vgui_statusbar * vgui_window::get_statusbar | ( | void | ) | [virtual] |
Get the status bar (if it exists).
Reimplemented in vgui_gtk2_window, vgui_gtk_window, vgui_mfc_window, vgui_wx_window, vgui_win32_window, vgui_qt_window, and vgui_qt_window.
Definition at line 36 of file vgui_window.cxx.
| void vgui_window::hide | ( | ) | [virtual] |
Hide the window from view.
Reimplemented in vgui_wx_window, vgui_mfc_window, vgui_win32_window, vgui_gtk2_window, vgui_gtk_window, vgui_qt_window, vgui_qt_window, and vgui_glut_window.
Definition at line 60 of file vgui_window.cxx.
| void vgui_window::iconify | ( | ) | [virtual] |
Turn the window into an icon.
Reimplemented in vgui_wx_window, vgui_win32_window, vgui_mfc_window, and vgui_glut_window.
Definition at line 65 of file vgui_window.cxx.
| void vgui_window::reposition | ( | int | , |
| int | |||
| ) | [virtual] |
Move the window to the new given x,y position.
Reimplemented in vgui_wx_window, vgui_win32_window, vgui_mfc_window, and vgui_glut_window.
Definition at line 75 of file vgui_window.cxx.
| void vgui_window::reshape | ( | unsigned | , |
| unsigned | |||
| ) | [virtual] |
Change window shape to new given width and height.
Reimplemented in vgui_wx_window, vgui_win32_window, vgui_mfc_window, vgui_gtk2_window, and vgui_glut_window.
Definition at line 70 of file vgui_window.cxx.
| void vgui_window::set_adaptor | ( | vgui_adaptor * | ) | [virtual] |
Set the default adaptor (if it exists) to the given vgui_adaptor.
These refer to the default/current adaptor, if that makes sense. It is not a requirement that it should make sense.
Reimplemented in vgui_gtk2_window, vgui_gtk_window, vgui_wx_window, and vgui_win32_window.
Definition at line 25 of file vgui_window.cxx.
| int vgui_window::set_hscrollbar | ( | int | pos | ) | [virtual] |
Set the position of the horizontal scrollbar, returns old position.
Reimplemented in vgui_win32_window, vgui_wx_window, and vgui_mfc_window.
Definition at line 85 of file vgui_window.cxx.
| void vgui_window::set_menubar | ( | vgui_menu const & | ) | [virtual] |
Put the given menu in the menubar (if it exists).
Reimplemented in vgui_gtk2_window, vgui_gtk_window, vgui_mfc_window, vgui_wx_window, vgui_qt_window, vgui_win32_window, vgui_qt_window, and vgui_glut_window.
Definition at line 18 of file vgui_window.cxx.
| virtual void vgui_window::set_statusbar | ( | bool | ) | [inline, virtual] |
If true, activate the statusbar (if it exists).
Reimplemented in vgui_gtk2_window, vgui_gtk_window, vgui_wx_window, and vgui_win32_window.
Definition at line 46 of file vgui_window.h.
| void vgui_window::set_title | ( | vcl_string const & | ) | [virtual] |
Use the given text as the window title (if the window has a title).
Reimplemented in vgui_win32_window, vgui_wx_window, vgui_mfc_window, vgui_gtk2_window, vgui_gtk_window, and vgui_glut_window.
Definition at line 80 of file vgui_window.cxx.
| int vgui_window::set_vscrollbar | ( | int | pos | ) | [virtual] |
Set the position of the vertical scrollbar, returns old position.
Reimplemented in vgui_win32_window, vgui_wx_window, and vgui_mfc_window.
Definition at line 91 of file vgui_window.cxx.
| void vgui_window::show | ( | ) | [virtual] |
Display the window.
Reimplemented in vgui_mfc_window, vgui_wx_window, vgui_win32_window, vgui_gtk2_window, vgui_gtk_window, vgui_qt_window, vgui_qt_window, and vgui_glut_window.
Definition at line 45 of file vgui_window.cxx.
The documentation for this class was generated from the following files:
- core/vgui/vgui_window.h
- core/vgui/vgui_window.cxx
