err.no Git - scalable-opengroupware.org/blob - UI/MailPartViewers/UIxMailPartViewer.h

   1 /*
   2   Copyright (C) 2004-2005 SKYRIX Software AG
   3
   4   This file is part of OpenGroupware.org.
   5
   6   OGo is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   OGo is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with OGo; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21
  22 #ifndef __Mailer_UIxMailPartViewer_H__
  23 #define __Mailer_UIxMailPartViewer_H__
  24
  25 #include <SOGoUI/UIxComponent.h>
  26
  27 /*
  28   UIxMailPartViewer
  29
  30   This class is the superclass for MIME content viewers.
  31
  32   Since part-viewers can be reused for multiple parts, you need to be careful
  33   in subclass to properly reset your specific state by overriding
  34     - resetPathCaches
  35
  36   The part viewers have access to the rendering state using the
  37
  38     [[self context] mailRenderingContext]
  39
  40   object. This class provides several convenience methods to access mailpart
  41   content.
  42 */
  43
  44 @class NSData, NSArray, NSFormatter;
  45
  46 @interface UIxMailPartViewer : UIxComponent
  47 {
  48   NSArray *partPath;
  49   id      bodyInfo;
  50   NSData  *flatContent;
  51 }
  52
  53 /* accessors */
  54
  55 - (void)setPartPath:(NSArray *)_path;
  56 - (NSArray *)partPath;
  57
  58 - (void)setBodyInfo:(id)_info;
  59 - (id)bodyInfo;
  60
  61 - (NSData *)flatContent;
  62 - (NSData *)decodedFlatContent;
  63 - (NSString *)flatContentAsString;
  64
  65 - (NSString *)preferredPathExtension;
  66 - (NSString *)filename;
  67 - (NSString *)filenameForDisplay;
  68 - (NSFormatter *)sizeFormatter;
  69
  70 /* caches */
  71
  72 - (void)resetPathCaches;
  73 - (void)resetBodyInfoCaches;
  74
  75 /* part URLs */
  76
  77 - (NSString *)pathToAttachmentObject; /* link to SoObject */
  78 - (NSString *)pathToAttachment;       /* download link */
  79
  80 @end
  81
  82 #endif /* __Mailer_UIxMailPartViewer_H__ */