• Skip to content
• Skip to link menu

KDE 3.5 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

KDECore

kurl.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
 *  Copyright (C) 1999 Torben Weis <weis@kde.org>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  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., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 **/

#ifndef __kurl_h__
#define __kurl_h__

#include <qstring.h>
#include <qvaluelist.h>
#include "kdelibs_export.h"

class QUrl;
class QStringList;
template <typename K, typename V> class QMap;

class KURLPrivate;

// Defines that file-urls look like file:///path/file instead of file:/path/file
#define KURL_TRIPLE_SLASH_FILE_PROT

class KDECORE_EXPORT KURL
{
public:
  enum AdjustementFlags
  {
    NoAdjustements = 0,
    StripFileProtocol = 1
  };

  enum URIMode
  {
    Auto,
    Invalid,
    RawURI,
    URL,
    Mailto
  };

  class KDECORE_EXPORT List : public QValueList<KURL>
  {
  public:
      List() { }
      List(const KURL &url);
      List(const QStringList &list);
      QStringList toStringList() const;
  };
  KURL();

  ~KURL();

  KURL( const QString& url, int encoding_hint = 0 );
  KURL( const char * url, int encoding_hint = 0 );
  KURL( const QCString& url, int encoding_hint = 0 );

  KURL( const KURL& u );
  KURL( const QUrl &u );
  KURL( const KURL& _baseurl, const QString& _rel_url, int encoding_hint=0 );

  QString protocol() const { return m_bIsMalformed ? QString::null : m_strProtocol; }
  void setProtocol( const QString& _txt );

  int uriMode() const;

  QString user() const { return m_strUser; }
  void setUser( const QString& _txt );
  bool hasUser() const { return !m_strUser.isEmpty(); }

  QString pass() const { return m_strPass; }
  void setPass( const QString& _txt );
  bool hasPass() const { return !m_strPass.isEmpty(); }

  QString host() const { return m_strHost; }

  void setHost( const QString& _txt );
  bool hasHost() const { return !m_strHost.isEmpty(); }

  unsigned short int port() const { return m_iPort; }
  void setPort( unsigned short int _p );

  QString path() const  { return m_strPath; }

  QString path( int _trailing ) const;

  void setPath( const QString& path );

  bool hasPath() const { return !m_strPath.isEmpty(); }

  void cleanPath(bool cleanDirSeparator = true);

  void adjustPath(int _trailing);

  void setEncodedPathAndQuery( const QString& _txt, int encoding_hint = 0 );

  void setEncodedPath(const QString& _txt, int encoding_hint = 0 );

  QString encodedPathAndQuery( int _trailing = 0, bool _no_empty_path = false, int encoding_hint = 0) const;

  void setQuery( const QString& _txt, int encoding_hint = 0);

  QString query() const;

  QString ref() const { return m_strRef_encoded; }

  void setRef( const QString& _txt ) { m_strRef_encoded = _txt; }

  bool hasRef() const { return !m_strRef_encoded.isNull(); }

  QString htmlRef() const;

  QString encodedHtmlRef() const;

  void setHTMLRef( const QString& _ref );

  bool hasHTMLRef() const;

  bool isValid() const  { return !m_bIsMalformed; }
  KDE_DEPRECATED bool isMalformed() const { return !isValid(); }

  bool isLocalFile() const;

  void setFileEncoding(const QString &encoding);

  QString fileEncoding() const;

  bool hasSubURL() const;

  void addPath( const QString& txt );

  QString queryItem( const QString& item ) const;

  QString queryItem( const QString& item, int encoding_hint ) const;

  enum QueryItemsOptions
  {
    CaseInsensitiveKeys = 1
  };

  QMap< QString, QString > queryItems( int options=0 ) const;

  QMap< QString, QString > queryItems( int options, int encoding_hint ) const;

  void addQueryItem( const QString& _item, const QString& _value, int encoding_hint = 0 );

  void removeQueryItem( const QString& _item );

  void setFileName( const QString&_txt );

  QString fileName( bool _ignore_trailing_slash_in_path = true ) const;

  QString directory( bool _strip_trailing_slash_from_result = true,
             bool _ignore_trailing_slash_in_path = true ) const;

  void setDirectory(const QString &dir);

  bool cd( const QString& _dir );

  QString url( int _trailing = 0, int encoding_hint = 0) const;

  QString prettyURL( int _trailing = 0) const;

  QString prettyURL( int _trailing, AdjustementFlags _flags) const;
  // ### BIC: Merge the two above + spell it as "Adjustment"
  // Or remove completely, and let people use pathOrURL() instead

  QString pathOrURL() const;

  QString htmlURL() const;


  bool isEmpty() const;

  KURL upURL( ) const;

  bool operator<(const KURL& _u) const;

  KURL& operator=( const KURL& _u );

  KURL& operator=( const QString& _url );

  KURL& operator=( const char * _url );

  KURL& operator=( const QUrl & u );

  bool operator==( const KURL& _u ) const;

  bool operator==( const QString& _u ) const;

  bool operator!=( const KURL& _u ) const { return !( *this == _u ); }

  bool operator!=( const QString& _u ) const { return !( *this == _u ); }

  bool cmp( const KURL &u, bool ignore_trailing = false ) const KDE_DEPRECATED;

  bool equals( const KURL &u, bool ignore_trailing = false ) const; // TODO KDE4: add bool _ignore_ref = false

  bool isParentOf( const KURL& u ) const;

  static List split( const QString& _url );

  static List split( const KURL& _url );

  static KURL join( const List& _list );

  static KURL fromPathOrURL( const QString& text );

  static QString encode_string(const QString &str, int encoding_hint = 0);

  static QString encode_string_no_slash(const QString &str, int encoding_hint = 0);

  static QString decode_string(const QString &str, int encoding_hint = 0);

  static bool isRelativeURL(const QString &_url);

  static QString relativeURL(const KURL &base_url, const KURL &url, int encoding_hint = 0);

  static QString relativePath(const QString &base_dir, const QString &path, bool *isParent=0);

  static URIMode uriModeForProtocol(const QString& protocol);

#ifdef KDE_NO_COMPAT
private:
#endif

    QString filename( bool _ignore_trailing_slash_in_path = true ) const
  {
    return fileName(_ignore_trailing_slash_in_path);
  }

protected:
  void reset();
  
  void parseURL( const QString& _url, int encoding_hint = 0 );
  void parseRawURI( const QString& _url, int encoding_hint = 0 );
  void parseMailto( const QString& _url, int encoding_hint = 0 );
  void parse( const QString& _url, int encoding_hint = 0 );

private:
  void _setQuery( const QString& _txt, int encoding_hint = 0);

  QString m_strProtocol;
  QString m_strUser;
  QString m_strPass;
  QString m_strHost;
  QString m_strPath;
  QString m_strRef_encoded;
  QString m_strQuery_encoded;
  bool m_bIsMalformed : 1;
  enum URIMode m_iUriMode : 3;
  uint freeForUse     : 4;
  unsigned short int m_iPort;
  QString m_strPath_encoded;

  friend KDECORE_EXPORT QDataStream & operator<< (QDataStream & s, const KURL & a);
  friend KDECORE_EXPORT QDataStream & operator>> (QDataStream & s, KURL & a);
private:
  KURLPrivate* d;
};

KDECORE_EXPORT bool urlcmp( const QString& _url1, const QString& _url2 );

KDECORE_EXPORT bool urlcmp( const QString& _url1, const QString& _url2, bool _ignore_trailing, bool _ignore_ref );

KDECORE_EXPORT QDataStream & operator<< (QDataStream & s, const KURL & a);
KDECORE_EXPORT QDataStream & operator>> (QDataStream & s, KURL & a);

#endif

KDECore

Skip menu "KDECore"

• Main Page
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages

API Reference

Skip menu "API Reference"

• dcop
• DNSSD
• interfaces
• Kate
• kconf_update
• KDECore
• KDED
• kdefx
• KDEsu
• kdeui
• KDocTools
• KHTML
• KImgIO
• KInit
• kio
• kioslave
• KJS
• KNewStuff
• KParts
• KUtils

Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal