]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/gtk/gdi.py
implemented Lower and Raise for OSX
[wxWidgets.git] / wxPython / src / gtk / gdi.py
index 6ec01c34897fcabfb223ffa607a20fce9a3b187a..ac5ff3d7ad103f72610f271bd87989ac048cd3a3 100644 (file)
@@ -51,13 +51,13 @@ class Colour(core.Object):
     etc.  Valid RGB values are in the range 0 to 255.
 
     In wxPython there are typemaps that will automatically convert from a colour
-    name, or from a "#RRGGBB" colour hex value string to a wx.Colour object when
+    name, or from a '#RRGGBB' colour hex value string to a wx.Colour object when
     calling C++ methods that expect a wxColour.  This means that the following are
     all equivallent:
 
         win.SetBackgroundColour(wxColour(0,0,255))
-        win.SetBackgroundColour("BLUE")
-        win.SetBackgroundColour("#0000FF")
+        win.SetBackgroundColour('BLUE')
+        win.SetBackgroundColour('#0000FF')
 
     You can retrieve the various current system colour settings with
     wx.SystemSettings.GetColour.
@@ -482,6 +482,14 @@ class Bitmap(GDIObject):
         """
         return _gdi.Bitmap_GetDepth(*args, **kwargs)
 
+    def GetSize(*args, **kwargs):
+        """
+        GetSize() -> Size
+
+        Get the size of the bitmap.
+        """
+        return _gdi.Bitmap_GetSize(*args, **kwargs)
+
     def ConvertToImage(*args, **kwargs):
         """
         ConvertToImage() -> Image
@@ -570,7 +578,23 @@ class Bitmap(GDIObject):
         """
         return _gdi.Bitmap_SetDepth(*args, **kwargs)
 
+    def SetSize(*args, **kwargs):
+        """
+        SetSize(Size size)
+
+        Set the bitmap size
+        """
+        return _gdi.Bitmap_SetSize(*args, **kwargs)
+
     def __nonzero__(self): return self.Ok() 
+    def __eq__(*args, **kwargs):
+        """__eq__(Bitmap other) -> bool"""
+        return _gdi.Bitmap___eq__(*args, **kwargs)
+
+    def __ne__(*args, **kwargs):
+        """__ne__(Bitmap other) -> bool"""
+        return _gdi.Bitmap___ne__(*args, **kwargs)
+
 
 class BitmapPtr(Bitmap):
     def __init__(self, this):
@@ -579,18 +603,6 @@ class BitmapPtr(Bitmap):
         self.__class__ = Bitmap
 _gdi.Bitmap_swigregister(BitmapPtr)
 
-def EmptyBitmap(*args, **kwargs):
-    """
-    EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
-
-    Creates a new bitmap of the given size.  A depth of -1 indicates the depth of
-    the current screen or visual. Some platforms only support 1 for monochrome and
-    -1 for the current colour setting.
-    """
-    val = _gdi.new_EmptyBitmap(*args, **kwargs)
-    val.thisown = 1
-    return val
-
 def BitmapFromIcon(*args, **kwargs):
     """
     BitmapFromIcon(Icon icon) -> Bitmap
@@ -637,6 +649,19 @@ def BitmapFromBits(*args, **kwargs):
     val.thisown = 1
     return val
 
+def EmptyBitmap(*args):
+    """
+    EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
+    EmptyBitmap(Size size, int depth=-1) -> Bitmap
+
+    Creates a new bitmap of the given size.  A depth of -1 indicates
+    the depth of the current screen or visual. Some platforms only
+    support 1 for monochrome and -1 for the current colour setting.
+    """
+    val = _gdi.new_EmptyBitmap(*args)
+    val.thisown = 1
+    return val
+
 class Mask(core.Object):
     """
     This class encapsulates a monochrome mask bitmap, where the masked area is
@@ -842,10 +867,30 @@ def IconBundleFromIcon(*args, **kwargs):
     return val
 
 class Cursor(GDIObject):
+    """
+    A cursor is a small bitmap usually used for denoting where the
+    mouse pointer is, with a picture that might indicate the
+    interpretation of a mouse click.
+
+    A single cursor object may be used in many windows (any subwindow
+    type). The wxWindows convention is to set the cursor for a
+    window, as in X, rather than to set it globally as in MS Windows,
+    although a global wx.SetCursor function is also available for use
+    on MS Windows.
+    """
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxCursor instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
-        """__init__(String cursorName, long flags, int hotSpotX=0, int hotSpotY=0) -> Cursor"""
+        """
+        __init__(String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
+
+        Construct a Cursor from a file.  Specify the type of file using
+        wx.BITAMP_TYPE* constants, and specify the hotspot if not using a
+        .cur file.
+
+        This cursor is not available on wxGTK, use wx.StockCursor,
+        wx.CursorFromImage, or wx.CursorFromBits instead.
+        """
         newobj = _gdi.new_Cursor(*args, **kwargs)
         self.this = newobj.this
         self.thisown = 1
@@ -870,23 +915,33 @@ class CursorPtr(Cursor):
 _gdi.Cursor_swigregister(CursorPtr)
 
 def StockCursor(*args, **kwargs):
-    """StockCursor(int id) -> Cursor"""
+    """
+    StockCursor(int id) -> Cursor
+
+    Create a cursor using one of the stock cursors.  Note that not
+    all cursors are available on all platforms.
+    """
     val = _gdi.new_StockCursor(*args, **kwargs)
     val.thisown = 1
     return val
 
 def CursorFromImage(*args, **kwargs):
-    """CursorFromImage(Image image) -> Cursor"""
-    val = _gdi.new_CursorFromImage(*args, **kwargs)
-    val.thisown = 1
-    return val
-
-def CursorFromBits(*args, **kwargs):
     """
-    CursorFromBits(PyObject bits, int width, int height, int hotSpotX=-1, 
-        int hotSpotY=-1, PyObject maskBits=0) -> Cursor
+    CursorFromImage(Image image) -> Cursor
+
+    Constructs a cursor from a wxImage. The cursor is monochrome,
+    colors with the RGB elements all greater than 127 will be
+    foreground, colors less than this background. The mask (if any)
+    will be used as transparent.
+
+    In MSW the foreground will be white and the background black. The
+    cursor is resized to 32x32 In GTK, the two most frequent colors
+    will be used for foreground and background. The cursor will be
+    displayed at the size of the image. On MacOS the cursor is
+    resized to 16x16 and currently only shown as black/white (mask
+    respected).
     """
-    val = _gdi.new_CursorFromBits(*args, **kwargs)
+    val = _gdi.new_CursorFromImage(*args, **kwargs)
     val.thisown = 1
     return val
 
@@ -1133,6 +1188,7 @@ FONTENCODING_ISO8859_14 = _gdi.FONTENCODING_ISO8859_14
 FONTENCODING_ISO8859_15 = _gdi.FONTENCODING_ISO8859_15
 FONTENCODING_ISO8859_MAX = _gdi.FONTENCODING_ISO8859_MAX
 FONTENCODING_KOI8 = _gdi.FONTENCODING_KOI8
+FONTENCODING_KOI8_U = _gdi.FONTENCODING_KOI8_U
 FONTENCODING_ALTERNATIVE = _gdi.FONTENCODING_ALTERNATIVE
 FONTENCODING_BULGARIAN = _gdi.FONTENCODING_BULGARIAN
 FONTENCODING_CP437 = _gdi.FONTENCODING_CP437
@@ -1411,6 +1467,11 @@ class FontMapper(object):
         return _gdi.FontMapper_GetEncodingDescription(*args, **kwargs)
 
     GetEncodingDescription = staticmethod(GetEncodingDescription)
+    def GetEncodingFromName(*args, **kwargs):
+        """GetEncodingFromName(String name) -> int"""
+        return _gdi.FontMapper_GetEncodingFromName(*args, **kwargs)
+
+    GetEncodingFromName = staticmethod(GetEncodingFromName)
     def SetConfig(*args, **kwargs):
         """SetConfig(ConfigBase config)"""
         return _gdi.FontMapper_SetConfig(*args, **kwargs)
@@ -1472,6 +1533,10 @@ def FontMapper_GetEncodingDescription(*args, **kwargs):
     """FontMapper_GetEncodingDescription(int encoding) -> String"""
     return _gdi.FontMapper_GetEncodingDescription(*args, **kwargs)
 
+def FontMapper_GetEncodingFromName(*args, **kwargs):
+    """FontMapper_GetEncodingFromName(String name) -> int"""
+    return _gdi.FontMapper_GetEncodingFromName(*args, **kwargs)
+
 def FontMapper_GetDefaultConfigPath(*args, **kwargs):
     """FontMapper_GetDefaultConfigPath() -> String"""
     return _gdi.FontMapper_GetDefaultConfigPath(*args, **kwargs)