mgui/smledit.h

Go to the documentation of this file.

/**
 * \file mgui/smledit.h
 * \brief SML / Query / Script Editor class
 *
 * \if NODOC
 * $Log: smledit.h_v $
 * Revision 1.5  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.4  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2002/10/10 20:29:21  mju
 * Move to 'mgui' folder.
 *
 * Revision 1.1  2002/08/14 20:48:23  dwilliss
 * Initial revision
 *
 * 
 * 3     5/07/02 3:52p Dwilliss
 * 
 * 2     12/13/01 10:55a Mju
 * MGUI unificiation with X.
 * 
 * 1     10/18/01 11:05a Mju
 * \endif
**/

#ifndef INC_MGUI_SMLEDIT_H
#define INC_MGUI_SMLEDIT_H

#ifndef  INC_MGUI_CTRL_H
#include <mgui/ctrl.h>
#endif

#ifndef  INC_MI32_SML_H
#include <mi32/sml.h>
#endif

class SCRIPTVIEW;

namespace MGUI {

//! Form for use in any MGUI_DIALOG to edit database queries
//!
class FORM_SMLEDITOR : public MGUI::FORM {
   public:

      //! Default constructor, initializes only.
      FORM_SMLEDITOR ();

      //! Destructor.
      ~FORM_SMLEDITOR ();

      //! Check to see if the syntax of the current query is valid.
      //! Returns true if valid, false if not.
      bool CheckSyntax (
         bool bShowError = true        //!< If syntax invalid, display error if true
         );

      //! Create the form.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,
         int width = 30,               //!< Width of editor part of form in 'em' characters
         int height = 10,              //!< Height of editor part of form in characters
         MGUI::LAYOUT_SIZEALIGN sizealign= MGUI::LAYOUT_SIZEALIGN_Expand,
         bool bFileIcons = true        //!< If true (default), tool bar will have open/save icons
         );

      //! Get the current script string.
      const MISTRING& GetScript (
         );

      //! Get toolbar pane, usually to add additional buttons.
      MGUI::LAYOUT_PANE& GetToolBarPane (
         );

      //! Returns true if the query has changed since it was last set.
      bool HasChanged (
         ) const;

      //! Determine if form has been created.
      //! @return true if created, false if not.
      virtual bool IsCreated (
         ) const;

      //! Determine if form is enabled for keyboard or mouse input.
      //! @return true if enabled, false if not, or if not yet created.
      virtual bool IsEnabled (
         ) const;

      //! Open the documentation window.
      void OpenDocumentation (
         );

      //! Set the SMLCONTEXT for this editor.
      //!
      //!   The following QFLAGs are implemented (defined in sml.h)
      //!
      //!      QFLAG_FileExtnSML    Make Open/Save/Save As buttons expect .sml files by default (normally expects .qry)
      //!      
      void SetContext (
         SMLCONTEXT* context,
         int segment,
         UINT32 flags = 0     //!< QFLAG_ constants from sml.h (QFLAG_FileExtnSML)
         );

      //! Set whether mouse or keyboard input to form is allowed.
      virtual void SetEnabled (
         bool enabled = true
         );

      //! Set the script string.
      void SetScript (
         const MISTRING& script
         );

      //! Set whether form is visible or not.
      virtual void SetVisible (
         bool visible = true
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      SCRIPTVIEW* m_pView;
      #endif // GENERATING_DOXYGEN_OUTPUT

   };

}  // End namespace MGUI


#endif   // INC_MGUI_SMLEDIT

---