Source: global.h

# Source: global.h |
Annotated List
Files
Globals
Hierarchy
Index

    /* This file is part of the KDE libraries
       Copyright (C) 2000 David Faure

       This library is free software; you can redistribute it and/or
       modify it under the terms of the GNU Library General Public
       License version 2 as published by the Free Software Foundation.

       This library is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
       Library General Public License for more details.

       You should have received a copy of the GNU Library General Public License
       along with this library; see the file COPYING.LIB.  If not, write to
       the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
       Boston, MA 02111-1307, USA.
    */
    #ifndef __global_h__
    #define __global_h__ "$Id: global.h,v 1.54.2.2 2003/05/17 11:19:22 mueller Exp $"

    #include
    #include
    #include
    #include
    #include
    #include

    #include

    /**
     * @short A namespace for KIO globals
     *
     */
    namespace KIO
    {
      typedef signed long long int fileoffset_t;
      typedef unsigned long long int filesize_t;

      /**
       * Converts @p size from bytes to the string representation.
       *
       * @param  size  size in bytes
       * @return converted size as a string - e.g. 123.4 kB , 12.0 MB
       */
      QString convertSize( KIO::filesize_t size );

      /**
       * Converts a size to a string representation
       * Not unlike QString::number(...)
       *
       * @param size size in bytes
       * @return  converted size as a string - e.g. 123456789
       */
      QString number( KIO::filesize_t size );

      /**
       * Converts size from kilo-bytes to the string representation.
       *
       * @param  size  size in kilo-bytes
       * @return converted size as a string - e.g. 123.4 kB , 12.0 MB
       */
       QString convertSizeFromKB( KIO::filesize_t kbSize );

      /**
       * Calculates remaining time from total size, processed size and speed.
       *
       * @param  totalSize      total size in bytes
       * @param  processedSize  processed size in bytes
       * @param  speed          speed in bytes pre second
       * @return calculated remaining time
       */
      QTime calculateRemaining( KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed );

      /**
       * Helper for showing information about a set of files and directories
       * @p items = @p files + @p dirs + number of symlinks :)
       * @param size the sum of the size of the _files_
       * @param showSize whether to show the size in the result
       */
      QString itemsSummaryString(uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize);

      /**
       * Encodes (from the text displayed to the real filename)
       * This translates % into %% and / into %2f
       * Used by KIO::link, for instance.
       */
      QString encodeFileName( const QString & str );
      /**
       * Decodes (from the filename to the text displayed)
       * This translates %2[fF] into / and %% into %
       */
      QString decodeFileName( const QString & str );

      /**
       * Error codes that can be emitted by KIO.
       */
      enum Error {
        ERR_CANNOT_OPEN_FOR_READING = 1,
        ERR_CANNOT_OPEN_FOR_WRITING = 2,
        ERR_CANNOT_LAUNCH_PROCESS = 3,
        ERR_INTERNAL = 4,
        ERR_MALFORMED_URL = 5,
        ERR_UNSUPPORTED_PROTOCOL = 6,
        ERR_NO_SOURCE_PROTOCOL = 7,
        ERR_UNSUPPORTED_ACTION = 8,
        ERR_IS_DIRECTORY = 9, // ... where a file was expected
        ERR_IS_FILE = 10, // ... where a directory was expected (e.g. listing)
        ERR_DOES_NOT_EXIST = 11,
        ERR_FILE_ALREADY_EXIST = 12,
        ERR_DIR_ALREADY_EXIST = 13,
        ERR_UNKNOWN_HOST = 14,
        ERR_ACCESS_DENIED = 15,
        ERR_WRITE_ACCESS_DENIED = 16,
        ERR_CANNOT_ENTER_DIRECTORY = 17,
        ERR_PROTOCOL_IS_NOT_A_FILESYSTEM = 18,
        ERR_CYCLIC_LINK = 19,
        ERR_USER_CANCELED = 20,
        ERR_CYCLIC_COPY = 21,
        ERR_COULD_NOT_CREATE_SOCKET = 22,
        ERR_COULD_NOT_CONNECT = 23,
        ERR_CONNECTION_BROKEN = 24,
        ERR_NOT_FILTER_PROTOCOL = 25,
        ERR_COULD_NOT_MOUNT = 26,
        ERR_COULD_NOT_UNMOUNT = 27,
        ERR_COULD_NOT_READ = 28,
        ERR_COULD_NOT_WRITE = 29,
        ERR_COULD_NOT_BIND = 30,
        ERR_COULD_NOT_LISTEN = 31,
        ERR_COULD_NOT_ACCEPT = 32,
        ERR_COULD_NOT_LOGIN = 33,
        ERR_COULD_NOT_STAT = 34,
        ERR_COULD_NOT_CLOSEDIR = 35,
        ERR_COULD_NOT_MKDIR = 37,
        ERR_COULD_NOT_RMDIR = 38,
        ERR_CANNOT_RESUME = 39,
        ERR_CANNOT_RENAME = 40,
        ERR_CANNOT_CHMOD = 41,
        ERR_CANNOT_DELETE = 42,
        // The text argument is the protocol that the dead slave supported.
        // This means for example: file, ftp, http, ...
        ERR_SLAVE_DIED = 43,
        ERR_OUT_OF_MEMORY = 44,
        ERR_UNKNOWN_PROXY_HOST = 45,
        ERR_COULD_NOT_AUTHENTICATE = 46,
        ERR_ABORTED = 47, // Action got aborted from application side
        // ERR_WARNING, // Errors terminate the job now. Use warning() instead.
        ERR_INTERNAL_SERVER = 48,
        ERR_SERVER_TIMEOUT = 49,
        ERR_SERVICE_NOT_AVAILABLE = 50,
        ERR_UNKNOWN = 51,
        // (was a warning) ERR_CHECKSUM_MISMATCH = 52,
        ERR_UNKNOWN_INTERRUPT = 53,
        ERR_CANNOT_DELETE_ORIGINAL = 54,
        ERR_CANNOT_DELETE_PARTIAL = 55,
        ERR_CANNOT_RENAME_ORIGINAL = 56,
        ERR_CANNOT_RENAME_PARTIAL = 57,
        ERR_NEED_PASSWD = 58,
        ERR_CANNOT_SYMLINK = 59,
        ERR_NO_CONTENT = 60, // Action succeeded but no content will follow.
        ERR_DISK_FULL = 61,
        ERR_IDENTICAL_FILES = 62, // src==dest when moving/copying
        ERR_SLAVE_DEFINED = 63, // for slave specified errors that can be
                                // rich text.  Email links will be handled
                                // by the standard email app and all hrefs
                                // will be handled by the standard browser.
                                //  UDSEntry;
    typedef QValueList UDSEntryList;
    typedef QValueListIterator UDSEntryListIterator;
    typedef QValueListConstIterator UDSEntryListConstIterator;

    class MetaData : public QMap
    {
    public:
       MetaData() : QMap() { };
       MetaData(const QMap&metaData) :
         QMap(metaData) { };

       MetaData & operator+= ( const QMap &metaData )
       {
          QMap::ConstIterator it;
          for( it = metaData.begin();
               it !=  metaData.end();
               ++it)
          {
             replace(it.key(), it.data());
          }
          return *this;
       }
    };

    }
    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:57 2003, using kdoc 2.0a54.