Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

sjgui Namespace Reference

This namespace contains all the classes created for the sjgui. More...


Compounds

class  CButtonCtrlTmpl
 Button, checkbox, multiple state button, with the text. More...

class  CDlgCtrlTmpl
 Dialog window with Caption label,Ok and Cancel buttons. More...

class  CEditCtrlTmpl
 Edit field. More...

class  CFont
 Font class. More...

class  CKeys
 Keeps track of key actions. More...

class  CLabelCtrlTmpl
 Text label. More...

class  CPanelCtrlTmpl
 Panel for organization of controls into groups. More...

class  CPlaneWndCtrlTmpl
 Window with a backplane and a border. More...

class  CPointTmpl
 This is a template of a class describing a point primitive. More...

class  CRectTmpl
 This is a template of a class describing a rectangle primitive. More...

class  CSizeTmpl
 This is a template of a class describing a size primitive. More...

class  CSliderCtrlTmpl
 Horizontal and vertical slider. More...

class  CSqueezePanelCtrlTmpl
 Squeeze panel, which resizes child windos to fit its area. More...

class  CStackPanelCtrlTmpl
 Stack panel, which places children side by side. More...

class  CTextBoxCtrlTmpl
 Text with horizontal and vertical sliders. More...

class  CTextCtrlTmpl
 Text supporting multiple lines, selection and editing. More...

class  CWnd
 Engine of the gui. More...

class  CWndCtrlBase
 Base class for build in controls. More...


Event functions.

These functions are designed to be called by windowing system.

If you do not use any, you should call them from your framework. Again you need them only if you are controlling operating system events. First parameter is window, which will receive this event.

void OnResizeEvent (CWnd *pWnd, int iWidth, int iHeight)
 Controls window size should be called by windowing system.

int OnInitEvent (CWnd *pWnd)
 Initializes gui.

void OnKeyDownEvent (CWnd *pWnd, int iKey)
 Key down event.

void OnKeyUpEvent (CWnd *pWnd, int iKey)
 Key up event.

void OnMouseMoveEvent (CWnd *pWnd, int iX, int iY)
 Mouse move event.


Functions

template<class T> const T & min (const T &a, const T &b)
 min function.

template<class T> const T & max (const T &a, const T &b)
 max function.

template<class T> T abs (T &a)
 abs function.

int Create (const char *pcCaption, CWnd *pWnd, int iBits=16, bool yFullScreen=false)
 Creates window.

void SetMode (unsigned int uiMode)
 Set display mode.

void SetPos (int iX, int iY)
 Set position of the main window.

void SetScreenSize (int iW, int iH)
 Set size of the window.

void GlobalMainLoop ()
 Main loop of the program.

void IgnoreRepeates (bool b=true)
 On/off repeating of not release key.

void SwitchFullScreen (int iW, int iH, int iBits)
 Switch program into a fullscreen/window mode.

bool IsFullScreen ()
 Returns true if program is in a full screen.

void SetClearColor (GLfloat *fC)
 Color for clearing screen, before redrawing.


Detailed Description

This namespace contains all the classes created for the sjgui.

Author:
Alexander Shyrokov
Version:
Revision
1.1.1.1


Function Documentation

template<class T>
T abs T &  a  )  [inline]
 

abs function.

Author:
Alexander Shyrokov
Version:
Revision
1.1.1.1

int Create const char *  pcCaption,
CWnd *  pWnd,
int  iBits = 16,
bool  yFullScreen = false
 

Creates window.

Creates window, associating given window as a destination for the events. Arguments are used to set up video mode of the program. Size and position of the window is taken from the pWnd. But once they are captured, position of the window is set to 0,0

Note:
Might be removed, because it is glut specific.

void GlobalMainLoop  ) 
 

Main loop of the program.

This should be called by program to start receiving events.

void IgnoreRepeates bool  b = true  ) 
 

On/off repeating of not release key.

Required by CEdit control to process user input in a nice way. But usually should be enabled in the game mode.

template<class T>
const T& max const T &  a,
const T &  b
[inline]
 

max function.

Work around of an issue with min and max for std under native MSVC stl.

Author:
Alexander Shyrokov
Version:
Revision
1.1.1.1

template<class T>
const T& min const T &  a,
const T &  b
[inline]
 

min function.

Work around of an issue with min and max for std under native MSVC stl.

Author:
Alexander Shyrokov
Version:
Revision
1.1.1.1

int OnInitEvent CWnd *  pWnd  ) 
 

Initializes gui.

Should be called before using gui (drawing).

void OnResizeEvent CWnd *  pWnd,
int  iWidth,
int  iHeight
 

Controls window size should be called by windowing system.

pWnd - reciever of the event, will be set new size iWidth, iHeight. Usually user do not call this function, unless he does not using build in windowing system and handles events from the operating system, in his own code. Note, that if minimum size of the window is set, and iWidth or iHeight is smaller then these values, function will call SetWindowSize() to get back to minimum sizes, and returns with no update, thinking that if SetWindowSize() will succede, then there will be new OnResizeEvent() will call SetWindows

See also:
SetWindowSize()

void SetMode unsigned int  uiMode  ) 
 

Set display mode.

Note:
Might be removed, because it is glut specific.

void SetScreenSize int  iW,
int  iH
 

Set size of the window.

Reshape event is generated.

void SwitchFullScreen int  iW,
int  iH,
int  iBits
 

Switch program into a fullscreen/window mode.

What this means is implementation dependent.

sjgui logo
Quick Links:

 News
 Description
 Screen Shots
 Projects
 Downloads
 Source Code
 Help/FAQ
 Want to help?
 Credits
 Disclaimer


Documentation:

 Documentation
 Reference
 Lessons


Useful links:

sjcomp logo
sjcomp

opengl logo

nehe logo

SourceForge.net Logo

Last modified:


Started by Alexander Shyrokov. Generated at Wed Apr 28 12:31:05 2004 for the sjgui by doxygen 1.3.1. SourceForge.net Logo