PEnvironment Class Reference

#include <PEnvironment.h>

Inheritance diagram for PEnvironment:

Public Member Functions
	PEnvironment ()
virtual	~PEnvironment ()
virtual void	Initialize ()=0
virtual bool	IsInitialized ()
virtual bool	AddWindow (PWindow *window)
virtual PWindow *	GetWindow (int index=0)
virtual bool	RemoveWindow (PWindow *window)
virtual std::string	GetSystemLocale ()=0
virtual bool	IsSystemLocaleRTL ()=0

Protected Member Functions
virtual std::ostream &	SendToStream (std::ostream &out) const

Protected Attributes
bool	mIsInitialized
std::list< PWindow * >	mWindows

Detailed Description

This class, a subtype of PEBLObjectBase, initiates the interface environment and maintians all widgets, sounds, etc. subtypes include sounds, visual objects, etc. It is a virtual class that needs to be inherited by a PlatformEnvironment, have and have its methods overridden.

Definition at line 39 of file PEnvironment.h.

Constructor & Destructor Documentation

PEnvironment()

PEnvironment::PEnvironment ( )

inline

Definition at line 43 of file PEnvironment.h.

:mIsInitialized(false){};

~PEnvironment()

PEnvironment::~PEnvironment ( )

virtual

Definition at line 57 of file PEnvironment.cpp.

{
 
 
}

Member Function Documentation

AddWindow()

bool PEnvironment::AddWindow ( PWindow *  window )

virtual

Definition at line 30 of file PEnvironment.cpp.

{
    mWindows.push_front(window);
    return true;
}

References mWindows.

Referenced by main(), and PEBLObjects::MakeWindow().

GetSystemLocale()

virtual std::string PEnvironment::GetSystemLocale ( )

pure virtual

Implemented in PlatformEnvironment, and PlatformEnvironment.

GetWindow()

PWindow * PEnvironment::GetWindow ( int  index = 0 )

virtual

Definition at line 46 of file PEnvironment.cpp.

{
    //index is not used--it just gets the first window on the list.
    PWindow * retval = NULL;
    
    if(mWindows.size()>0)
        retval= *(mWindows.begin());
    
    return retval;
}

References mWindows, and NULL.

Initialize()

virtual void PEnvironment::Initialize ( )

pure virtual

Implemented in PlatformEnvironment, and PlatformEnvironment.

IsInitialized()

virtual bool PEnvironment::IsInitialized ( )

inlinevirtual

Definition at line 47 of file PEnvironment.h.

{return mIsInitialized;}

References mIsInitialized.

IsSystemLocaleRTL()

virtual bool PEnvironment::IsSystemLocaleRTL ( )

pure virtual

Implemented in PlatformEnvironment, and PlatformEnvironment.

RemoveWindow()

bool PEnvironment::RemoveWindow ( PWindow *  window )

virtual

Definition at line 36 of file PEnvironment.cpp.

{
    //std::cout << "Removing window from mWindows: " << mWindows.size() <<std::endl;
    mWindows.remove(window);
    //std::cout << "Removed window from mWindows: " << mWindows.size() <<std::endl;
    return true;
}

References mWindows.

Referenced by PWindow::~PWindow().

SendToStream()

virtual std::ostream & PEnvironment::SendToStream ( std::ostream &  out ) const

inlineprotectedvirtual

Reimplemented in PlatformEnvironment, and PlatformEnvironment.

Definition at line 68 of file PEnvironment.h.

{return out;};

Member Data Documentation

mIsInitialized

bool PEnvironment::mIsInitialized

protected

Definition at line 70 of file PEnvironment.h.

Referenced by PlatformEnvironment::Initialize(), IsInitialized(), and PlatformEnvironment::PlatformEnvironment().

mWindows

std::list<PWindow*> PEnvironment::mWindows

protected

Definition at line 76 of file PEnvironment.h.

Referenced by AddWindow(), PlatformEnvironment::Draw(), GetWindow(), RemoveWindow(), PlatformEnvironment::SetCursorPosition(), and PlatformEnvironment::~PlatformEnvironment().

---

The documentation for this class was generated from the following files:

• PEnvironment.h
• PEnvironment.cpp