            wxCmm version 0.2 Aug 2004


Classes and Methods List
========================

    Available classes and methods provided by wxCmm¡G

    ":" means "derived from"
    "=" means the parameter has default value, can be omited
    "#" means the parameter is an memory address

	This list not yet finish......


class wxObject

    void CopyObject( dest )

        Create a copy of this object in dest.

    wxObject Dup()

        Return a duplicate object of this.

    dword GetClassName()

        Returns the class name of this object.

    bool IsKindOf( classId )
        
        Determines whether this class is a subclass of (or the same class as) the given class.
        Predefined classId is the class name with a underline prefix, for example _wxObject


class wxPoint : wxObject
    
    wxPoint( x = 0, y = 0 )

        Create a point object.

    wxPoint::x
    wxPoint::y

        x and y member.


class wxSize : wxObject

    wxSize( width = 0, height = 0 )
    
        Creates a size object.

    dword   GetHeight()
    dword   GetWidth()
    void    SetHeight( height )
    void    SetWidth( width )

        Gets or sets the width and height members.

    wxSize::width
    wxSize::height

        widht and height member


class wxColor : wxObject

    wxColor( red, green, blue )
    wxColor( COLORREF )

        Constructs a colour object.
        There are some predefined COLORREF value such as WHITE, BLACK, instead of wxWidgets' colorName

    byte Red()
    byte Green()        
    byte Blue()

        Returns the color intensity.
    
    GetPixel()

        Returns COLORREF value of this object.
        This method works in both case of this being an object or a COLORREF value.
        For example:

            ESI = new wxColor(255, 255, 255);
            ESI.wxColor.GetPixel(); // return WHITE

            ESI = WHITE;
            ESI.wxColor.GetPixel(); // return WHITE, too!

    wxColor::colorRef

        COLORREF member.


class wxRect : wxObject

    wxRect( x, y, width, height )

        Creates a wxRect object from x, y, width and height values.

    wxRect::x
    wxRect::y
    wxRect::width
    wxRect::height

        x, y, widht, and height member


class wxWindow : wxObject

    wxWindow( parent = NULL, id = -1, #wxPoint = 0, #wxSize = 0, style = 0, name = "wxWindow")

        Constructs a window.

    void CaptureMouse()

        Directs all mouse input to this window. Call wxWindow::ReleaseMouse to release the capture

    void Centre()
    void Center()

        Centres the window.
        Center is a synonym for Centre.

    void Clear()

        Clears the window by filling it with the current background colour.

    void    ClientToScreen( #x, #y )
    wxPoint ClientToScreen( #wxPoint )
    dword   ClientToScreenX( x )
    dword   ClientToScreenY( y )

        Converts to screen coordinates from coordinates relative to this window.

    void Close()

        Close calls the close handler for the window, providing an opportunity for the window to choose whether to destroy the window.

    void Destroy()

        Destroys the window.

    bool Enable( enable = TRUE )

        Enable or disable the window for user input.
        Returns TRUE if the window has been enabled or disabled, FALSE if nothing was done,

    wxColor GetBackgroundColor()

        Returns the background color of the window.

    dword GetBackgroundColorRef()

        Returns the background COLORREF of the window.

    void    GetClientSize( #width, #height )
    void    GetClientSize( #wxSize )
    wxSize  GetClientSize()
    dword   GetClientSizeWidth()
    dword   GetClientSizeHeight()
    dword   GetClientSizeX()                       /** deprecated **/
    dword   GetClientSizeY()                       /** deprecated **/

        These get the size of the window 'client area' in pixels.

    wxFont GetFont()

        Returns a reference to the font for this window.

    wxWindow GetParent()

        Returns the parent of the window, or NULL if there is no parent.

    wxList GetChildren()
	
	Returns a reference to the list of the window's children.

    void    GetPosition( #x, #y )
    void    GetPosition( #wxPoint )
    wxPoint GetPosition()
    dword   GetPositionX()
    dword   GetPositionY()

        These get the position of the window in pixels.

    void    GetSize( #width, #height )
    void    GetSize( #wxSize )
    wxSize  GetSize()
    dword   GetSizeWidth()
    dword   GetSizeHeight()
    dword   GetSizeX()                             /** deprecated **/
    dword   GetSizeY()                             /** deprecated **/

        These get the size of the entire window in pixels.

    dword GetTitle()

        Gets the window's title.

    dword GetWindowStyleFlag()
    dword GetWindowStyle()

        Gets the window style that was passed to the constructor or Create method.
        GetWindowStyle() is another name for the same function.

    bool IsShown()

        Returns TRUE if the window is shown, FALSE if it has been hidden.

    void Move( x, y )
    void Move( #wxPoint )

        Moves the window to the given position.

    void Refresh( eraseBackground = TRUE, #wxRect = NULL)

        Causes a message or event to be generated to repaint the window.

    void ReleaseMouse()

        Releases mouse input captured with wxWindow::CaptureMouse.

    void    ScreenToClient( #x, #y )
    wxPoint ScreenToClient( #wxPoint )
    dword   ScreenToClientX( x )
    dword   ScreenToClientY( y )

        Converts from screen to client window coordinates.

    void SetAcceleratorTable( #wxAcceleratorTable )

        Sets the accelerator table for this window.

    void SetBackgroundColor( #wxColor )
    void SetBackgroundColor( COLORREF )

        Sets the background colour of the window.

    void SetFocus()

        This sets the window to receive keyboard input.

    void SetFont( #wxFont )

        Sets the font for this window.

    void SetSize( x, y, width, height )
    void SetSize( #wxRect )
    void SetSize( width, height )
    void SetSize( #wxSize )

        Sets the size and position of the window in pixels.

    void SetTitle( #string )

        Sets the window's title.

    void SetWindowStyleFlag( styleFlag )
    void SetWindowStyle( styleFlag )

        Sets the style of the window.

    bool Show( show = TRUE )

        Shows or hides the window.
        Return TRUE if the window has been shown or hidden, FALSE if nothing was done,


class wxFrame : wxWindow

    wxFrame( parent = NULL, id = -1, title = "", #wxPoint = 0, #wxSize = 0, style = wxDEFAULT_FRAME_STYLE, name = "wxFrame" )

        Constructor, creating the window.

    void CreateStatusBar( number = 1, style = 0 )
    
        Creates a status bar at the bottom of the frame.

    wxStatusBar GetStatusBar()

        Returns a pointer to the status bar currently associated with the frame.

    void SetIcon( resourcdId )
        
        Sets the icon for this frame.

    void SetMenuBar( #wxMenuBar )
        
        Tells the frame to show the given menu bar.
    
    void SetStatusBar( #wxStatusBar )

        Associates a status bar with the frame.

    void SetStatusText( text = "", number = 0 )

        Sets the status bar text and redraws the status bar.

    void SetStatusWidths( number = 1, #aWidth = NULL ) 
        
        Sets the widths of the fields in the status bar.
        If aWidth is NULL, 


class wxStatusBar : wxWindow

    wxStatusBar( parent = NULL, id = -1, style = 0 )

        Constructor, creating the statusBar.

    SetStatusWidths( number = 1, #aWidth = NULL )
    SetFieldsCount( number = 1, #aWidth = NULL )

        Sets the number of fields, and optionally the field widths.
        There are two types of fields: fixed widths one and variable width fields. 
        For the fixed width fields you should specify their width in pixels.
        For the variable width fields, specify a negative number.

        For example, to create one fixed width field of width 50 in the right part 
        of the status bar and two more fields which get 66% and 33% of the remaining space
        correspondingly, you should use an array containing -2, -1 and 100.

        If aWidth is NULL, these methods assume all array member as -1.

    SetStatusText( text = "", i = 0 )

        Sets the text for one field.



class wxPanel : wxWindow

    wxPanel( parent = NULL, id = -1, #wxPoint = 0, #wxSize = 0, style = 0 )

        If wxPoint and wxSize if both 0, this panel will auto adjust size to parent's client area.



class wxDialog : wxWindow

    wxDialog( parent = NULL, id = -1, title = "", #wxPoint = 0, #wxSize = 0, style = wxDEFAULT_DIALOG_STYLE )

        Constructor.

    void Centre()
    void Center()

        Centres the dialog box on the display.
        Center is a synonym for Centre.

    void Destroy()
        
        The close handler for the dialog box can close both modal and modaless dialogs, but don't destroy them. 
        A dialog without parent usually call Destroy() to insure the process will terminate.

    bool Show( show = TRUE )
    
        Shows a modaless dialog. Same as wxWindow::Show( show )

    void ShowModal()
    void EndModal( retCode )

        Shows a modal dialog. Program flow does not return until the dialog has been dismissed with EndModal().
        
    void SetReturnCode( retCode )

        Sets the return code for this window.

    void        LoadNativeDialog( parent, id )
    wxControl   GetWindowChild( id )

        Loads the dialog definition from resource and gets the child controls.
        See the example dialog3.c--.



class wxControl : wxWindow

    This is the base class for a control.



class wxStaticText : wxControl

    wxButton( parent = NULL, id = -1, label = "", #wxPoint = 0, #wxSize = 0, style = 0 )

        Constructor, creating and showing a text control.

    dword GetLabel()

        Returns the contents of the control.

    void SetLabel( label )
        
        Sets the static text label and updates the controls size to exactly fit the label unless the control has wxST_NO_AUTORESIZE flag.



class wxButton : wxControl

    wxButton( parent = NULL, id = -1, label = "", #wxPoint = 0, #wxSize = 0, style = 0 )
    
        Constructor, creating and showing a button.

    dword GetLabel()

        Returns the string label for the button.

    void SetLabel( label )
        
        Sets the string label for the button.


    
class wxCheckBox : wxControl

    wxCheckBox( parent = NULL, id = -1, label = "", #wxPoint = 0, #wxSize = 0, style = 0 )

        Constructor, creating and showing a checkbox.

    bool GetValue()
    bool IsChecked()

        Gets the state of the checkbox. 

    void SetValue( state )

        Sets the checkbox to the given state.


class wxToolBar : wxControl

    wxToolBar( parent = NULL, id = -1, #wxPoint = 0, #wxSize = 0, style = 0 )

        Constructs a toolbar.

    void AddSeparator()

        Adds a separator for spacing groups of tools.

    void AddTool( toolId = -1, label = "", #wxBitmap = 0, shortHelpString = "", kind = wxITEM_NORMAL )

        Adds a tool to the toolbar. 
        After you have added tools to a toolbar, you must call Realize().

    void Realize()

        This function should be called after you have added tools.

    void EnableTool( toolId, enable )
    void ShowTool( toolId, enable )
    void ToggleTool( toolId, enable )

        Enables or disables the tool. 
        Shows or hides the tool.
        Toggles a tool on or off.

    bool GetToolEnabled( toolId )
    bool IsToolShown( toolId )
    bool GetToolState( toolId )

        Determine whether a tool is enabled, shown, or toggle on.


class wxMenu : wxObject

    wxMenu()

        Constructs a wxMenu object.

    void Append( id, item, helpString )
    void Append( id, item, #wxMenu, helpString )

        Adds a string item or pull-right submenu to the end of the menu.

    void AppendSeparator()

        Adds a separator to the end of the menu.

    void Check( id, check )

        Checks or unchecks the menu item.

    bool IsChecked( id )

        Determines whether a menu item is checked.

    void SetHelpString( id, helpString )

        Sets an item's help string.



class wxMenuBar : wxObject

    wxMenuBar()

        Default constructor.

    void Append( #wxMenu, title )

        Adds the item to the end of the menu bar.

    wxMenu GetMenu( menuIndex )

        Returns the menu at menuIndex (zero-based).

    void LoadNativeMenu( resourcdId )

        Loads the menu definition from resource.



class wxGDIObject : wxObject

	This is the base class for GDI objects, such as wxPen, wxBrush and wxFont.
	


class wxPen : wxGDIObject

	wxPen( #wxColor, width = 1, style = wxSOLID )
	wxPen( COLORREF = BLACK, width = 1, style = wxSOLID )
	
		Constructs a pen from a color object ( or COLORREF ), pen width and style.

	dword GetCap()
		
		Returns the pen cap style, which may be one of wxCAP_ROUND, wxCAP_PROJECTING and wxCAP_BUTT.
		The default is wxCAP_ROUND.

	wxColor GetColor()

		Returns a reference to the pen color.

	dword GetColorRef()

		Returns the COLORREF value of pen.

	dword GetJoin()

		Returns the pen join style, which may be one of wxJOIN_BEVEL, wxJOIN_ROUND and wxJOIN_MITER. 
		The default is wxJOIN_ROUND.

	dword GetStyle()

		Returns the pen style.

	dword GetWidth()

		Returns the pen width.

	void SetCap( capStyle )

		Sets the pen cap style, which may be one of wxCAP_ROUND, wxCAP_PROJECTING and wxCAP_BUTT. 
		The default is wxCAP_ROUND.

	void SetColor( #wxColor )
	void SetColor( COLORREF )

		The pen's color is changed to the given color.

	void SetJoin( join )

		Sets the pen join style, which may be one of wxJOIN_BEVEL, wxJOIN_ROUND and wxJOIN_MITER. 
		The default is wxJOIN_ROUND.

	void SetStyle( style )

		Set the pen style.

	void SetWidth( width )

		Sets the pen width.
		
	Predefined objects:

		wxRED_PEN
		wxCYAN_PEN
		wxGREEN_PEN
		wxBLACK_PEN
		wxWHITE_PEN
		wxTRANSPARENT_PEN
		wxBLACK_DASHED_PEN
		wxGREY_PEN
		wxMEDIUM_GREY_PEN
		wxLIGHT_GREY_PEN
		wxDEFAULT_PEN



class wxBrush : wxGDIObject

	wxBrush( #wxColor, style = wxSOLID )
	wxBrush( COLORREF = WHITE, style = wxSOLID )

		Constructs a brush from a color object ( or COLORREF ) and style.


	wxColor GetColor()

		Returns a reference to the brush color.

	dword GetColorRef()

		Returns the COLORREF value of brush.

	dword GetStyle()

		Returns the brush style, one of:

	void SetColor( #wxColor )
	void SetColor( COLORREF )

		Sets the brush colour using a reference to a color object or a COLORREF value.

	void SetStyle( style )

		Sets the brush style.

	Predefined objects:

		wxBLUE_BRUSH
		wxGREEN_BRUSH
		wxWHITE_BRUSH
		wxBLACK_BRUSH
		wxGREY_BRUSH
		wxMEDIUM_GREY_BRUSH
		wxLIGHT_GREY_BRUSH
		wxTRANSPARENT_BRUSH
		wxCYAN_BRUSH
		wxRED_BRUSH
		wxDEFAULT_BRUSH


