[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    kdeedu/khangman/khangman
From:       Anne-Marie Mahfouf <annma () kde ! org>
Date:       2005-04-08 3:19:36
Message-ID: 20050408031936.4100263E () office ! kde ! org
[Download RAW message or body]

CVS commit by annma: 

add API doc


  M +21 -12    khangmanview.h   1.43


--- kdeedu/khangman/khangman/khangmanview.h  #1.42:1.43
@@ -41,13 +41,16 @@ public:
     ///parent instance
     KHangMan *khangman;
+    ///Background picture for the Sea theme
     QPixmap seaPicture;
+    ///Paint the animated hanged K sequence
     void paintHangman();
+    
 signals:
 
 private:
-    KLineEdit *charWrite;
-
-    QColor m_fillColor;
 
+    ///The area where the user enter the letter. Upper case is transformed into \
lower case. +    KLineEdit *charWrite;
+    ///After you entered a letter in the line edit click this button to see if the \
letter is in the word or not  KPushButton *guessButton;
 
@@ -60,5 +63,5 @@ protected:
     ///set the background pixmap to the QPixmap argument
     void slotSetPixmap(QPixmap& );
-    
+    ///Store the missed letters
     QString missedL;
 
@@ -89,12 +92,15 @@ protected:
     bool containsChar(const QString &);
     void replaceLetters(const QString &);
+    ///the hanged K animation sequence
     QPixmap px[11];
+    ///part of Sea background used to repaint word and missed letters
     QPixmap bluePic, miss_bluePic;
+    ///Draw the word to be guessed
     void paintWord();
-    
+    ///Reset everything to start a new game, missed letters is empty
     void reset();
-    
+    ///Play a game: look for a word to be guessed and load its tip
     void game();
-
+    ///Load kvtml file and get a word and its tip in random
     void readFile();
     ///If true, the uppercase and lower case are disctincts (world capitals)
@@ -104,20 +110,23 @@ protected:
     ///true if hint is enabled for the fiels that support it
     bool hintBool;
-    //QRect aux;
     ///Enable hints on mouse right click if Hints exist
     virtual void mousePressEvent(QMouseEvent *mouse);
-    
+    ///Paint an already guessed letter in red in Missed Letters
     void paintMissedTwice();
-    
+    ///Paint an already guessed letter in red in word
     void paintWordTwice();
-    
+    ///index of the already guessed letter
     int redIndex;
         
 public slots:
-
+    ///if you want to play with a new word
     void slotNewGame();
 private slots:
+
+    ///after you click on Guess button or hit Enter when guessing a new letter, see \
if the letter is in the word or not  void slotTry();
+    ///when an already guessed letter is entered, if it is in Missed, redraw the \
missed letters area  void timerDone();
+    ///when an already guessed letter is entered, if it is in the word, redraw the \
word area  void timerWordDone();
     


[prev in list] [next in list] [prev in thread] [next in thread]