• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kio/kio
 

kio/kio

  • kio
  • kio
kfileitem.h
1 /* This file is part of the KDE project
2  Copyright (C) 1999 David Faure <faure@kde.org>
3 
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef __kfileitem_h__
21 #define __kfileitem_h__
22 
23 #include <tqstringlist.h>
24 #include <sys/stat.h>
25 
26 #include <tqptrlist.h>
27 #include <kio/global.h>
28 #include <kurl.h>
29 #include <kacl.h>
30 #include <kmimetype.h>
31 #include <kfilemetainfo.h>
32 
33 #define KFILEITEM_HAS_ISWRITABLE // only used in libkonq/konq_iconviewwidget.cc, will be removed for 3.4
34 
41 class KIO_EXPORT KFileItem
42 {
43 public:
44  enum { Unknown = (mode_t) - 1 };
45 
57  KFileItem( const KIO::UDSEntry& _entry, const KURL& _url,
58  bool _determineMimeTypeOnDemand = false,
59  bool _urlIsDirectory = false );
60 
74  KFileItem( mode_t _mode, mode_t _permissions, const KURL& _url,
75  bool _determineMimeTypeOnDemand = false );
76 
83  KFileItem( const KURL &url, const TQString &mimeType, mode_t mode );
84 
89  KFileItem( const KFileItem &item );
90 
95  virtual ~KFileItem();
96 
101  void refresh();
102 
107  void refreshMimeType();
108 
113  const KURL & url() const { return m_url; }
114 
120  void setURL( const KURL &url );
121 
128  void setName( const TQString &name );
129 
134  mode_t permissions() const { return m_permissions; }
135 
140  TQString permissionsString() const;
141 
147  bool hasExtendedACL() const;
148 
154  KACL ACL() const;
155 
161  KACL defaultACL() const;
162 
167  mode_t mode() const { return m_fileMode; }
168 
173  TQString user() const;
174 
179  TQString group() const;
180 
186  bool isLink() const { return m_bLink; }
187 
192  bool isDir() const;
193 
198  bool isFile() const { return !isDir(); }
199 
206  bool isReadable() const;
207 
215  bool isWritable() const;
216 
221  bool isHidden() const;
222 
227  TQString linkDest() const;
228 
235  TQString localPath() const;
236 
237  //FIXME KDE4 deprecate this in favor of size(bool &hasSize)
242  KIO::filesize_t size() const;
243 
249  KIO::filesize_t size(bool &hasSize) const;
250 
251  //FIXME KDE4 deprecate this in favor of time(unsigned int which, bool &hasSize)
258  time_t time( unsigned int which ) const;
259 
267  time_t time( unsigned int which, bool &hasTime ) const;
268 
276  TQString timeString( unsigned int which = KIO::UDS_MODIFICATION_TIME ) const;
277 
282  bool isLocalFile() const { return m_bIsLocalURL; }
283 
289  const TQString& text() const { return m_strText; }
290 
298  const TQString& name( bool lowerCase = false ) const {
299  if ( !lowerCase )
300  return m_strName;
301  else
302  if ( m_strLowerCaseName.isNull() )
303  m_strLowerCaseName = m_strName.lower();
304  return m_strLowerCaseName;
305  }
306 
313  TQString mimetype() const;
314 
321  TQString mimetypeFast() const;
322 
329  KMimeType::Ptr mimeTypePtrFast();
330 
337  KMimeType::Ptr determineMimeType();
338 
344  KMimeType::Ptr mimeTypePtr() const { return m_pMimeType; }
345 
346  bool isMimeTypeKnown() const;
352  TQString mimeComment();
353 
359  TQString iconName();
360 
369  TQPixmap pixmap( int _size, int _state=0 ) const;
370 
377  int overlays() const;
378 
384  TQString getStatusBarInfo();
385 
394  TQString getToolTipText(int maxcount = 6);
395 
402  bool acceptsDrops( );
403 
408  void run();
409 
415  const KIO::UDSEntry & entry() const { return m_entry; }
416 
421  bool isMarked() const { return m_bMarked; }
426  void mark() { m_bMarked = true; }
431  void unmark() { m_bMarked = false; }
432 
438  bool cmp( const KFileItem & item );
439 
473  virtual void setExtraData( const void *key, void *value );
474 
482  virtual const void * extraData( const void *key ) const;
483 
491  virtual void * extraData( const void *key );
492 
497  virtual void removeExtraData( const void *key );
498 
503  void setMetaInfo( const KFileMetaInfo & info );
504 
512  void setFileMode( mode_t m );
513 
519  void setMimeType( const TQString& mimetype );
520 
526  const KFileMetaInfo & metaInfo(bool autoget = true,
527  int what = KFileMetaInfo::Fastest) const;
528 
536  void assign( const KFileItem & item );
537 
555  void setUDSEntry( const KIO::UDSEntry& entry, const KURL& url,
556  bool determineMimeTypeOnDemand = false,
557  bool urlIsDirectory = false );
558 
562  KFileItem& operator=( const KFileItem& );
563 
568  KURL mostLocalURL(bool &local) const;
569 
571 
572 protected:
577  void init( bool _determineMimeTypeOnDemand );
578 
584  void readUDSEntry( bool _urlIsDirectory );
585 
589  TQString parsePermissions( mode_t perm ) const;
590 
591 private:
595  KIO::UDSEntry m_entry;
599  KURL m_url;
600 
604  TQString m_strName;
605 
610  TQString m_strText;
611 
615  mutable TQString m_user, m_group;
616 
620  mutable TQString m_strLowerCaseName;
621 
625  KMimeType::Ptr m_pMimeType;
626 
630  mode_t m_fileMode;
634  mode_t m_permissions;
635 
639  bool m_bMarked:1;
643  bool m_bLink:1;
647  bool m_bIsLocalURL:1;
648 
649  bool m_bMimeTypeKnown:1;
650 
651  // Auto: check leading dot.
652  enum { Auto, Hidden, Shown } m_hidden:3;
653 
654  // For special case like link to dirs over FTP
655  TQString m_guessedMimeType;
656  mutable TQString m_access;
657  TQMap<const void*, void*> m_extra;
658  mutable KFileMetaInfo m_metaInfo;
659 
660  enum { Modification = 0, Access = 1, Creation = 2, NumFlags = 3 };
661  mutable time_t m_time[3];
662  mutable KIO::filesize_t m_size;
663 
664 protected:
665  virtual void virtual_hook( int id, void* data );
666 private:
667  class KFileItemPrivate;
668  KFileItemPrivate * d;
669  KIO_EXPORT friend TQDataStream & operator<< ( TQDataStream & s, const KFileItem & a );
670  KIO_EXPORT friend TQDataStream & operator>> ( TQDataStream & s, KFileItem & a );
671 };
672 
676 typedef TQPtrList<KFileItem> KFileItemList;
677 
681 typedef TQPtrListIterator<KFileItem> KFileItemListIterator;
682 
683 KIO_EXPORT TQDataStream & operator<< ( TQDataStream & s, const KFileItem & a );
684 KIO_EXPORT TQDataStream & operator>> ( TQDataStream & s, KFileItem & a );
685 
686 
687 #endif
KFileItem::isLocalFile
bool isLocalFile() const
Returns true if the file is a local file.
Definition: kfileitem.h:282
KFileItem::isMarked
bool isMarked() const
Used when updating a directory.
Definition: kfileitem.h:421
KFileItem::url
const KURL & url() const
Returns the url of the file.
Definition: kfileitem.h:113
KFileMetaInfo::Fastest
do the fastest possible read and omit all items that might need a significantly longer time than the ...
Definition: kfilemetainfo.h:940
KFileItem::mode
mode_t mode() const
Returns the file type (stat.st_mode containing only S_IFDIR, S_IFLNK, ...).
Definition: kfileitem.h:167
KIO::UDS_MODIFICATION_TIME
The last time the file was modified.
Definition: global.h:357
KFileItem::permissions
mode_t permissions() const
Returns the permissions of the file (stat.st_mode containing only permissions).
Definition: kfileitem.h:134
KFileItem::mark
void mark()
Marks the item.
Definition: kfileitem.h:426
KIO::UDSEntry
TQValueList< UDSAtom > UDSEntry
An entry is the list of atoms containing all the information for a file or URL.
Definition: global.h:506
KFileMetaInfo
Meta Information about a file.
Definition: kfilemetainfo.h:926
KIO::filesize_t
TQ_ULLONG filesize_t
64-bit file size
Definition: global.h:39
KFileItem::text
const TQString & text() const
Returns the text of the file item.
Definition: kfileitem.h:289
KFileItem::name
const TQString & name(bool lowerCase=false) const
Return the name of the file item (without a path).
Definition: kfileitem.h:298
KFileItem::isLink
bool isLink() const
Returns true if this item represents a link in the UNIX sense of a link.
Definition: kfileitem.h:186
KACL
The KCAL class encapsulates a POSIX Access Control List.
Definition: kacl.h:42
KFileItem::mimeTypePtr
KMimeType::Ptr mimeTypePtr() const
Returns the currently known mimetype of the file item.
Definition: kfileitem.h:344
KFileItem::unmark
void unmark()
Unmarks the item.
Definition: kfileitem.h:431
KFileItem::isFile
bool isFile() const
Returns true if this item represents a file (and not a a directory)
Definition: kfileitem.h:198
KFileItem
A KFileItem is a generic class to handle a file, local or remote.
Definition: kfileitem.h:41
KFileItem::entry
const KIO::UDSEntry & entry() const
Returns the UDS entry.
Definition: kfileitem.h:415

kio/kio

Skip menu "kio/kio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kio/kio

Skip menu "kio/kio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kio/kio by doxygen 1.8.13
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |