Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FXPPMIcon.h
Go to the documentation of this file.
1 /********************************************************************************
2 * *
3 * P P M I c o n O b j e c t *
4 * *
5 *********************************************************************************
6 * Copyright (C) 2003,2006 by Jeroen van der Zijp. All Rights Reserved. *
7 *********************************************************************************
8 * This library is free software; you can redistribute it and/or *
9 * modify it under the terms of the GNU Lesser General Public *
10 * License as published by the Free Software Foundation; either *
11 * version 2.1 of the License, or (at your option) any later version. *
12 * *
13 * This library is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16 * Lesser General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU Lesser General Public *
19 * License along with this library; if not, write to the Free Software *
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *
21 *********************************************************************************
22 * $Id: FXPPMIcon.h,v 1.9 2006/01/22 17:58:06 fox Exp $ *
23 ********************************************************************************/
24 #ifndef FXPPMICON_H
25 #define FXPPMICON_H
26 
27 #ifndef FXICON_H
28 #include "FXIcon.h"
29 #endif
30 
31 namespace FX {
32 
33 
34 /// Portable Pixmap icon
35 class FXAPI FXPPMIcon : public FXIcon {
37 protected:
39 private:
40  FXPPMIcon(const FXPPMIcon&);
41  FXPPMIcon &operator=(const FXPPMIcon&);
42 public:
43  static const FXchar fileExt[];
44  static const FXchar mimeType[];
45 public:
46 
47  /// Construct icon from memory stream formatted in Portable Pixmap format
48  FXPPMIcon(FXApp* a,const void *pix=NULL,FXColor clr=FXRGB(192,192,192),FXuint opts=0,FXint w=1,FXint h=1);
49 
50  /// Save pixels into stream in Portable Pixmap format
51  virtual bool savePixels(FXStream& store) const;
52 
53  /// Load pixels from stream in Portable Pixmap format
54  virtual bool loadPixels(FXStream& store);
55 
56  /// Destroy icon
57  virtual ~FXPPMIcon();
58  };
59 
60 
61 /**
62 * Check if stream contains a PPM, return TRUE if so.
63 */
64 extern FXAPI bool fxcheckPPM(FXStream& store);
65 
66 
67 /**
68 * Load an PPM (Portable Pixmap Format) file from a stream.
69 * Upon successful return, the pixel array and size are returned.
70 * If an error occurred, the pixel array is set to NULL.
71 */
72 extern FXAPI bool fxloadPPM(FXStream& store,FXColor*& data,FXint& width,FXint& height);
73 
74 
75 /**
76 * Save an PPM (Portable Pixmap Format) file to a stream.
77 */
78 extern FXAPI bool fxsavePPM(FXStream& store,const FXColor *data,FXint width,FXint height);
79 
80 }
81 
82 #endif
char FXchar
Definition: fxdefs.h:387
unsigned int FXuint
Definition: fxdefs.h:396
#define FXAPI
Definition: fxdefs.h:122
Application Object.
Definition: FXApp.h:158
bool fxsavePPM(FXStream &store, const FXColor *data, FXint width, FXint height)
Save an PPM (Portable Pixmap Format) file to a stream.
#define FXRGB(r, g, b)
Make RGB color.
Definition: fxdefs.h:579
#define NULL
Definition: fxdefs.h:41
FXuint FXColor
Definition: fxdefs.h:454
A stream is a way to serialize data and objects into a byte stream.
Definition: FXStream.h:99
Definition: FX4Splitter.h:31
int FXint
Definition: fxdefs.h:397
An Icon is an image with two additional server-side resources: a shape bitmap, which is used to mask ...
Definition: FXIcon.h:45
Portable Pixmap icon.
Definition: FXPPMIcon.h:35
bool fxcheckPPM(FXStream &store)
Check if stream contains a PPM, return TRUE if so.
bool fxloadPPM(FXStream &store, FXColor *&data, FXint &width, FXint &height)
Load an PPM (Portable Pixmap Format) file from a stream.
#define FXDECLARE(classname)
Macro to set up class declaration.
Definition: FXObject.h:92

Copyright © 1997-2005 Jeroen van der Zijp