X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/078a6f207ee40b05962fb71721c9e7d06ecb7860..641d44aef554d7e62d8bd0f35c98bd2b9b15b5b0:/wxPython/src/gtk/_core.py diff --git a/wxPython/src/gtk/_core.py b/wxPython/src/gtk/_core.py index 036ed1d518..10783c0309 100644 --- a/wxPython/src/gtk/_core.py +++ b/wxPython/src/gtk/_core.py @@ -194,6 +194,7 @@ ID_REDO = _core_.ID_REDO ID_HELP = _core_.ID_HELP ID_PRINT = _core_.ID_PRINT ID_PRINT_SETUP = _core_.ID_PRINT_SETUP +ID_PAGE_SETUP = _core_.ID_PAGE_SETUP ID_PREVIEW = _core_.ID_PREVIEW ID_ABOUT = _core_.ID_ABOUT ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS @@ -274,10 +275,6 @@ ID_ZOOM_OUT = _core_.ID_ZOOM_OUT ID_UNDELETE = _core_.ID_UNDELETE ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED ID_HIGHEST = _core_.ID_HIGHEST -ACCEL_ALT = _core_.ACCEL_ALT -ACCEL_CTRL = _core_.ACCEL_CTRL -ACCEL_SHIFT = _core_.ACCEL_SHIFT -ACCEL_NORMAL = _core_.ACCEL_NORMAL PD_AUTO_HIDE = _core_.PD_AUTO_HIDE PD_APP_MODAL = _core_.PD_APP_MODAL PD_CAN_ABORT = _core_.PD_CAN_ABORT @@ -1345,6 +1342,15 @@ class Rect(object): """ return _core_.Rect_Inside(*args, **kwargs) + def InsideRect(*args, **kwargs): + """ + InsideRect(self, Rect rect) -> bool + + Returns ``True`` if the given rectangle is completely inside this + rectangle or touches its boundary. + """ + return _core_.Rect_InsideRect(*args, **kwargs) + def Intersects(*args, **kwargs): """ Intersects(self, Rect rect) -> bool @@ -2652,11 +2658,23 @@ class Image(Object): return _core_.Image_SetAlphaData(*args, **kwargs) def GetAlphaBuffer(*args, **kwargs): - """GetAlphaBuffer(self) -> PyObject""" + """ + GetAlphaBuffer(self) -> PyObject + + Returns a writable Python buffer object that is pointing at the Alpha + data buffer inside the wx.Image. You need to ensure that you do not + use this buffer object after the image has been destroyed. + """ return _core_.Image_GetAlphaBuffer(*args, **kwargs) def SetAlphaBuffer(*args, **kwargs): - """SetAlphaBuffer(self, buffer alpha)""" + """ + SetAlphaBuffer(self, buffer alpha) + + Sets the internal image alpha pointer to point at a Python buffer + object. This can save making an extra copy of the data but you must + ensure that the buffer object lives as long as the wx.Image does. + """ return _core_.Image_SetAlphaBuffer(*args, **kwargs) def SetMaskColour(*args, **kwargs): @@ -3041,6 +3059,40 @@ def Image_HSVtoRGB(*args, **kwargs): """ return _core_.Image_HSVtoRGB(*args, **kwargs) + +def _ImageFromBuffer(*args, **kwargs): + """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image""" + return _core_._ImageFromBuffer(*args, **kwargs) +def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None): + """ + Creates a `wx.Image` from the data in dataBuffer. The dataBuffer + parameter must be a Python object that implements the buffer interface, + such as a string, array, etc. The dataBuffer object is expected to + contain a series of RGB bytes and be width*height*3 bytes long. A buffer + object can optionally be supplied for the image's alpha channel data, and + it is expected to be width*height bytes long. + + The wx.Image will be created with its data and alpha pointers initialized + to the memory address pointed to by the buffer objects, thus saving the + time needed to copy the image data from the buffer object to the wx.Image. + While this has advantages, it also has the shoot-yourself-in-the-foot + risks associated with sharing a C pointer between two objects. + + To help alleviate the risk a reference to the data and alpha buffer + objects are kept with the wx.Image, so that they won't get deleted until + after the wx.Image is deleted. However please be aware that it is not + guaranteed that an object won't move its memory buffer to a new location + when it needs to resize its contents. If that happens then the wx.Image + will end up referring to an invalid memory location and could cause the + application to crash. Therefore care should be taken to not manipulate + the objects used for the data and alpha buffers in a way that would cause + them to change size. + """ + image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer) + image._buffer = dataBuffer + image._alpha = alphaBuffer + return image + def InitAllImageHandlers(): """ The former functionality of InitAllImageHanders is now done internal to @@ -4033,6 +4085,12 @@ class CommandEvent(Event): """Clone(self) -> Event""" return _core_.CommandEvent_Clone(*args, **kwargs) + ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`") + ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`") + ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`") + Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`") + Selection = property(GetSelection,doc="See `GetSelection`") + String = property(GetString,SetString,doc="See `GetString` and `SetString`") _core_.CommandEvent_swigregister(CommandEvent) #--------------------------------------------------------------------------- @@ -5137,6 +5195,7 @@ class ChildFocusEvent(CommandEvent): """ return _core_.ChildFocusEvent_GetWindow(*args, **kwargs) + Window = property(GetWindow,doc="See `GetWindow`") _core_.ChildFocusEvent_swigregister(ChildFocusEvent) #--------------------------------------------------------------------------- @@ -5176,6 +5235,7 @@ class ActivateEvent(Event): """ return _core_.ActivateEvent_GetActive(*args, **kwargs) + Active = property(GetActive,doc="See `GetActive`") _core_.ActivateEvent_swigregister(ActivateEvent) #--------------------------------------------------------------------------- @@ -5336,6 +5396,8 @@ class CloseEvent(Event): """ return _core_.CloseEvent_CanVeto(*args, **kwargs) + LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`") + Veto = property(GetVeto,doc="See `GetVeto`") _core_.CloseEvent_swigregister(CloseEvent) #--------------------------------------------------------------------------- @@ -5449,6 +5511,9 @@ class DropFilesEvent(Event): """ return _core_.DropFilesEvent_GetFiles(*args, **kwargs) + Files = property(GetFiles,doc="See `GetFiles`") + NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`") + Position = property(GetPosition,doc="See `GetPosition`") _core_.DropFilesEvent_swigregister(DropFilesEvent) #--------------------------------------------------------------------------- @@ -6181,6 +6246,7 @@ class ContextMenuEvent(CommandEvent): """ return _core_.ContextMenuEvent_SetPosition(*args, **kwargs) + Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") _core_.ContextMenuEvent_swigregister(ContextMenuEvent) #--------------------------------------------------------------------------- @@ -6449,6 +6515,7 @@ class DateEvent(CommandEvent): """ return _core_.DateEvent_SetDate(*args, **kwargs) + Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`") _core_.DateEvent_swigregister(DateEvent) wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED @@ -6816,6 +6883,28 @@ class PyApp(EvtHandler): return _core_.PyApp_GetComCtl32Version(*args, **kwargs) GetComCtl32Version = staticmethod(GetComCtl32Version) + def DisplayAvailable(*args, **kwargs): + """ + DisplayAvailable() -> bool + + Tests if it is possible to create a GUI in the current environment. + This will mean different things on the different platforms. + + * On X Windows systems this function will return ``False`` if it is + not able to open a connection to the X display, which can happen + if $DISPLAY is not set, or is not set correctly. + + * On Mac OS X a ``False`` return value will mean that wx is not + able to access the window manager, which can happen if logged in + remotely or if running from the normal version of python instead + of the framework version, (i.e., pythonw.) + + * On MS Windows... + + """ + return _core_.PyApp_DisplayAvailable(*args, **kwargs) + + DisplayAvailable = staticmethod(DisplayAvailable) _core_.PyApp_swigregister(PyApp) def PyApp_IsMainLoopRunning(*args): @@ -6876,6 +6965,27 @@ def PyApp_GetComCtl32Version(*args): """ return _core_.PyApp_GetComCtl32Version(*args) +def PyApp_DisplayAvailable(*args): + """ + PyApp_DisplayAvailable() -> bool + + Tests if it is possible to create a GUI in the current environment. + This will mean different things on the different platforms. + + * On X Windows systems this function will return ``False`` if it is + not able to open a connection to the X display, which can happen + if $DISPLAY is not set, or is not set correctly. + + * On Mac OS X a ``False`` return value will mean that wx is not + able to access the window manager, which can happen if logged in + remotely or if running from the normal version of python instead + of the framework version, (i.e., pythonw.) + + * On MS Windows... + + """ + return _core_.PyApp_DisplayAvailable(*args) + #--------------------------------------------------------------------------- @@ -7045,7 +7155,7 @@ class PyOnDemandOutputWindow: #---------------------------------------------------------------------- _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__') - + class App(wx.PyApp): """ The ``wx.App`` class represents the application and is used to: @@ -7103,22 +7213,26 @@ class App(wx.PyApp): initialization to ensure that the system, toolkit and wxWidgets are fully initialized. """ + wx.PyApp.__init__(self) - if wx.Platform == "__WXMAC__": - try: - import MacOS - if not MacOS.WMAvailable(): - print """\ -This program needs access to the screen. Please run with 'pythonw', -not 'python', and only when you are logged in on the main display of -your Mac.""" - _sys.exit(1) - except SystemExit: - raise - except: - pass + # make sure we can create a GUI + if not self.DisplayAvailable(): + + if wx.Platform == "__WXMAC__": + msg = """This program needs access to the screen. +Please run with 'pythonw', not 'python', and only when you are logged +in on the main display of your Mac.""" + + elif wx.Platform == "__WXGTK__": + msg ="Unable to access the X Display, is $DISPLAY set properly?" + + else: + msg = "Unable to create GUI" + # TODO: more description is needed for wxMSW... + raise SystemExit(msg) + # This has to be done before OnInit self.SetUseBestVisual(useBestVisual) @@ -7353,6 +7467,11 @@ _core_.EventLoopActivator_swigregister(EventLoopActivator) #--------------------------------------------------------------------------- +ACCEL_ALT = _core_.ACCEL_ALT +ACCEL_CTRL = _core_.ACCEL_CTRL +ACCEL_SHIFT = _core_.ACCEL_SHIFT +ACCEL_NORMAL = _core_.ACCEL_NORMAL +ACCEL_CMD = _core_.ACCEL_CMD class AcceleratorEntry(object): """ A class used to define items in an `wx.AcceleratorTable`. wxPython @@ -7406,6 +7525,9 @@ class AcceleratorEntry(object): """ return _core_.AcceleratorEntry_GetCommand(*args, **kwargs) + Command = property(GetCommand,doc="See `GetCommand`") + Flags = property(GetFlags,doc="See `GetFlags`") + KeyCode = property(GetKeyCode,doc="See `GetKeyCode`") _core_.AcceleratorEntry_swigregister(AcceleratorEntry) class AcceleratorTable(Object): @@ -9587,6 +9709,32 @@ class Window(EvtHandler): """ return _core_.Window_ShouldInheritColours(*args, **kwargs) + def CanSetTransparent(*args, **kwargs): + """ + CanSetTransparent(self) -> bool + + Returns ``True`` if the platform supports setting the transparency for + this window. Note that this method will err on the side of caution, + so it is possible that this will return ``False`` when it is in fact + possible to set the transparency. + + NOTE: On X-windows systems the X server must have the composite + extension loaded, and there must be a composite manager program (such + as xcompmgr) running. + """ + return _core_.Window_CanSetTransparent(*args, **kwargs) + + def SetTransparent(*args, **kwargs): + """ + SetTransparent(self, byte alpha) -> bool + + Attempt to set the transparency of this window to the ``alpha`` value, + returns True on success. The ``alpha`` value is an integer in the + range of 0 to 255, where 0 is fully transparent and 255 is fully + opaque. + """ + return _core_.Window_SetTransparent(*args, **kwargs) + def PostCreate(self, pre): """ Phase 3 of the 2-phase create @@ -9603,6 +9751,65 @@ class Window(EvtHandler): def SendSizeEvent(self): self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1))) + AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`") + AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`") + AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`") + BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") + BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`") + BestFittingSize = property(GetBestFittingSize,SetBestFittingSize,doc="See `GetBestFittingSize` and `SetBestFittingSize`") + BestSize = property(GetBestSize,doc="See `GetBestSize`") + BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`") + Border = property(GetBorder,doc="See `GetBorder`") + Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`") + CharHeight = property(GetCharHeight,doc="See `GetCharHeight`") + CharWidth = property(GetCharWidth,doc="See `GetCharWidth`") + Children = property(GetChildren,doc="See `GetChildren`") + ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`") + ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`") + ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`") + Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`") + ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`") + Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`") + DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`") + DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`") + EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`") + ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`") + Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`") + ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`") + FullTextExtent = property(GetFullTextExtent,doc="See `GetFullTextExtent`") + GrandParent = property(GetGrandParent,doc="See `GetGrandParent`") + Handle = property(GetHandle,doc="See `GetHandle`") + HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`") + HelpTextAtPoint = property(GetHelpTextAtPoint,doc="See `GetHelpTextAtPoint`") + Id = property(GetId,SetId,doc="See `GetId` and `SetId`") + Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`") + MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`") + MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`") + MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`") + MinHeight = property(GetMinHeight,doc="See `GetMinHeight`") + MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`") + MinWidth = property(GetMinWidth,doc="See `GetMinWidth`") + Name = property(GetName,SetName,doc="See `GetName` and `SetName`") + Parent = property(GetParent,doc="See `GetParent`") + Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") + Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`") + ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`") + ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`") + ScrollPos = property(GetScrollPos,SetScrollPos,doc="See `GetScrollPos` and `SetScrollPos`") + ScrollRange = property(GetScrollRange,doc="See `GetScrollRange`") + ScrollThumb = property(GetScrollThumb,doc="See `GetScrollThumb`") + Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`") + Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`") + TextExtent = property(GetTextExtent,doc="See `GetTextExtent`") + ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`") + ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`") + UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`") + UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`") + Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`") + VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`") + WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`") + WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`") + WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`") _core_.Window_swigregister(Window) def PreWindow(*args, **kwargs): @@ -10486,6 +10693,9 @@ class Control(Window): return _core_.Control_GetClassDefaultAttributes(*args, **kwargs) GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) + Alignment = property(GetAlignment,doc="See `GetAlignment`") + Label = property(GetLabel,doc="See `GetLabel`") + LabelText = property(GetLabelText,doc="See `GetLabelText`") _core_.Control_swigregister(Control) ControlNameStr = cvar.ControlNameStr @@ -11542,6 +11752,7 @@ class BoxSizer(Sizer): """ return _core_.BoxSizer_SetOrientation(*args, **kwargs) + Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`") _core_.BoxSizer_swigregister(BoxSizer) #---------------------------------------------------------------------------