From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_window.html | 1826 ++++++++++++++++++++++++++++++++++++ 1 file changed, 1826 insertions(+) create mode 100644 Doc/doxygen/html/class_window.html (limited to 'Doc/doxygen/html/class_window.html') diff --git a/Doc/doxygen/html/class_window.html b/Doc/doxygen/html/class_window.html new file mode 100644 index 0000000..32fc60c --- /dev/null +++ b/Doc/doxygen/html/class_window.html @@ -0,0 +1,1826 @@ + + + + + +Starshatter_Open: Window Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +Protected Attributes | +Friends
+
+
Window Class Reference
+
+
+ +

#include <Window.h>

+
+Inheritance diagram for Window:
+
+
+ + +ActiveWindow +Button +ComboBox +FormWindow +ImageBox +ScrollWindow +Slider +AudDlg +AwardDlg +AwardShowDlg +CmdForceDlg +CmdIntelDlg +CmdMissionsDlg +CmdMsgDlg +CmdOrdersDlg +CmdTheaterDlg +CmdTitleDlg +CmpCompleteDlg +CmpFileDlg +CmpLoadDlg +CmpSceneDlg +CmpSelectDlg +ConfirmDlg +CtlDlg +DebriefDlg +EngDlg +ExitDlg +FirstTimeDlg +FltDlg +JoyDlg +KeyDlg +LoadDlg +MenuDlg +ModDlg +ModInfoDlg +MsnEditDlg +MsnElemDlg +MsnEventDlg +MsnObjDlg +MsnPkgDlg +MsnSelectDlg +MsnWepDlg +NavDlg +NetAddrDlg +NetClientDlg +NetLobbyDlg +NetPassDlg +NetServerDlg +NetUnitDlg +OptDlg +PlayerDlg +TacRefDlg +VidDlg +ComboList +EditBox +ListBox +RichTextBox + +
+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Window (Screen *s, int ax, int ay, int aw, int ah)
virtual ~Window ()
int operator== (const Window &that) const
Screen * GetScreen () const
const Rect & GetRect () const
int X () const
int Y () const
int Width () const
int Height () const
virtual void Paint ()
virtual void Show ()
virtual void Hide ()
virtual bool IsShown () const
virtual void MoveTo (const Rect &r)
virtual bool AddView (View *v)
virtual bool DelView (View *v)
Rect ClipRect (const Rect &r)
bool ClipLine (int &x1, int &y1, int &x2, int &y2)
bool ClipLine (double &x1, double &y1, double &x2, double &y2)
void DrawLine (int x1, int y1, int x2, int y2, Color color, int blend=0)
void DrawRect (int x1, int y1, int x2, int y2, Color color, int blend=0)
void DrawRect (const Rect &r, Color color, int blend=0)
void FillRect (int x1, int y1, int x2, int y2, Color color, int blend=0)
void FillRect (const Rect &r, Color color, int alpha=0)
void DrawBitmap (int x1, int y1, int x2, int y2, Bitmap *img, int blend=0)
void FadeBitmap (int x1, int y1, int x2, int y2, Bitmap *img, Color c, int blend)
void ClipBitmap (int x1, int y1, int x2, int y2, Bitmap *img, Color c, int blend, const Rect &clip)
void TileBitmap (int x1, int y1, int x2, int y2, Bitmap *img, int blend=0)
void DrawLines (int nPts, POINT *pts, Color color, int blend=0)
void DrawPoly (int nPts, POINT *pts, Color color, int blend=0)
void FillPoly (int nPts, POINT *pts, Color color, int blend=0)
void DrawEllipse (int x1, int y1, int x2, int y2, Color color, int blend=0)
void FillEllipse (int x1, int y1, int x2, int y2, Color color, int blend=0)
void SetFont (Font *f)
Font * GetFont () const
void Print (int x1, int y1, const char *fmt,...)
void DrawText (const char *txt, int count, Rect &txt_rect, DWORD flags)
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+ + + +

+Protected Member Functions

virtual void ScreenToWindow (int &x, int &y)
virtual void ScreenToWindow (Rect &r)
+ + + + + + +

+Protected Attributes

Rect rect
Screen * screen
bool shown
Font * font
List< View > view_list
+ + +

+Friends

class Screen
+

Detailed Description

+
+

Definition at line 32 of file Window.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Window::Window (Screen * s,
int ax,
int ay,
int aw,
int ah 
)
+
+ +

Definition at line 30 of file Window.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Window::~Window ()
+ 		+virtual
+
+ +

Definition at line 36 of file Window.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
bool Window::AddView (View * v)
+ 		+virtual
+
+ +

Definition at line 44 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::ClipBitmap (int x1,
int y1,
int x2,
int y2,
Bitmap * img,
Color c,
int blend,
const Rect & clip 
)
+
+ +

Definition at line 477 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool Window::ClipLine (int & x1,
int & y1,
int & x2,
int & y2 
)
+
+ +

Definition at line 125 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
bool Window::ClipLine (double & x1,
double & y1,
double & x2,
double & y2 
)
+
+ +

Definition at line 184 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + +
Rect Window::ClipRect (const Rect & r)
+
+ +

Definition at line 96 of file Window.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool Window::DelView (View * v)
+ 		+virtual
+
+ +

Definition at line 55 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::DrawBitmap (int x1,
int y1,
int x2,
int y2,
Bitmap * img,
int blend = 0 
)
+
+ +

Definition at line 457 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::DrawEllipse (int x1,
int y1,
int x2,
int y2,
Color color,
int blend = 0 
)
+
+ +

Definition at line 655 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::DrawLine (int x1,
int y1,
int x2,
int y2,
Color color,
int blend = 0 
)
+
+ +

Definition at line 243 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::DrawLines (int nPts,
POINT * pts,
Color color,
int blend = 0 
)
+
+ +

Definition at line 372 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::DrawPoly (int nPts,
POINT * pts,
Color color,
int blend = 0 
)
+
+ +

Definition at line 395 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::DrawRect (int x1,
int y1,
int x2,
int y2,
Color color,
int blend = 0 
)
+
+ +

Definition at line 263 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void Window::DrawRect (const Rect & r,
Color color,
int blend = 0 
)
+
+ +

Definition at line 300 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::DrawText (const char * txt,
int count,
Rect & txt_rect,
DWORD flags 
)
+
+ +

Reimplemented in ActiveWindow.

+ +

Definition at line 890 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::FadeBitmap (int x1,
int y1,
int x2,
int y2,
Bitmap * img,
Color c,
int blend 
)
+
+ +

Definition at line 467 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::FillEllipse (int x1,
int y1,
int x2,
int y2,
Color color,
int blend = 0 
)
+
+ +

Definition at line 791 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::FillPoly (int nPts,
POINT * pts,
Color color,
int blend = 0 
)
+
+ +

Definition at line 423 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::FillRect (int x1,
int y1,
int x2,
int y2,
Color color,
int blend = 0 
)
+
+ +

Definition at line 308 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void Window::FillRect (const Rect & r,
Color color,
int alpha = 0 
)
+
+ +

Definition at line 364 of file Window.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Font* Window::GetFont () const
+ 		+inline
+
+ +

Definition at line 85 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Rect& Window::GetRect () const
+ 		+inline
+
+ +

Definition at line 46 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Screen* Window::GetScreen () const
+ 		+inline
+
+ +

Definition at line 45 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Window::Height () const
+ 		+inline
+
+ +

Definition at line 50 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual void Window::Hide ()
+ 		+inlinevirtual
+
+ +

Reimplemented in ActiveWindow, EngDlg, ComboList, CmpSceneDlg, and FltDlg.

+ +

Definition at line 55 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual bool Window::IsShown () const
+ 		+inlinevirtual
+
+ +

Definition at line 56 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Window::MoveTo (const Rect & r)
+ 		+virtual
+
+ +

Reimplemented in ActiveWindow, ScrollWindow, ComboBox, and CmpLoadDlg.

+ +

Definition at line 63 of file Window.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int Window::operator== (const Window & that) const
+ 		+inline
+
+ +

Definition at line 42 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Window::Paint ()
+ 		+virtual
+
+ +

Reimplemented in ActiveWindow, and ScrollWindow.

+ +

Definition at line 81 of file Window.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::Print (int x1,
int y1,
const char * fmt,
 ... 
)
+
+ +

Definition at line 876 of file Window.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void Window::ScreenToWindow (int & x,
int & y 
)
+ 		+inlineprotectedvirtual
+
+ +

Definition at line 92 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Window::ScreenToWindow (Rect & r)
+ 		+inlineprotectedvirtual
+
+ +

Definition at line 93 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Window::SetFont (Font * f)
+ 		+inline
+
+ +

Definition at line 84 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual void Window::Show ()
+ 		+inlinevirtual
+
+ +

Reimplemented in ActiveWindow, TacRefDlg, MsnWepDlg, MsnObjDlg, DebriefDlg, MsnEditNavDlg, MsnPkgDlg, NetLobbyDlg, MsnEditDlg, MsnNavDlg, EngDlg, MsnEventDlg, NetUnitDlg, MsnElemDlg, ComboList, CmdIntelDlg, CmdMissionsDlg, CmdTitleDlg, CmpFileDlg, CmpSelectDlg, MenuDlg, ModDlg, ModInfoDlg, MsnSelectDlg, NetClientDlg, CtlDlg, VidDlg, AwardDlg, CmpSceneDlg, ExitDlg, NetAddrDlg, NetPassDlg, NetServerDlg, PlayerDlg, AudDlg, AwardShowDlg, CmdOrdersDlg, CmdTheaterDlg, FirstTimeDlg, OptDlg, CmdForceDlg, FltDlg, CmdMsgDlg, CmpCompleteDlg, ConfirmDlg, JoyDlg, KeyDlg, and CmpLoadDlg.

+ +

Definition at line 54 of file Window.h.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Window::TileBitmap (int x1,
int y1,
int x2,
int y2,
Bitmap * img,
int blend = 0 
)
+
+ +

Definition at line 593 of file Window.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* Window::TYPENAME ()
+ 		+inlinestatic
+
+ +

Reimplemented in ActiveWindow, ComboBox, ComboList, RichTextBox, EditBox, and Slider.

+ +

Definition at line 37 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Window::Width () const
+ 		+inline
+
+ +

Definition at line 49 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Window::X () const
+ 		+inline
+
+ +

Definition at line 47 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Window::Y () const
+ 		+inline
+
+ +

Definition at line 48 of file Window.h.

+ +
+
+

Friends And Related Function Documentation

+ +
+
+ + + + + +
+ + + + +
friend class Screen
+ 		+friend
+
+ +

Definition at line 34 of file Window.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Font* Window::font
+ 		+protected
+
+ +

Definition at line 98 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Rect Window::rect
+ 		+protected
+
+ +

Definition at line 95 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Screen* Window::screen
+ 		+protected
+
+ +

Definition at line 96 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Window::shown
+ 		+protected
+
+ +

Definition at line 97 of file Window.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<View> Window::view_list
+ 		+protected
+
+ +

Definition at line 100 of file Window.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1