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

FXChoiceBox.h

Go to the documentation of this file.
00001 /********************************************************************************
00002 *                                                                               *
00003 *                            C h o i c e   B o x                                *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 2004,2006 by Jeroen van der Zijp.   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: FXChoiceBox.h,v 1.8 2006/01/22 17:57:59 fox Exp $                        *
00023 ********************************************************************************/
00024 #ifndef FXCHOICEBOX_H
00025 #define FXCHOICEBOX_H
00026 
00027 #ifndef FXDIALOGBOX_H
00028 #include "FXDialogBox.h"
00029 #endif
00030 
00031 namespace FX {
00032 
00033 
00034 class FXList;
00035 
00036 
00037 /**
00038 * The Choice Box provides a dialog panel to select one item out of a list
00039 * of choices.  The choices are provided as a list of text strings.
00040 * When the dialog closes, the index of the selected choice is returned,
00041 * while a -1 is returned if the dialog was canceled,
00042 */
00043 class FXAPI FXChoiceBox : public FXDialogBox {
00044   FXDECLARE(FXChoiceBox)
00045 protected:
00046   FXList *list;
00047 protected:
00048   FXChoiceBox(){}
00049 private:
00050   FXChoiceBox(const FXChoiceBox&);
00051   FXChoiceBox &operator=(const FXChoiceBox&);
00052   void initialize(const FXString& text,FXIcon* icon);
00053 public:
00054   long onCmdClicked(FXObject*,FXSelector,void*);
00055   long onCmdCancel(FXObject*,FXSelector,void*);
00056 public:
00057   enum{
00058     ID_CLICKED=FXDialogBox::ID_LAST,
00059     ID_LAST
00060     };
00061 public:
00062 
00063   /// Construct choice box with given caption, icon, message text, and with choices from array of strings
00064   FXChoiceBox(FXWindow* owner,const FXString& caption,const FXString& text,FXIcon* icon,const FXchar** choices,FXuint opts=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0);
00065 
00066   /// Construct choice box with given caption, icon, message text, and with choices from newline separated strings
00067   FXChoiceBox(FXWindow* owner,const FXString& caption,const FXString& text,FXIcon* icon,const FXString& choices,FXuint opts=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0);
00068 
00069   /// Construct free floating choice box with given caption, icon, message text, and with choices from array of strings
00070   FXChoiceBox(FXApp* app,const FXString& caption,const FXString& text,FXIcon* icon,const FXchar** choices,FXuint opts=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0);
00071 
00072   /// Construct free floating choice box with given caption, icon, message text, and with choices from newline separated strings
00073   FXChoiceBox(FXApp* app,const FXString& caption,const FXString& text,FXIcon* icon,const FXString& choices,FXuint opts=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0);
00074 
00075   /**
00076   * Show a modal choice dialog.
00077   * Prompt the user using a dialog with given caption, icon,
00078   * message text, and with choices from newline array of strings.
00079   * The return value is -1 if cancelled, or the given choice.
00080   */
00081   static FXint ask(FXWindow* owner,FXuint opts,const FXString& caption,const FXString& text,FXIcon* icon,const FXchar** choices);
00082 
00083   /**
00084   * Show a modal choice dialog.
00085   * Prompt the user using a dialog with given caption, icon,
00086   * message text, and with choices from newline separated strings.
00087   * The return value is -1 if cancelled, or the given choice
00088   */
00089   static FXint ask(FXWindow* owner,FXuint opts,const FXString& caption,const FXString& text,FXIcon* icon,const FXString& choices);
00090 
00091   /**
00092   * Show modal choice message, in free floating window.
00093   * Prompt the user using a dialog with given caption, icon,
00094   * message text, and with choices from newline array of strings.
00095   * The return value is -1 if cancelled, or the given choice
00096   */
00097   static FXint ask(FXApp* app,FXuint opts,const FXString& caption,const FXString& text,FXIcon* icon,const FXchar** choices);
00098 
00099   /**
00100   * Show modal choice message, in free floating window.
00101   * Prompt the user using a dialog with given caption, icon,
00102   * message text, and with choices from newline separated strings.
00103   * The return value is -1 if cancelled, or the given choice
00104   */
00105   static FXint ask(FXApp* app,FXuint opts,const FXString& caption,const FXString& text,FXIcon* icon,const FXString& choices);
00106 
00107 
00108   /// Save choice box to a stream
00109   virtual void save(FXStream& store) const;
00110 
00111   /// Load choice box from a stream
00112   virtual void load(FXStream& store);
00113 
00114   /// Destroy choice box
00115   virtual ~FXChoiceBox();
00116   };
00117 
00118 }
00119 
00120 #endif

Copyright © 1997-2005 Jeroen van der Zijp