[Wxlua-commit] wxLua/modules/wxlua/include wxlstate.h,1.58,1.59

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/wxlua/wxLua/modules/wxlua/include
In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv17508/wxLua/modules/wxlua/include

Modified Files:
	wxlstate.h 
Log Message:
fix wxPrintout::OnBeginDocument binding to not directly call wxPrintout::OnBeginDocument
   but just OnBeginDocument on the object on the stack, allows base_OnBeginDocument to work properly
Add better descriptions to functions in wxlstate.h
GetLuaNULL() -> GetLuaNULLTag()
GetLuaWinDestroyTable() -> GetLuaWinDestroyTableTag()
wxLua_lua_isenumerationtype does not take nil as a valid enum anymore
Add wxLuaDebugDataItem::ToString for debugging


Index: wxlstate.h
===================================================================
RCS file: /cvsroot/wxlua/wxLua/modules/wxlua/include/wxlstate.h,v
retrieving revision 1.58
retrieving revision 1.59
diff -C2 -d -r1.58 -r1.59
*** wxlstate.h	19 Dec 2006 21:12:03 -0000	1.58
--- wxlstate.h	21 Jan 2007 23:13:07 -0000	1.59
***************
*** 458,474 ****
      void RegisterBindings(bool registerTypes);
  
!     // Get the installed wxLuaBinding with the given 
!     //   wxLuaBinding::GetBindingName or NULL for no match. 
      wxLuaBinding* GetLuaBinding(const wxString& bindingName) const;
  
!     // Get WXLUACLASS for given lua Tag, the number lua uses to track the class
      const WXLUACLASS* GetLuaClass(int iClassTag) const;
!     // Get WXLUACLASS for given class name
      const WXLUACLASS* GetLuaClass(const char* className) const;
!     // Get base WXLUACLASS for given Tag
      const WXLUACLASS* GetBaseLuaClass(int iClassTag) const;
!     // returns true is iClassTag is derived from iBaseClassTag
      bool IsDerivedClass(int iClassTag, int iBaseClassTag) const;
!     // Get WXLUAEVENT for given wxEvent
      const WXLUAEVENT* GetLuaEvent(wxEvent *pEvent) const;
  
--- 458,480 ----
      void RegisterBindings(bool registerTypes);
  
!     // Get the installed wxLuaBinding with the given
!     //   wxLuaBinding::GetBindingName or NULL for no match.
      wxLuaBinding* GetLuaBinding(const wxString& bindingName) const;
  
!     // Get WXLUACLASS for given lua Tag using WXLUACLASS::class_tag,
!     //   returns NULL on failure.
      const WXLUACLASS* GetLuaClass(int iClassTag) const;
!     // Get WXLUACLASS for given class name using WXLUACLASS::name,
!     //   returns NULL on failure.
      const WXLUACLASS* GetLuaClass(const char* className) const;
!     // Get base WXLUACLASS for given Tag using WXLUACLASS::class_tag and
!     //   WXLUACLASS::baseclass_tag. returns NULL on failure.
      const WXLUACLASS* GetBaseLuaClass(int iClassTag) const;
!     // returns true if iClassTag is derived or equal to iBaseClassTag by using
!     //   WXLUACLASS::class_tag and WXLUACLASS::baseclass_tag.
!     //   returns NULL on failure.
      bool IsDerivedClass(int iClassTag, int iBaseClassTag) const;
!     // Get WXLUAEVENT for given wxEvent by comparing the wxEvent::GetEventType()
!     //   to WXLUAEVENT::eventType.
      const WXLUAEVENT* GetLuaEvent(wxEvent *pEvent) const;
  
***************
*** 476,483 ****
      //   you may add or remove bindings before creation
      wxLuaBindingList* GetLuaBindingList() const;
      bool GetBindingsRegistered() const; // Are the binding registered
      int  GetwxLuaFunctionTag() const;   // The lua tag for wxLuaFunction objects.
!     int  GetLuaNULL() const;            // The lua tag for NULL pointer
!     int  GetLuaWinDestroyTable() const; // The lua tag for the wxWindow destroy tracking table
      int  GetwxEventTag() const;         // The lua tag for wxEvents
      int  GetwxWindowTag() const;        // The lua tag for wxWindows
--- 482,491 ----
      //   you may add or remove bindings before creation
      wxLuaBindingList* GetLuaBindingList() const;
+ 
      bool GetBindingsRegistered() const; // Are the binding registered
+ 
      int  GetwxLuaFunctionTag() const;   // The lua tag for wxLuaFunction objects.
!     int  GetLuaNULLTag() const;         // The lua tag for NULL pointer
!     int  GetLuaWinDestroyTableTag() const; // The lua tag for the wxWindow destroy tracking table
      int  GetwxEventTag() const;         // The lua tag for wxEvents
      int  GetwxWindowTag() const;        // The lua tag for wxWindows
***************
*** 567,572 ****
      bool IsUserDataType(int stack_idx, int tag) const;
      // Return a pointer to the object that corresponds to the specified stack
!     // index and tag. Get a user data type (either allocated by us if the tag
!     // is iTagS otherwise system allocated iTagP.
      // If the data type does not have the correct tag, or if the parameter
      // stack_idx is nil, NULL is returned, otherwise terror is called.
--- 575,580 ----
      bool IsUserDataType(int stack_idx, int tag) const;
      // Return a pointer to the object that corresponds to the specified stack
!     // index and tag. Get a user data type either allocated by wxLua or a
!     // system allocated tag.
      // If the data type does not have the correct tag, or if the parameter
      // stack_idx is nil, NULL is returned, otherwise terror is called.
***************
*** 583,592 ****
--- 591,603 ----
      // Validate that the object at the stack index specified is a boolean object
      // or that the object can be converted to a boolean and return the boolean.
+     // calls terror if the value is not of the right type.
      bool   GetBooleanType(int stack_idx);
      // Validate that the object at the stack index specified is a enumeration object
      // or that the object can be converted to a enumeration and return the enumeration value.
+     // calls terror if the value is not of the right type.
      long   GetEnumerationType(int stack_idx);
      // Validate that the object at the stack index specified is a number object
      // or that the object can be converted to a number and return the number value.
+     // calls terror if the value is not of the right type.
      double GetNumberType(int stack_idx);
  
***************
*** 609,613 ****
      // convert a parameter which is presumably a table into a character pointer array.
      // returns the number of character strings in the array in count.
!     // the return value may need to be deleted.
      const char** GetCharArray(int stack_idx, int &count);
  
--- 620,624 ----
      // convert a parameter which is presumably a table into a character pointer array.
      // returns the number of character strings in the array in count.
!     // You must delete the return value if not NULL.
      const char** GetCharArray(int stack_idx, int &count);
  
***************
*** 616,623 ****
      // numeric entry in the table is a numeric object or can be converted to a number
      // Return a pointer to the array of ints and set the size in count
!     // the return value will need to be deleted.
      int* GetIntArray(int stack_idx, int &count);
      // convert a parameter which is presumably a table into a wxArrayInt.
!     // returns the number of values in the array.
      int  GetwxArrayInt(int stack_idx, wxArrayInt &intArray);
  
--- 627,634 ----
      // numeric entry in the table is a numeric object or can be converted to a number
      // Return a pointer to the array of ints and set the size in count
!     // You must delete the return value if not NULL.
      int* GetIntArray(int stack_idx, int &count);
      // convert a parameter which is presumably a table into a wxArrayInt.
!     // returns the number of values put into the array.
      int  GetwxArrayInt(int stack_idx, wxArrayInt &intArray);
  
***************
*** 627,630 ****
--- 638,643 ----
      int PushwxArrayIntTable(const wxArrayInt &intArray);
  
+     // -----------------------------------------------------------------------
+ 
      // Returns the 'name' of a lua userdata object from its tag.
      //   returns wxEmptyString on failure.