Changeset 6910 for code

Timestamp:

May 17, 2010, 3:22:10 PM (15 years ago)

Author:

smerkli

Message:

Added final comments, getting ready for merge

Location:

code/branches/chat2

Files:

• data/gui/layouts/ChatBox.layout (modified) (1 diff)
• src/orxonox/ChatHistory.cc (modified) (2 diffs)
• src/orxonox/ChatInputHandler.cc (modified) (2 diffs)
• src/orxonox/ChatInputHandler.h (modified) (2 diffs)
• src/orxonox/graphics/ChatBox.cc (deleted)
• src/orxonox/graphics/ChatBox.h (deleted)

code/branches/chat2/data/gui/layouts/ChatBox.layout

@@ -11 +11 @@
             <Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
             <Property Name="TitlebarEnabled" Value="True" />
-            <Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.03,0},{0.6,0},{0.69375,0}}" />
+            <!--<Property Name="UnifiedAreaRect" Value="{{0.01,0},{0.03,0},{0.6,0},{0.69375,0}}" />-->
+            <Property Name="UnifiedAreaRect" Value="{{0.35,0},{0.10,0},{0.98,0},{0.65,0}}" />
             <Window Type="MenuWidgets/Listbox" Name="orxonox/ChatBox/history" >
                 <Property Name="Font" Value="Monofur-10" />

code/branches/chat2/src/orxonox/ChatHistory.cc

@@ -80 +80 @@
     std::string text;
 
-    //COUT(0) << "Meow.\n";
-
 #ifndef CHATTEST
+    /* get sender ID and prepend it to the message */
     if (senderID != CLIENTID_UNKNOWN)
     {
-       std::string name = "unknown";
-       PlayerInfo* player = PlayerManager::getInstance().getClient(senderID);
-       if (player)
-         name = player->getName();
+      /* if we can't find anything, use "unknown" as default */
+      std::string name = "unknown";
 
-         text = name + ": " + message;
+      PlayerInfo* player = PlayerManager::getInstance().getClient(senderID);
+      if (player)
+        name = player->getName();
+
+      text = name + ": " + message;
     }
     else
@@ -164 +165 @@
   void ChatHistory::chat_hist_closelog()
   {
+    /* see if we've actually got a logfile */
     if( this->hist_logfile )
-    { this->chat_hist_logline( "--- Logfile closed ---" );
+    { 
+      /* yes, we've got one, add a line that shows we're closing it */
+      this->chat_hist_logline( "--- Logfile closed ---" );
+
+      /* actually close down the file */
       this->hist_logfile.close();
     }

code/branches/chat2/src/orxonox/ChatInputHandler.cc

@@ -75 +75 @@
   void ChatInputHandler::configureInputBuffer()
   {
+    /* INSTALL CALLBACKS */
     /* input has changed */
     this->inpbuf->registerListener(this, &ChatInputHandler::inputChanged, true);
@@ -98 +99 @@
     this->inpbuf->registerListener(this, &ChatInputHandler::cursorHome,      KeyCode::Home);
 
-    /* get window pointers */
+    /* GET WINDOW POINTERS */
     input = CEGUI::WindowManager::getSingleton().getWindow( "orxonox/ChatBox/input" );
     inputonly = CEGUI::WindowManager::getSingleton().getWindow( "orxonox/ChatBox-inputonly/input" );
 
+    /* get pointer to the history window */
     CEGUI::Window *history = CEGUI::WindowManager::getSingleton().getWindow( "orxonox/ChatBox/history" );
+
+    /* cast it to a listbox */
     lb_history = dynamic_cast<CEGUI::Listbox*>(history); 
 

code/branches/chat2/src/orxonox/ChatInputHandler.h

@@ -78 +78 @@
       void sub_adjust_dispoffset( int maxlen, int cursorpos, int inplen );
 
-      /* singleton pointer */
+      /** singleton pointer */
       static ChatInputHandler* singletonPtr_s;
 
-      /* cegui stuff */
+      /** cegui window handles */
       CEGUI::Window *input, *inputonly;
+
+      /** cegui handle for the history window */
       CEGUI::Listbox *lb_history;
-
-    public:
-      /** constructor */
-      ChatInputHandler();
-      friend class Singleton<ChatInputHandler>;
-
-      /* start listening, stop listening */
-      static void activate_static();
-      static void activate_small_static();
-
-      void incomingChat( const std::string& message, 
-        unsigned int senderID );
-
-      void activate( bool full );
-      void deactivate();
 
       /* callbacks for input handler */
@@ -110 +97 @@
       void cursorHome();
       void exit();
+
+    public:
+      /** constructor */
+      ChatInputHandler();
+      friend class Singleton<ChatInputHandler>;
+
+      /** start listening */
+      static void activate_static();
+
+      /** stop listening */
+      static void activate_small_static();
+
+      /** \param message the message text
+       * \param senderID ID of the player who sent the message
+       *
+       * Deal with incoming chat (which means in our case: Add it to the
+       * history window of the full chat window)
+       */
+      void incomingChat( const std::string& message, 
+        unsigned int senderID );
+
+      /** \param full true means show full chat window with history,
+            false means show only an input line
+       * 
+       * Show the chat window and redirect the game's keyboard input 
+       * into it.
+       */
+      void activate( bool full );
+
+      /** Deactivate the chat window, meaning: hide it. */
+      void deactivate();
+
   };