fox-toolkit.org - Documentation

00001 /********************************************************************************
00002 *                                                                               *
00003 *                        P C X   I c o n   O b j e c t                          *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 2001,2006 by Janusz Ganczarski.   All Rights Reserved.          *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or                 *
00009 * modify it under the terms of the GNU Lesser General Public                    *
00010 * License as published by the Free Software Foundation; either                  *
00011 * version 2.1 of the License, or (at your option) any later version.            *
00012 *                                                                               *
00013 * This library is distributed in the hope that it will be useful,               *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of                *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
00016 * Lesser General Public License for more details.                               *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public              *
00019 * License along with this library; if not, write to the Free Software           *
00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
00021 *********************************************************************************
00022 * $Id: FXPCXIcon.h,v 1.18 2006/01/22 17:58:06 fox Exp $                         *
00023 ********************************************************************************/
00024 #ifndef FXPCXICON_H
00025 #define FXPCXICON_H
00026 
00027 #ifndef FXICON_H
00028 #include "FXIcon.h"
00029 #endif
00030 
00031 namespace FX {
00032 
00033 /// PCX icon
00034 class FXAPI FXPCXIcon : public FXIcon {
00035   FXDECLARE(FXPCXIcon)
00036 protected:
00037   FXPCXIcon(){}
00038 private:
00039   FXPCXIcon(const FXPCXIcon&);
00040   FXPCXIcon &operator=(const FXPCXIcon&);
00041 public:
00042   static const FXchar fileExt[];
00043   static const FXchar mimeType[];
00044 public:
00045 
00046   /// Construct icon from memory stream formatted in PCX file format
00047   FXPCXIcon(FXApp* a,const void *pix=NULL,FXColor clr=FXRGB(192,192,192),FXuint opts=0,FXint w=1,FXint h=1);
00048 
00049   /// Save pixels into stream in PCX file format
00050   virtual bool savePixels(FXStream& store) const;
00051 
00052   /// Load pixels from stream in PCX file format
00053   virtual bool loadPixels(FXStream& store);
00054 
00055   /// Destroy icon
00056   virtual ~FXPCXIcon();
00057   };
00058 
00059 
00060 /**
00061 * Check if stream contains a PCX, return TRUE if so.
00062 */
00063 extern FXAPI bool fxcheckPCX(FXStream& store);
00064 
00065 
00066 /**
00067 * Load an PCX (PC Paintbrush) file from a stream.
00068 * Upon successful return, the pixel array and size are returned.
00069 * If an error occurred, the pixel array is set to NULL.
00070 */
00071 extern FXAPI bool fxloadPCX(FXStream& store,FXColor*& data,FXint& width,FXint& height);
00072 
00073 
00074 /**
00075 * Save an PCX (PC Paintbrush) file to a stream.
00076 */
00077 extern FXAPI bool fxsavePCX(FXStream& store,const FXColor *data,FXint width,FXint height);
00078 
00079 }
00080 
00081 #endif