Package diffpy :: Package pdfgui :: Package gui :: Module PyAUI :: Class PaneInfo
[hide private]
[frames] | no frames]

Class PaneInfo

source code

Instance Methods [hide private]
 
__init__(self) source code
 
IsOk(self)
IsOk() returns True if the PaneInfo structure is valid.
source code
 
IsFixed(self)
IsFixed() returns True if the pane cannot be resized.
source code
 
IsResizable(self)
IsResizeable() returns True if the pane can be resized.
source code
 
IsShown(self)
IsShown() returns True if the pane should be drawn on the screen.
source code
 
IsFloating(self)
IsFloating() returns True if the pane is floating.
source code
 
IsDocked(self)
IsDocked() returns True if the pane is docked.
source code
 
IsToolbar(self)
IsToolbar() returns True if the pane contains a toolbar.
source code
 
IsTopDockable(self)
IsTopDockable() returns True if the pane can be docked at the top of the managed frame.
source code
 
IsBottomDockable(self)
IsBottomDockable() returns True if the pane can be docked at the bottom of the managed frame.
source code
 
IsLeftDockable(self)
IsLeftDockable() returns True if the pane can be docked at the left of the managed frame.
source code
 
IsRightDockable(self)
IsRightDockable() returns True if the pane can be docked at the right of the managed frame.
source code
 
IsDockable(self)
IsDockable() returns True if the pane can be docked.
source code
 
IsFloatable(self)
IsFloatable() returns True if the pane can be undocked and displayed as a floating window.
source code
 
IsMovable(self)
IsMoveable() returns True if the docked frame can be undocked or moved to another dock position.
source code
 
HasCaption(self)
HasCaption() returns True if the pane displays a caption.
source code
 
HasGripper(self)
HasGripper() returns True if the pane displays a gripper.
source code
 
HasBorder(self)
HasBorder() returns True if the pane displays a border.
source code
 
HasCloseButton(self)
HasCloseButton() returns True if the pane displays a button to close the pane.
source code
 
HasMaximizeButton(self)
HasMaximizeButton() returns True if the pane displays a button to maximize the pane.
source code
 
HasMinimizeButton(self)
HasMinimizeButton() returns True if the pane displays a button to minimize the pane.
source code
 
HasPinButton(self)
HasPinButton() returns True if the pane displays a button to float the pane.
source code
 
HasGripperTop(self) source code
 
Window(self, w) source code
 
Name(self, n)
Name() sets the name of the pane so it can be referenced in lookup functions.
source code
 
Caption(self, c)
Caption() sets the caption of the pane.
source code
 
Left(self)
Left() sets the pane dock position to the left side of the frame.
source code
 
Right(self)
Right() sets the pane dock position to the right side of the frame.
source code
 
Top(self)
Top() sets the pane dock position to the top of the frame.
source code
 
Bottom(self)
Bottom() sets the pane dock position to the bottom of the frame.
source code
 
Center(self)
Center() sets the pane to the center position of the frame.
source code
 
Centre(self)
Centre() sets the pane to the center position of the frame.
source code
 
Direction(self, direction)
Direction() determines the direction of the docked pane.
source code
 
Layer(self, layer)
Layer() determines the layer of the docked pane.
source code
 
Row(self, row)
Row() determines the row of the docked pane.
source code
 
Position(self, pos)
Position() determines the position of the docked pane.
source code
 
MinSize(self, arg1=None, arg2=None)
MinSize() sets the minimum size of the pane.
source code
 
MinSize1(self, size) source code
 
MinSize2(self, x, y) source code
 
MaxSize(self, arg1=None, arg2=None)
MaxSize() sets the maximum size of the pane.
source code
 
MaxSize1(self, size) source code
 
MaxSize2(self, x, y) source code
 
BestSize(self, arg1=None, arg2=None)
BestSize() sets the ideal size for the pane.
source code
 
BestSize1(self, size) source code
 
BestSize2(self, x, y) source code
 
FloatingPosition(self, pos)
FloatingPosition() sets the position of the floating pane.
source code
 
FloatingSize(self, size)
FloatingSize() sets the size of the floating pane.
source code
 
Fixed(self)
Fixed() forces a pane to be fixed size so that it cannot be resized.
source code
 
Resizable(self, resizable=True)
Resizable() allows a pane to be resizable if resizable is True, and forces it to be a fixed size if resizeable is False.
source code
 
Dock(self)
Dock() indicates that a pane should be docked.
source code
 
Float(self)
Float() indicates that a pane should be floated.
source code
 
Hide(self)
Hide() indicates that a pane should be hidden.
source code
 
Show(self, show=True)
Show() indicates that a pane should be shown.
source code
 
CaptionVisible(self, visible=True)
CaptionVisible() indicates that a pane caption should be visible.
source code
 
PaneBorder(self, visible=True)
PaneBorder() indicates that a border should be drawn for the pane.
source code
 
Gripper(self, visible=True)
Gripper() indicates that a gripper should be drawn for the pane.
source code
 
GripperTop(self, attop=True)
GripperTop() indicates that a gripper should be drawn for the pane.
source code
 
CloseButton(self, visible=True)
CloseButton() indicates that a close button should be drawn for the pane.
source code
 
MaximizeButton(self, visible=True)
MaximizeButton() indicates that a maximize button should be drawn for the pane.
source code
 
MinimizeButton(self, visible=True)
MinimizeButton() indicates that a minimize button should be drawn for the pane.
source code
 
PinButton(self, visible=True)
PinButton() indicates that a pin button should be drawn for the pane.
source code
 
DestroyOnClose(self, b=True)
DestroyOnClose() indicates whether a pane should be destroyed when it is closed.
source code
 
TopDockable(self, b=True)
TopDockable() indicates whether a pane can be docked at the top of the frame.
source code
 
BottomDockable(self, b=True)
BottomDockable() indicates whether a pane can be docked at the bottom of the frame.
source code
 
LeftDockable(self, b=True)
LeftDockable() indicates whether a pane can be docked on the left of the frame.
source code
 
RightDockable(self, b=True)
RightDockable() indicates whether a pane can be docked on the right of the frame.
source code
 
Floatable(self, b=True)
Floatable() indicates whether a frame can be floated.
source code
 
Movable(self, b=True)
Movable() indicates whether a frame can be moved.
source code
 
Dockable(self, b=True) source code
 
DefaultPane(self)
DefaultPane() specifies that the pane should adopt the default pane settings.
source code
 
CentrePane(self)
CentrePane() specifies that the pane should adopt the default center pane settings.
source code
 
CenterPane(self)
CenterPane() specifies that the pane should adopt the default center pane settings.
source code
 
ToolbarPane(self)
ToolbarPane() specifies that the pane should adopt the default toolbar pane settings.
source code
 
SetFlag(self, flag, option_state)
SetFlag() turns the property given by flag on or off with the option_state parameter.
source code
 
HasFlag(self, flag)
HasFlag() returns True if the the property specified by flag is active for the pane.
source code
Class Variables [hide private]
  optionFloating = 1
  optionHidden = 2
  optionLeftDockable = 4
  optionRightDockable = 8
  optionTopDockable = 16
  optionBottomDockable = 32
  optionFloatable = 64
  optionMovable = 128
  optionResizable = 256
  optionPaneBorder = 512
  optionCaption = 1024
  optionGripper = 2048
  optionDestroyOnClose = 4096
  optionToolbar = 8192
  optionActive = 16384
  optionGripperTop = 32768
  buttonClose = 16777216
  buttonMaximize = 33554432
  buttonMinimize = 67108864
  buttonPin = 134217728
  buttonCustom1 = 268435456
  buttonCustom2 = 536870912
  buttonCustom3 = 1073741824
  actionPane = 2147483648