ksirc/toplevel.h

   1 #ifndef KSIRCTOPLEVEL_H
   2 #define KSIRCTOPLEVEL_H
   3
   4 #include <qdatetime.h>
   5 #include <Q3Accel>
   6 //Added by qt3to4:
   7 #include <QByteArray>
   8 #include <QCloseEvent>
   9 #include <Q3PtrList>
  10 #include <QEvent>
  11 #include <QLabel>
  12 #include <Q3PopupMenu>
  13 #include <kmainwindow.h>
  14
  15 #include "ahistlineedit.h"
  16 #include "messageReceiver.h"
  17 #include "chanButtons.h"
  18 #include "KSTicker/ksticker.h"
  19 #include "ksircchannel.h"
  20
  21 #define KST_CHANNEL_ID 2
  22
  23 class KSircTopic;
  24 class QSplitter;
  25 class KSircView;
  26 class aListBox;
  27 class UserControlMenu;
  28 class ChannelParser;
  29 class charSelector;
  30 class LogFile;
  31 class KSelectAction;
  32 class QLabel;
  33 class KVBox;
  34 class Q3ListBoxItem;
  35
  36 class Q3PopupMenu;
  37
  38 class KSircTopLevel : public KMainWindow,
  39                       public UnicodeMessageReceiver
  40 {
  41   Q_OBJECT
  42     friend class ChannelParser;
  43 public:
  44   /**
  45     * Constructor, needs the controlling ksircprocess passed to it, so
  46     * we can make the ksircmessage receiver happy.
  47     */
  48   KSircTopLevel(KSircProcess *_proc, const KSircChannel &channelInfo, const char *
  49                 name=0);
  50   /**
  51     * Destructor, destroys itself.
  52     */
  53   ~KSircTopLevel();
  54
  55   /**
  56     * Reimplement show() to popup the menu bars and toolbar items
  57     */
  58   virtual void show();
  59
  60   /**
  61    * Line recieved that should be printed on the screen. Unparsed, and
  62    * ready processing.  This is a single line, and it NOT \n
  63    * terminated.
  64    */
  65   virtual void sirc_receive(QString str, bool broadcast = false);
  66
  67   /**
  68     * Reimplement the ksircmessagereceiver control messages.  These
  69     * are parsed and dealt with quickly.
  70     */
  71   virtual void control_message(int, QString);
  72
  73   QWidget *lineEdit() const { return linee; }
  74
  75   void setTopic( const QString &topic );
  76   QString topic() const { return m_topic; }
  77
  78   /**
  79    * This returns the current channel information for a toplevel
  80    */
  81   const KSircChannel &channelInfo() const { return m_channelInfo; }
  82
  83 signals:
  84   /**
  85     * signals thats the toplevel widget wishes to
  86     * output a new line.  The line is correctly
  87     * linefeed terminated, etc.
  88     */
  89   void outputLine(QByteArray);
  90   /**
  91     * open a new toplevel widget with for the
  92     * channel/user QString.
  93     */
  94   void open_toplevel(const KSircChannel &);
  95   /**
  96     * emittedon shutdown, indicating that
  97     * this window is closing. Refrence to outselves
  98     * is include.
  99     */
 100   void closing(KSircTopLevel *, QString channel);
 101   /**
 102    * emitted when the user typed /quit, will disconnect from this
 103    * server and close all toplevels belonging to it.
 104    */
 105   void requestQuit( const QByteArray& command );
 106   /**
 107     * emitted when we change channel name
 108     * on the fly.  old is the old channel name, new
 109     * is the new one.
 110     */
 111   void changeChannel(const QString &oldName, const QString &newName);
 112   /**
 113     * emitted to say that KSircTopLevel
 114     * (this) is now the window with focus.  Used by
 115     * servercontroller to set the !default window.
 116     */
 117   void currentWindow(KSircTopLevel *);
 118   /**
 119    * Stop updating list item sizes, majour changes comming through
 120    *
 121    */
 122   void freezeUpdates(bool);
 123   /**
 124    * Emitted when a new message appeared in the irc window
 125    */
 126   void changed(bool, QString);
 127
 128 public slots:
 129   /**
 130    * When enter is pressed, we read the SLE and output the results
 131    * after processing via emitting outputLine.
 132    */
 133   virtual void sirc_line_return(const QString &s);
 134
 135    /**
 136     * Clears the message window
 137     */
 138   void clearWindow();
 139
 140   /**
 141    * If the focus shifts this should get called with
 142    * the widget that just got focus.  Used in MDI modes
 143    * where the toplevel doesn't get focus in/out events.
 144    */
 145   void focusChange(QWidget *w);
 146
 147 protected slots:
 148     /**
 149       * When the rightMouse button is pressed in the nick list, popup
 150       * the User popup menu at his cursor location.
 151       */
 152    void UserSelected(int index);
 153    /**
 154      * Menu items was selected, now read the UserControlMenu and
 155      * reupdate the required menus.
 156      */
 157    void UserParseMenu(int id);
 158    /**
 159      * Page down accel key.  Tells the mainw to scroll down 1 page.
 160      */
 161    void AccelScrollDownPage();
 162    /**
 163      * Page Up accell key.  Tells the mainw to scroll down 1 page.
 164      */
 165    void AccelScrollUpPage();
 166    /**
 167      * Slot to termiate (close) the window.
 168      */
 169    void terminate() { close( true /*alsoDelete*/ ); }
 170    /**
 171      * Called when the user menu is finished and the popup menu needs
 172      * to be updated.
 173      */
 174    void UserUpdateMenu();
 175    /**
 176      * Open the new channel/window selector.
 177      */
 178    void newWindow();
 179    /**
 180      * We've received focus, let's make us the default, and issue a
 181      * /join such that we default to the right channel.
 182      */
 183    void gotFocus();
 184    /**
 185      * We've lost focus, set ourselves as loosing focus.
 186      */
 187    void lostFocus();
 188    /**
 189      * Create and popup the ticker.  Make sure to restore it to the
 190      * last position is was at.
 191      */
 192 //   void showTicker();
 193    /**
 194      * toggle the timestamp from the channel window menu (and with keyaccel)
 195      */
 196    void toggleTimestamp();
 197    /**
 198      * toggle the filtering of join/part message
 199      */
 200    void toggleFilterJoinPart();
 201
 202     /**
 203      * toggle the beep from the channel window menu (and with keyaccel)
 204      */
 205    void toggleBeep();
 206
 207    /**
 208     * show the dcc manager
 209     */
 210    void showDCCMgr();
 211
 212    /**
 213      * Delete the ticker and ppoup the main window
 214      */
 215 //   void unHide();
 216    /**
 217      * On a TAB key press we call TabNickCompletion which
 218      * reads the last thing in linee matches it with a nick and
 219      * puts it back into the line.
 220      */
 221    void TabNickCompletionShift();
 222    /**
 223      * On a TAB key press we call TabNickCompletion which
 224      * reads the last thing in linee matches it with a nick and
 225      * puts it back into the line.
 226      */
 227    void TabNickCompletionNormal();
 228
 229    /**
 230      * Signals a Line Change in linee
 231      */
 232    void lineeNotTab();
 233    /**
 234      *  Move the display to or from the root window
 235      *
 236      */
 237    void toggleRootWindow();
 238    /**
 239     * On a middle mouse button press we call pasteToWindow which
 240     * reads the clip board and pastes into the main listbox.
 241     */
 242    void pasteToWindow();
 243    /**
 244     * On a midle mouse button press to the nick list we open
 245     * a query window and paste the text there
 246     */
 247    void pasteToNickList(int button, Q3ListBoxItem *item, const QPoint &pos);
 248    /**
 249     * dnd paste to nick list
 250     */
 251    void dndTextToNickList(const Q3ListBoxItem *itom, const QString& text);
 252    /**
 253     * open a toplevel on double click
 254     */
 255    void openQueryFromNick(const QString &);
 256
 257    /**
 258     * Some text was dropped on the listbox
 259     */
 260    void slotTextDropped(const QString&);
 261
 262    /**
 263     * Calls slotDccURLs with the current nick we're talking to
 264     */
 265    void slotDropURLs(const QStringList& urls);
 266
 267    /**
 268     * Sends the list of urls to nick
 269     */
 270    void slotDccURLs(const QStringList& urls, const QString& nick );
 271
 272    /**
 273     * Re-apply color settings.
 274     */
 275    void initColors();
 276
 277    /**
 278    *  Dumps current content of mainw into a logfile
 279    */
 280    void saveCurrLog();
 281
 282     /**
 283      * Makes a beep when a change happens (if the user has this on)
 284      * the bool is TRUE if changed line contained user's nick
 285      */
 286    void doChange(bool, QString);
 287
 288    /**
 289     * show the ticker window
 290     */
 291    void toggleTicker();
 292
 293    /**
 294     * ksirc command menu clicked on
 295     */
 296    void cmd_process(int id);
 297
 298 protected:
 299    /**
 300      * On a TAB key press we call TabNickCompletion which
 301      * reads the last thing in linee matches it with a nick and
 302      * puts it back into the line.
 303      */
 304    void TabNickCompletion(int dir);
 305
 306    /**
 307     * Make sure to update colors correctly.
 308     */
 309    virtual bool event( QEvent *e);
 310
 311     /**
 312      * Redfine closeEvent to emit closing and delete itself.
 313      */
 314    virtual void closeEvent(QCloseEvent *);
 315    /**
 316      * Searches through the nick list and finds the nick with the best match.
 317      * which, arg2, selects nicks other than the first shouldarg1 match more
 318      * than 1 nick.
 319      */
 320    virtual QString findNick(QString, uint which = 0);
 321    /**
 322     * remove a nick from the prefered in nick completion list
 323     */
 324    virtual void removeCompleteNick(const QString &);
 325    /**
 326         * Adds a nick to the list of nicks to prefer in nick completion
 327         * or moves it to the top of the list if it was already there
 328         */
 329    virtual void addCompleteNick(const QString &);
 330    /**
 331         * Changes a nick in the completion list if it has been listed,
 332         * otherwise does nothing
 333         */
 334    virtual void changeCompleteNick(const QString &, const QString &);
 335
 336    virtual void setupCommandMenu();
 337
 338    /**
 339     * Returns true if this window is a private conversation (query or dcc chat)
 340     *, instead of a public chat in a channel or a special window.
 341     */
 342    bool isPrivateChat() const;
 343
 344    /**
 345     * Returns true if this is a public channel window
 346     */
 347    bool isPublicChat() const;
 348
 349    /**
 350     * Returns true if this is a special window
 351     */
 352    bool isSpecialWindow() const;
 353
 354 private slots:
 355     void setTopicIntern( const QString &topic );
 356     void insertText();
 357     void setMode(QString, int, QString currentNick=0);
 358     void setEncoding();
 359     void returnPressed();
 360     void toggleTopic();
 361
 362 private:
 363
 364     void outputUnicodeLine( const QString &message );
 365
 366     bool atBottom();
 367
 368     bool continued_line;
 369     charSelector *selector;
 370     chanButtons *channelButtons;
 371     QSplitter *pan;
 372     KVBox *nicks_box;
 373     KMenuBar *kmenu;
 374     QLabel *lag;
 375     enum {PING = 10, TOPIC = 20};
 376     KSircView *mainw;
 377     aHistLineEdit *linee;
 378     aListBox *nicks;
 379
 380     //QString m_currentNick;
 381
 382     //KSircProcess *proc;
 383
 384     int lines;
 385
 386     struct BufferedLine
 387     {
 388         BufferedLine() { wasBroadcast = false; }
 389         BufferedLine( const QString &msg, bool broadc )
 390             { message = msg; wasBroadcast = broadc; }
 391         bool operator==( const BufferedLine &other )
 392             { return message == other.message &&
 393                 wasBroadcast == other.wasBroadcast; }
 394
 395         QString message;
 396         bool wasBroadcast;
 397     };
 398
 399   bool Buffer;
 400   QList<BufferedLine> LineBuffer;
 401
 402   // QPopupMenu's used for the menubar
 403   Q3PopupMenu *file, *edit, *command;
 404
 405   bool parse_input(const QString &string, QString &plainText);
 406   void sirc_write(const QString &str);
 407
 408   Q3PopupMenu *user_controls;
 409   static Q3PtrList<UserControlMenu> *user_menu;
 410   int opami;
 411
 412   Q3Accel *accel;
 413
 414   /**
 415    * The channel name that we belong too.
 416    */
 417   //QString channel_name;
 418
 419   /**
 420     * Caption at the top of the window.
 421     */
 422   QString caption;
 423   /**
 424    * Current topic for the channel
 425    */
 426   QString m_topic;
 427
 428   /**
 429     * Does the window have focus? 1 when yes, 0 when no.
 430     */
 431   int have_focus;
 432
 433   /**
 434     * Number of time tab has been pressed.  Each time it's pressed
 435     * roll through the list of matching nicks.
 436     */
 437   int tab_pressed;
 438   /**
 439    * When tabs pressed save the line for use at a latter date.
 440    * tab_nick holds the last nick found so when a blank tab is pressed
 441    * we pop the last niick and ": " up.
 442     */
 443   QString tab_saved, tab_nick;
 444   int tab_start, tab_end;
 445
 446   // Ticker specific variables.
 447
 448   /**
 449     * Main pointer to ksticker.  Caution, it doesn't always exist!
 450     * Set to 0 ifwhen you delete it.
 451     */
 452   KSTicker *ticker;
 453   /**
 454     * Size and position of the main window. Main window is returns this
 455     * this position when it reappears.
 456     */
 457   QRect myrect;
 458   /**
 459     * Position of the main window
 460     */
 461   QPoint mypoint;
 462   /**
 463     * Ticker's size and geometry
 464     */
 465   QRect tickerrect;
 466   /**
 467     * Tickers position
 468     */
 469   QPoint tickerpoint;
 470   QSize  tickersize;
 471   /**
 472    * Do we have a kick window open?
 473    * Remember not to open 2
 474    */
 475   bool KickWinOpen;
 476
 477   /**
 478    * Hold an internal parser object which does all our parsing for us.
 479    * Since parsing an intergral part of TopLevel, it's also a friend
 480    * of ours
 481    */
 482   ChannelParser *ChanParser;
 483
 484   /**
 485    * QSize maintains size information in case it changes somehow
 486    */
 487   QSize current_size;
 488
 489   /**
 490    * ID of the timestamp menu item, to use in (un)checking it from slot
 491    */
 492   int tsitem;
 493
 494   /**
 495    * ID of the filter join/part menu item, to use in (un)checking it from slot
 496    */
 497   int fjpitem;
 498
 499   /**
 500    *  ID of the beep menu item, to use in (un)checking it from slot
 501    */
 502   int beepitem;
 503
 504   /**
 505    * ID of the toggle topic menu item, to use in (un)checking it from slot
 506    */
 507   int topicitem;
 508
 509   /**
 510    * ID of the show/hide ticker menu item
 511    */
 512   int tickeritem;
 513
 514   /**
 515    * List of nicks already used in nick completion to give them
 516    * higher priority
 517    */
 518   QStringList completeNicks;
 519
 520   /**
 521    * The time of the last beep to prevent your soundcard from detonating
 522    * in high traffic channels
 523    */
 524   QTime lastBeep;
 525
 526   KSircTopic *ksTopic;
 527
 528   LogFile *logFile;
 529
 530   KSelectAction *encodingAction;
 531
 532   static QStringList cmd_menu;
 533
 534   bool m_gotMsgWithoutFocus;
 535
 536   KSircChannel m_channelInfo;
 537
 538 };
 539
 540 #endif
 541
 542 // vim: ts=2 sw=2 et