Added set/get enabled Account class methods.

[python-purple] / account.pyx

diff --git a/account.pyx b/account.pyx
index d5f5ef2..78fac03 100644 (file)
--- a/account.pyx
+++ b/account.pyx
@@ -116,7 +116,21 @@ cdef class Account:
             return None
     remember_password = property(__get_remember_password)
 
+    def __get_enabled(self):
+        if self.__exists:
+            return account.purple_account_get_enabled(self._get_structure(), \
+                    self.core.ui_name)
+        else:
+            return None
+    enabled = property(__get_enabled)
+
     def set_username(self, username):
+        """
+        Sets the account's username.
+
+        @param username The username
+        @return True if successful, False if account doesn't exists
+        """
         if self.__exists:
             account.purple_account_set_username(self._get_structure(), \
                     username)
@@ -125,6 +139,12 @@ cdef class Account:
             return False
 
     def set_protocol_id(self, protocol_id):
+        """
+        Sets the account's protocol ID.
+
+        @param protocol_id The protocol ID
+        @return True if successful, False if account doesn't exists
+        """
         if self.__exists:
             self.__protocol._set_protocol_id(protocol_id)
             return True
@@ -132,6 +152,12 @@ cdef class Account:
             return False
 
     def set_password(self, password):
+        """
+        Sets the account's password.
+
+        @param password The password
+        @return True if successful, False if account doesn't exists
+        """
         if self.__exists:
             account.purple_account_set_password(self._get_structure(), \
                     password)
@@ -140,6 +166,12 @@ cdef class Account:
             return False
 
     def set_alias(self, alias):
+        """
+        Sets the account's alias
+
+        @param alias The alias
+        @return True if successful, False if account doesn't exists
+        """
         if self.__exists:
             account.purple_account_set_alias(self._get_structure(), \
                     alias)
@@ -148,6 +180,12 @@ cdef class Account:
             return False
 
     def set_user_info(self, user_info):
+        """
+        Sets the account's user information
+
+        @param user_info The user information
+        @return True if successful, False if account doesn't exists
+        """
         if self.__exists:
             account.purple_account_set_user_info(self._get_structure(), \
                     user_info)
@@ -156,6 +194,13 @@ cdef class Account:
             return False
 
     def set_remember_password(self, remember_password):
+        """
+        Sets whether or not this account should save its password.
+
+        @param remember_password True if should remember the password,
+                                 or False otherwise
+        @return True if successful, False if account doesn't exists
+        """
         if self.__exists:
             account.purple_account_set_remember_password( \
                 self._get_structure(), remember_password)
@@ -163,10 +208,53 @@ cdef class Account:
         else:
             return False
 
+    def set_enabled(self, value):
+        """
+        Sets wheter or not this account is enabled.
+
+        @param value True if it is enabled, or False otherwise
+        @return True if successful, False if account doesn't exists
+        """
+        if self.__exists:
+            account.purple_account_set_enabled(self._get_structure(), \
+                    self.core.ui_name, bool(value))
+            return True
+        else:
+            return False
+
     def new(self):
+        """
+        Creates a new account.
+
+        @return True if successful, False if account already exists
+        """
         if self.__exists:
             return False
         else:
             account.purple_account_new(self.username, self.protocol_id)
             self.__exists = True
             return True
+
+    def connect(self):
+        """
+        Connects to an account.
+
+        @return True if successful, False if account doesn't exists
+        """
+        if self.__exists:
+            account.purple_account_connect(self._get_structure())
+            return True
+        else:
+            return False
+
+    def disconnect(self):
+        """
+        Disconnects from an account.
+
+        @return True if successful, False if account doesn't exists
+        """
+        if self.__exists:
+            account.purple_account_disconnect(self._get_structure())
+            return True
+        else:
+            return False