Emergency 20 Dokumentation  4.1.0
Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
qsf::editor::ChatView Class Reference

Chat view class. More...

#include <ChatView.h>

Inheritance diagram for qsf::editor::ChatView:
Inheritance graph
[legend]
Collaboration diagram for qsf::editor::ChatView:
Collaboration graph
[legend]

Public Member Functions

 ChatView (ViewManager *viewManager, QWidget *qWidgetParent)
 Constructor. More...
 
virtual ~ChatView ()
 Destructor. More...
 
void setChatViewController (ChatViewController *chatViewController)
 Set the chat view controller. More...
 
- Public Member Functions inherited from qsf::editor::View
virtual ~View ()
 Destructor. More...
 
ApplicationgetApplication () const
 Return the QSF editor application. More...
 
MainWindowgetMainWindow () const
 Return the main window. More...
 
virtual void setVisible (bool visible) override
 
- Public Member Functions inherited from qsf::Pluginable< ViewManager >
virtual ~Pluginable ()
 Destructor. More...
 
ViewManager & getManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::PluginableBase
virtual ~PluginableBase ()
 Destructor. More...
 
template<typename T >
T & getPluginableManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::Object
virtual ~Object ()
 Destructor. More...
 
const camp::Class & getCampClass () const
 Return the CAMP class. More...
 
int getPropertyIndexById (const StringHash &propertyId) const
 Return the CAMP property index by using the unique class property ID. More...
 
uint32 getPropertyIdByIndex (int index) const
 Return the unique class property ID with the given index. More...
 
std::string getPropertyNameById (const StringHash &propertyId) const
 Return the CAMP property name by using the unique class property ID. More...
 
const camp::Property * getCampPropertyById (const StringHash &propertyId) const
 Return the CAMP property by using the unique class property ID. More...
 
void setPropertyValuesByString (const std::string &values)
 Set CAMP reflection property values by using a given string. More...
 
void setPropertiesToDefaultValues ()
 Set all CAMP reflection system properties to their default values. More...
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
void serializeToBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void deserializeFromBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL, bool setOverrideState=true)
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState)
 
virtual void onPreDeserialize ()
 Called right before the object is deserialized using any of the above methods. Default implementation is empty. More...
 
virtual void onPostDeserialize ()
 Called right after the object was deserialized using any of the above methods. Default implementation is empty. More...
 
virtual ScriptgetAssociatedScript () const
 Return the script instance associated with this object instance. More...
 

Static Public Attributes

static const uint32 PLUGINABLE_ID
 "qsf::editor::ChatView" unique pluginable view ID More...
 

Protected Member Functions

virtual bool preChangeVisibility (bool visible) override
 Filter method called before "qsf::editor::View::changeVisibility()" is called. More...
 
virtual void changeVisibility (bool visible) override
 Change visibility. More...
 
- Protected Member Functions inherited from qsf::editor::View
 View (ViewManager *viewManager, QWidget *qWidgetParent)
 Constructor. More...
 
void addViewAndTabify (QMainWindow &qMainWindow, Qt::DockWidgetArea qtDockWidgetArea)
 Add the Qt dock widget to the given Qt main window and tabifies it. More...
 
bool wasHiddenDueClose () const
 
virtual void readSettings (QSettings &qSettings)
 Read settings by using Qt's "QSettings". More...
 
virtual void writeSettings (QSettings &qSettings)
 Write settings by using Qt's "QSettings". More...
 
virtual QString getAutomaticWindowTitle (View &view) const
 Return the automatic window title by using the "Name"-tag of the CAMP reflection view. More...
 
virtual void retranslateUi ()
 Retranslate the UI. More...
 
virtual void showEvent (QShowEvent *qShowEvent) override
 
virtual void hideEvent (QHideEvent *qHideEvent) override
 
virtual void changeEvent (QEvent *qEvent) override
 
virtual void closeEvent (QCloseEvent *qEvent) override
 
- Protected Member Functions inherited from qsf::Pluginable< ViewManager >
 Pluginable (ViewManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::PluginableBase
 PluginableBase (PluginableManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 

Friends

class ChatViewController
 

Additional Inherited Members

- Public Types inherited from qsf::Object
enum  PropertyOverrideState { PROPERTY_INVALID, PROPERTY_DEFAULT, PROPERTY_OVERRIDE, PROPERTY_REMOVED }
 
enum  SerializationMethod { SERIALIZE_FLAT, SERIALIZE_COMPLETE, SERIALIZE_DIFFERENTIAL, SERIALIZE_IGNORE_UNKNOWN }
 
enum  SerializationMode { MODE_MINIMAL, MODE_COMPATIBLE }
 

Detailed Description

Chat view class.

Note
  • The UI is created by using a Qt ui-file (create/edit it by using e.g. Qt Designer)
Todo:
  • TODO(co) Currently just a pretty simple chat

Constructor & Destructor Documentation

qsf::editor::ChatView::ChatView ( ViewManager viewManager,
QWidget *  qWidgetParent 
)

Constructor.

Parameters
[in]viewManagerOptional pointer to the view manager this view should be registered to, can be a null pointer
[in]qWidgetParentPointer to parent Qt widget, can be a null pointer (in this case you're responsible for destroying this view instance)
virtual qsf::editor::ChatView::~ChatView ( )
virtual

Destructor.

Member Function Documentation

virtual void qsf::editor::ChatView::changeVisibility ( bool  visible)
overrideprotectedvirtual

Change visibility.

Note
  • Unlike "QWidget::setVisible()" this method is only called if there was a real visibility state change
  • The default implementation is empty

Reimplemented from qsf::editor::View.

virtual bool qsf::editor::ChatView::preChangeVisibility ( bool  visible)
overrideprotectedvirtual

Filter method called before "qsf::editor::View::changeVisibility()" is called.

Parameters
[in]visibleThe requested visibility state
Returns
The final new visibility state, the view method is allowed to e.g. reject the new requested visibility state
Note
  • Unlike "QWidget::setVisible()" this method is only called if there was a real visibility state change
  • The default implementation is empty
  • By using this method, the view implementation has the opportunity to reject becoming visible, e.g. because it's unable to acquire a required entity lock

Reimplemented from qsf::editor::View.

void qsf::editor::ChatView::setChatViewController ( ChatViewController chatViewController)

Set the chat view controller.

Parameters
[in]chatViewControllerChat view controller to set, can be a null pointer (default chat view controller will be used), the chat view takes over the control of the instance and destroys it if it's no longer required

Friends And Related Function Documentation

friend class ChatViewController
friend

Member Data Documentation

const uint32 qsf::editor::ChatView::PLUGINABLE_ID
static

"qsf::editor::ChatView" unique pluginable view ID


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