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

FXXPMImage.h
Go to the documentation of this file.
1 /********************************************************************************
2 * *
3 * X P M I m a g e O b j e c t *
4 * *
5 *********************************************************************************
6 * Copyright (C) 2000,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: FXXPMImage.h,v 1.21 2006/01/22 17:58:13 fox Exp $ *
23 ********************************************************************************/
24 #ifndef FXXPMIMAGE_H
25 #define FXXPMIMAGE_H
26 
27 #ifndef FXIMAGE_H
28 #include "FXImage.h"
29 #endif
30 
31 namespace FX {
32 
33 
34 /// X Pixmap image
35 class FXAPI FXXPMImage : public FXImage {
37 protected:
39 private:
40  FXXPMImage(const FXXPMImage&);
41  FXXPMImage &operator=(const FXXPMImage&);
42 public:
43  static const FXchar fileExt[];
44  static const FXchar mimeType[];
45 public:
46 
47  /// Construct image from compiled-in X Pixmap format
48  FXXPMImage(FXApp* a,const FXchar **pix=NULL,FXuint opts=0,FXint w=1,FXint h=1);
49 
50  /// Save pixels into stream in X Pixmap format
51  virtual bool savePixels(FXStream& store) const;
52 
53  /// Load pixels from stream in X Pixmap format
54  virtual bool loadPixels(FXStream& store);
55 
56  /// Destroy icon
57  virtual ~FXXPMImage();
58  };
59 
60 
61 #ifndef FXLOADXPM
62 #define FXLOADXPM
63 
64 /**
65 * Check if stream contains a XPM, return TRUE if so.
66 */
67 extern FXAPI bool fxcheckXPM(FXStream& store);
68 
69 
70 /**
71 * Load an XPM (X Pixmap) from array of strings.
72 * Upon successful return, the pixel array and size are returned.
73 * If an error occurred, the pixel array is set to NULL.
74 */
75 extern FXAPI bool fxloadXPM(const FXchar **pix,FXColor*& data,FXint& width,FXint& height);
76 
77 
78 /**
79 * Load an XPM (X Pixmap) file from a stream.
80 * Upon successful return, the pixel array and size are returned.
81 * If an error occurred, the pixel array is set to NULL.
82 */
83 extern FXAPI bool fxloadXPM(FXStream& store,FXColor*& data,FXint& width,FXint& height);
84 
85 
86 /**
87 * Save an XPM (X Pixmap) file to a stream.
88 */
89 extern FXAPI bool fxsaveXPM(FXStream& store,const FXColor *data,FXint width,FXint height,bool fast=true);
90 
91 #endif
92 
93 }
94 
95 #endif
bool fxcheckXPM(FXStream &store)
Check if stream contains a XPM, return TRUE if so.
char FXchar
Definition: fxdefs.h:387
unsigned int FXuint
Definition: fxdefs.h:396
bool fxsaveXPM(FXStream &store, const FXColor *data, FXint width, FXint height, bool fast=true)
Save an XPM (X Pixmap) file to a stream.
#define FXAPI
Definition: fxdefs.h:122
Application Object.
Definition: FXApp.h:158
#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 Image is a rectangular array of pixels.
Definition: FXImage.h:67
bool fxloadXPM(const FXchar **pix, FXColor *&data, FXint &width, FXint &height)
Load an XPM (X Pixmap) from array of strings.
X Pixmap image.
Definition: FXXPMImage.h:35
#define FXDECLARE(classname)
Macro to set up class declaration.
Definition: FXObject.h:92

Copyright © 1997-2005 Jeroen van der Zijp