Add documentation to isStatusMsg

[quassel.git] / src / common / network.h

diff --git a/src/common/network.h b/src/common/network.h
index 01e6158..e425701 100644 (file)
--- a/src/common/network.h
+++ b/src/common/network.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2014 by the Quassel Project                        *
+ *   Copyright (C) 2005-2015 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -132,6 +132,18 @@ public :
 
     bool isChannelName(const QString &channelname) const;
 
+    /**
+     * Checks if the target counts as a STATUSMSG
+     *
+     * Status messages are prefixed with one or more characters from the server-provided STATUSMSG
+     * if available, otherwise "@" and "+" are assumed.  Generally, status messages sent to a
+     * channel are only visible to those with the same or higher permissions, e.g. voiced.
+     *
+     * @param[in] target Name of destination, e.g. a channel or query
+     * @returns True if a STATUSMSG, otherwise false
+     */
+    bool isStatusMsg(const QString &target) const;
+
     inline bool isConnected() const { return _connected; }
     //Network::ConnectionState connectionState() const;
     inline int connectionState() const { return _connectionState; }
@@ -213,10 +225,6 @@ public :
     inline bool autoAwayActive() const { return _autoAwayActive; }
     inline void setAutoAwayActive(bool active) { _autoAwayActive = active; }
 
-    static QStringList presetNetworks(bool onlyDefault = false);
-    static QStringList presetDefaultChannels(const QString &networkName);
-    static NetworkInfo networkInfoFromPreset(const QString &networkName);
-
 public slots:
     void setNetworkName(const QString &networkName);
     void setCurrentServer(const QString &currentServer);
@@ -372,8 +380,6 @@ private:
 
     bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
 
-    static QString _networksIniPath;
-
     friend class IrcUser;
     friend class IrcChannel;
 };