Module LabelBook :: Class ImageContainerBase
[hide private]
[frames] | no frames]

Class ImageContainerBase

source code

     object --+                
              |                
wx._core.Object --+            
                  |            
wx._core.EvtHandler --+        
                      |        
        wx._core.Window --+    
                          |    
          wx._windows.Panel --+
                              |
                             ImageContainerBase
Known Subclasses:
ImageContainer, LabelContainer

Base class for FlatImageBook image container.

Instance Methods [hide private]
  __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name="ImageContainerBase")
Default class constructor.
  HasFlag(self, flag)
Tests for existance of flag in the style.
  ClearFlag(self, flag)
Removes flag from the style.
  AssignImageList(self, imglist)
Assigns an image list to the ImageContainerBase.
  GetImageList(self)
Return the image list for ImageContainerBase.
  GetImageSize(self)
Returns the image size inside the ImageContainerBase image list.
  FixTextSize(self, dc, text, maxWidth)
Fixes the text, to fit maxWidth value.
  CanDoBottomStyle(self)
Allows the parent to examine the children type.
  AddPage(self, caption, selected=True, imgIdx=-1)
Adds a page to the container.
  ClearAll(self)
Deletes all the pages in the container.
  DoDeletePage(self, page)
Does the actual page deletion.
  OnSize(self, event)
Handles the wx.EVT_SIZE event for ImageContainerBase.
  OnEraseBackground(self, event)
Handles the wx.EVT_ERASE_BACKGROUND event for ImageContainerBase.
  HitTest(self, pt)
Returns the index of the tab at the specified position or wx.NOT_FOUND if None, plus the flag style of HitTest.
  PointOnSash(self, pt)
Tests whether pt is located on the sash.
  OnMouseLeftDown(self, event)
Handles the wx.EVT_LEFT_DOWN event for ImageContainerBase.
  OnMouseLeaveWindow(self, event)
Handles the wx.EVT_LEAVE_WINDOW event for ImageContainerBase.
  OnMouseLeftUp(self, event)
Handles the wx.EVT_LEFT_UP event for ImageContainerBase.
  OnMouseMove(self, event)
Handles the wx.EVT_MOTION event for ImageContainerBase.
  DrawPin(self, dc, rect, downPin)
Draw a pin button, that allows collapsing of the image panel.

Inherited from wx._windows.Panel: Create, SetFocusIgnoringChildren, __repr__

Inherited from wx._core.Window: AcceptsFocus, AcceptsFocusFromKeyboard, AddChild, AdjustForLayoutDirection, AssociateHandle, CacheBestSize, CanSetTransparent, CaptureMouse, Center, CenterOnParent, Centre, CentreOnParent, ClearBackground, ClientToScreen, ClientToScreenXY, Close, ConvertDialogPointToPixels, ConvertDialogSizeToPixels, ConvertPixelPointToDialog, ConvertPixelSizeToDialog, DLG_PNT, DLG_SZE, Destroy, DestroyChildren, Disable, DissociateHandle, DragAcceptFiles, Enable, FindWindowById, FindWindowByName, Fit, FitInside, Freeze, GetAcceleratorTable, GetAdjustedBestSize, GetAutoLayout, GetBackgroundColour, GetBackgroundStyle, GetBestFittingSize, GetBestSize, GetBestSizeTuple, GetBestVirtualSize, GetBorder, GetCaret, GetCharHeight, GetCharWidth, GetChildren, GetClientAreaOrigin, GetClientRect, GetClientSize, GetClientSizeTuple, GetConstraints, GetContainingSizer, GetCursor, GetDefaultAttributes, GetDropTarget, GetEventHandler, GetExtraStyle, GetFont, GetForegroundColour, GetFullTextExtent, GetGrandParent, GetHandle, GetHelpText, GetHelpTextAtPoint, GetId, GetLabel, GetLayoutDirection, GetMaxHeight, GetMaxSize, GetMaxWidth, GetMinHeight, GetMinSize, GetMinWidth, GetName, GetParent, GetPosition, GetPositionTuple, GetRect, GetScreenPosition, GetScreenPositionTuple, GetScreenRect, GetScrollPos, GetScrollRange, GetScrollThumb, GetSize, GetSizeTuple, GetSizer, GetTextExtent, GetThemeEnabled, GetToolTip, GetUpdateClientRect, GetUpdateRegion, GetValidator, GetVirtualSize, GetVirtualSizeTuple, GetWindowStyle, GetWindowStyleFlag, GetWindowVariant, HasCapture, HasMultiplePages, HasScrollbar, HasTransparentBackground, Hide, HitTestXY, InheritAttributes, InheritsBackgroundColour, InitDialog, InvalidateBestSize, IsBeingDeleted, IsDoubleBuffered, IsEnabled, IsExposed, IsExposedPoint, IsExposedRect, IsFrozen, IsRetained, IsShown, IsShownOnScreen, IsTopLevel, Layout, LineDown, LineUp, Lower, MakeModal, Move, MoveAfterInTabOrder, MoveBeforeInTabOrder, MoveXY, Navigate, OnPaint, PageDown, PageUp, PopEventHandler, PopupMenu, PopupMenuXY, PostCreate, PrepareDC, PushEventHandler, Raise, Refresh, RefreshRect, RegisterHotKey, ReleaseMouse, RemoveChild, RemoveEventHandler, Reparent, ScreenToClient, ScreenToClientXY, ScrollLines, ScrollPages, ScrollWindow, SendSizeEvent, SetAcceleratorTable, SetAutoLayout, SetBackgroundColour, SetBackgroundStyle, SetBestFittingSize, SetCaret, SetClientRect, SetClientSize, SetClientSizeWH, SetConstraints, SetContainingSizer, SetCursor, SetDimensions, SetDoubleBuffered, SetDropTarget, SetEventHandler, SetExtraStyle, SetFocus, SetFocusFromKbd, SetFont, SetForegroundColour, SetHelpText, SetHelpTextForId, SetId, SetLabel, SetLayoutDirection, SetMaxSize, SetMinSize, SetName, SetOwnBackgroundColour, SetOwnFont, SetOwnForegroundColour, SetPosition, SetRect, SetScrollPos, SetScrollbar, SetSize, SetSizeHints, SetSizeHintsSz, SetSizeWH, SetSizer, SetSizerAndFit, SetThemeEnabled, SetToolTip, SetToolTipString, SetTransparent, SetValidator, SetVirtualSize, SetVirtualSizeHints, SetVirtualSizeHintsSz, SetVirtualSizeWH, SetWindowStyle, SetWindowStyleFlag, SetWindowVariant, ShouldInheritColours, Show, Thaw, TransferDataFromWindow, TransferDataToWindow, UnregisterHotKey, Update, UpdateWindowUI, UseBgCol, Validate, WarpPointer

Inherited from wx._core.EvtHandler: AddPendingEvent, AllowReentrance, Bind, Connect, Disconnect, GetEvtHandlerEnabled, GetNextHandler, GetPreviousHandler, IsEventHandlingInProgress, IsReentranceAllowed, ProcessEvent, ProcessPendingEvents, SetEvtHandlerEnabled, SetNextHandler, SetPreviousHandler, Unbind

Inherited from wx._core.EvtHandler (private): _setOORInfo

Inherited from wx._core.Object: GetClassName

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__


Static Methods [hide private]

Inherited from wx._windows.Panel: GetClassDefaultAttributes

Inherited from wx._core.Window: FindFocus, GetCapture, NewControlId, NextControlId, PrevControlId


Properties [hide private]

Inherited from wx._windows.Panel: thisown

Inherited from wx._core.Window: AcceleratorTable, AdjustedBestSize, AutoLayout, BackgroundColour, BackgroundStyle, BestFittingSize, BestSize, BestVirtualSize, Border, Caret, CharHeight, CharWidth, Children, ClientAreaOrigin, ClientRect, ClientSize, Constraints, ContainingSizer, Cursor, DefaultAttributes, DropTarget, Enabled, EventHandler, ExtraStyle, Font, ForegroundColour, GrandParent, Handle, HelpText, Id, Label, LayoutDirection, MaxHeight, MaxSize, MaxWidth, MinHeight, MinSize, MinWidth, Name, Parent, Position, Rect, ScreenPosition, ScreenRect, Shown, Size, Sizer, ThemeEnabled, ToolTip, TopLevel, UpdateClientRect, UpdateRegion, Validator, VirtualSize, WindowStyle, WindowStyleFlag, WindowVariant

Inherited from wx._core.EvtHandler: EvtHandlerEnabled, NextHandler, PreviousHandler

Inherited from wx._core.Object: ClassName

Inherited from object: __class__


Method Details [hide private]

__init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name="ImageContainerBase")
(Constructor)

source code 

Default class constructor.

Parameters: @param parent - parent window @param id - Window id @param pos - Window position @param size - Window size @param style - possible style INB_XXX
Overrides: wx._windows.Panel.__init__

HasFlag(self, flag)

source code 
Tests for existance of flag in the style.
Overrides: wx._core.Window.HasFlag

ClearFlag(self, flag)

source code 
Removes flag from the style.

AssignImageList(self, imglist)

source code 
Assigns an image list to the ImageContainerBase.

GetImageList(self)

source code 
Return the image list for ImageContainerBase.

GetImageSize(self)

source code 
Returns the image size inside the ImageContainerBase image list.

FixTextSize(self, dc, text, maxWidth)

source code 
Fixes the text, to fit maxWidth value. If the text length exceeds maxWidth value this function truncates it and appends two dots at the end. ("Long Long Long Text" might become "Long Long...)

CanDoBottomStyle(self)

source code 
Allows the parent to examine the children type. Some implementation (such as LabelBook), does not support top/bottom images, only left/right.

AddPage(self, caption, selected=True, imgIdx=-1)

source code 
Adds a page to the container.

ClearAll(self)

source code 
Deletes all the pages in the container.

DoDeletePage(self, page)

source code 
Does the actual page deletion.

OnSize(self, event)

source code 
Handles the wx.EVT_SIZE event for ImageContainerBase.

OnEraseBackground(self, event)

source code 
Handles the wx.EVT_ERASE_BACKGROUND event for ImageContainerBase.

HitTest(self, pt)

source code 
Returns the index of the tab at the specified position or wx.NOT_FOUND if None, plus the flag style of HitTest.
Overrides: wx._core.Window.HitTest

PointOnSash(self, pt)

source code 
Tests whether pt is located on the sash.

OnMouseLeftDown(self, event)

source code 
Handles the wx.EVT_LEFT_DOWN event for ImageContainerBase.

OnMouseLeaveWindow(self, event)

source code 
Handles the wx.EVT_LEAVE_WINDOW event for ImageContainerBase.

OnMouseLeftUp(self, event)

source code 
Handles the wx.EVT_LEFT_UP event for ImageContainerBase.

OnMouseMove(self, event)

source code 
Handles the wx.EVT_MOTION event for ImageContainerBase.

DrawPin(self, dc, rect, downPin)

source code 
Draw a pin button, that allows collapsing of the image panel.