MGUI::FORM_SMLEDITOR Class Reference

Form for use in any MGUI_DIALOG to edit database queries. More...

#include <mgui/smledit.h>

Inheritance diagram for MGUI::FORM_SMLEDITOR:

[legend]List of all members.

Public Member Functions
bool	CheckSyntax (bool bShowError=true)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, int width=30, int height=10, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_Expand, bool bFileIcons=true)
	FORM_SMLEDITOR ()
const MISTRING &	GetScript ()
MGUI::LAYOUT_PANE &	GetToolBarPane ()
bool	HasChanged () const
virtual bool	IsCreated () const
virtual bool	IsEnabled () const
void	OpenDocumentation ()
void	SetContext (SMLCONTEXT *context, int segment, UINT32 flags=0)
virtual void	SetEnabled (bool enabled=true)
void	SetScript (const MISTRING &script)
virtual void	SetVisible (bool visible=true)
	~FORM_SMLEDITOR ()

---

Detailed Description

Form for use in any MGUI_DIALOG to edit database queries.

Definition at line 46 of file smledit.h.

---

Constructor & Destructor Documentation

MGUI::FORM_SMLEDITOR::FORM_SMLEDITOR (   )

Default constructor, initializes only.

MGUI::FORM_SMLEDITOR::~FORM_SMLEDITOR (   )

Destructor.

---

Member Function Documentation

bool MGUI::FORM_SMLEDITOR::CheckSyntax (  bool  bShowError = true  )

Check to see if the syntax of the current query is valid. Returns true if valid, false if not. Parameters: bShowError  If syntax invalid, display error if true

void MGUI::FORM_SMLEDITOR::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane, int  width = 30, int  height = 10, MGUI::LAYOUT_SIZEALIGN  sizealign = MGUI::LAYOUT_SIZEALIGN_Expand, bool  bFileIcons = true )

Create the form. Parameters: width  Width of editor part of form in 'em' characters height  Height of editor part of form in characters bFileIcons  If true (default), tool bar will have open/save icons

const MISTRING& MGUI::FORM_SMLEDITOR::GetScript (   )

Get the current script string.

MGUI::LAYOUT_PANE& MGUI::FORM_SMLEDITOR::GetToolBarPane (   )

Get toolbar pane, usually to add additional buttons.

bool MGUI::FORM_SMLEDITOR::HasChanged (   )  const

Returns true if the query has changed since it was last set.

virtual bool MGUI::FORM_SMLEDITOR::IsCreated (   )  const [virtual]

Determine if form has been created. Returns: true if created, false if not. Implements MGUI::FORM.

virtual bool MGUI::FORM_SMLEDITOR::IsEnabled (   )  const [virtual]

Determine if form is enabled for keyboard or mouse input. Returns: true if enabled, false if not, or if not yet created.

void MGUI::FORM_SMLEDITOR::OpenDocumentation (   )

Open the documentation window.

void MGUI::FORM_SMLEDITOR::SetContext (  SMLCONTEXT *  context, int  segment, UINT32  flags = 0 )

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) Parameters: flags  QFLAG_ constants from sml.h (QFLAG_FileExtnSML)

virtual void MGUI::FORM_SMLEDITOR::SetEnabled (  bool  enabled = true  )  [virtual]

Set whether mouse or keyboard input to form is allowed. Implements MGUI::FORM.

void MGUI::FORM_SMLEDITOR::SetScript (  const MISTRING &  script  )

Set the script string.

virtual void MGUI::FORM_SMLEDITOR::SetVisible (  bool  visible = true  )  [virtual]

Set whether form is visible or not. Implements MGUI::FORM.

---

The documentation for this class was generated from the following file:

• mgui/smledit.h

---