• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • KDevelop Utility Library
 

KDevelop Utility Library

  • lib
  • util
rurl.h
Go to the documentation of this file.
1#ifndef RURL_H_LIB
2#define RURL_H_LIB
3
4#include <kurl.h>
5
10
12namespace Relative
13{
14
16class Name{
17public:
18 enum Type { File, Directory, Auto };
19
26 Name(const TQString &rurl, const Type type = Auto);
27 Name(const char *rurl, const Type type = Auto);
28
30 void setRURL(const TQString &rurl, const Type type);
35 TQString rurl() const;
36
40 void addPath(const TQString &addendum);
42 void cleanRURL();
43
47 TQString extension(bool complete = true) const;
50 TQString fileName() const;
52 TQString directory() const;
53
55 bool isFile() const;
57 bool isDirectory() const;
59 bool isValid() const;
60
62 Type type() const;
65 void setType(const Type type);
66
69 static Name relativeName(const TQString &base, const TQString &url);
71 static TQString cleanName(const TQString &rurl);
74 static TQString correctName(const TQString &rurl, const Type type = Auto);
75
76 bool operator == (const Name &rname);
77 bool operator != (const Name &rname);
78
79protected:
83 void correct();
84
85private:
86 TQString m_rurl;
87 Type m_type;
88};
89
91class URL: public Name{
92public:
97 URL(KURL base, KURL url, Type type = Auto);
100 URL(KURL base, TQString url, bool isUrlRelative, Type type = Auto);
101
103 void setBase(const KURL &base);
106 void setBase(const TQString &base);
108 KURL base() const;
110 TQString basePath() const;
111
118 KURL url() const;
123 TQString urlPath() const;
129 TQString urlDirectory() const;
130
133 URL relativeTo(KURL base);
134
136 static URL relativeURL(KURL base, KURL url);
139 static URL relativeURL(KURL base, TQString url, bool isUrlRelative);
140
141 bool operator == (const URL &url);
142 bool operator != (const URL &url);
143
144private:
145 KURL m_base;
146};
147
149class Directory: public URL{
150public:
152 Directory(KURL base, KURL url);
154 Directory(KURL base, TQString url, bool isRelativeUrl);
155
157 void setRURL(TQString rurl);
158
159private:
160 void setRURL(TQString rurl, Type type);
161
162};
163
165class File: public URL{
166public:
168 File(KURL base, KURL url);
170 File(KURL base, TQString url, bool isRelativeUrl);
171
173 void setRURL(TQString rurl);
174
175private:
176 void setRURL(TQString rurl, Type type);
177
178};
179
180}
181
182#endif
Relative::Directory::setRURL
void setRURL(TQString rurl)
Works as URL::setRURL(TQString), only implies Name::Directory mode.
Definition rurl.cpp:335
Relative::Directory::Directory
Directory(KURL base, KURL url)
Works as URL::URL(KURL, KURL), only implies Name::Directory mode.
Definition rurl.cpp:325
Relative::File::File
File(KURL base, KURL url)
Works as URL::URL(KURL, KURL), only implies Name::File mode.
Definition rurl.cpp:349
Relative::File::setRURL
void setRURL(TQString rurl)
Works as URL::setRURL(TQString), only implies Name::File mode.
Definition rurl.cpp:364
Relative::Name::addPath
void addPath(const TQString &addendum)
Adds addendum to the directory path.
Definition rurl.cpp:80
Relative::Name::correctName
static TQString correctName(const TQString &rurl, const Type type=Auto)
Corrects rurl according to the given type and returns corrected url.
Definition rurl.cpp:46
Relative::Name::relativeName
static Name relativeName(const TQString &base, const TQString &url)
Creates and returns relative name between base and url.
Definition rurl.cpp:184
Relative::Name::fileName
TQString fileName() const
Returns the name of the file without the path or TQString() for directories.
Definition rurl.cpp:123
Relative::Name::cleanName
static TQString cleanName(const TQString &rurl)
Cleans rurl by removing extra slashes.
Definition rurl.cpp:91
Relative::Name::Name
Name(const TQString &rurl, const Type type=Auto)
Constructor takes the relative name of a directory or file.
Definition rurl.cpp:10
Relative::Name::extension
TQString extension(bool complete=true) const
Returns the extension of a file or TQString() for directories.
Definition rurl.cpp:110
Relative::Name::isDirectory
bool isDirectory() const
Returns true if the type of RName is directory.
Definition rurl.cpp:143
Relative::Name::isValid
bool isValid() const
Checks if RName is valid.
Definition rurl.cpp:158
Relative::Name::setRURL
void setRURL(const TQString &rurl, const Type type)
Sets the relative name.
Definition rurl.cpp:68
Relative::Name::rurl
TQString rurl() const
Gets the relative name in form dir/dir/ -> directory or dir/dir/file -> file.
Definition rurl.cpp:75
Relative::Name::setType
void setType(const Type type)
Sets a type of the relative name - file or directory.
Definition rurl.cpp:179
Relative::Name::correct
void correct()
Corrects m_rurl and m_type according to the relative name storing policy, i.e.
Definition rurl.cpp:22
Relative::Name::type
Type type() const
Returns a type of the relative name - file or directory.
Definition rurl.cpp:174
Relative::Name::directory
TQString directory() const
Returns the name of the directory or TQString() if there are no dirs in path.
Definition rurl.cpp:130
Relative::Name::isFile
bool isFile() const
Returns true if the type of RName is file.
Definition rurl.cpp:138
Relative::Name::cleanRURL
void cleanRURL()
Removes "//" from the name.
Definition rurl.cpp:86
Relative::URL::urlPath
TQString urlPath() const
Returns a path of a complete url to the location.
Definition rurl.cpp:275
Relative::URL::relativeTo
URL relativeTo(KURL base)
Returns a new URL that is relative to given base.
Definition rurl.cpp:296
Relative::URL::basePath
TQString basePath() const
Returns a path of a base KURL (using KURL::path()).
Definition rurl.cpp:262
Relative::URL::relativeURL
static URL relativeURL(KURL base, KURL url)
Returns a new relative URL constructed from base and given url.
Definition rurl.cpp:301
Relative::URL::setBase
void setBase(const KURL &base)
Sets a new base for a RURL.
Definition rurl.cpp:245
Relative::URL::urlDirectory
TQString urlDirectory() const
Returns a directory of a complete url to the location.
Definition rurl.cpp:288
Relative::URL::base
KURL base() const
Returns RURL base.
Definition rurl.cpp:257
Relative::URL::URL
URL(KURL base, KURL url, Type type=Auto)
Evaluates the relative path between url and base and creates RURL object.
Definition rurl.cpp:235
Relative::URL::url
KURL url() const
Returns a complete url to the RURL location.
Definition rurl.cpp:267
Relative
Classes and functions to work with relative URLs.
Definition rurl.cpp:5

KDevelop Utility Library

Skip menu "KDevelop Utility Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

KDevelop Utility Library

Skip menu "KDevelop Utility Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for KDevelop Utility Library by doxygen 1.15.0
This website is maintained by Timothy Pearson.