Package pywingo :: Class WingoUtil
[frames] | no frames]

Class WingoUtil

source code

            object --+    
                     |    
commands.WingoCommands --+
                         |
                        WingoUtil
Known Subclasses:

Provides a set of utility functions on top of the base commands defined by Wingo. These are special to the Python Wingo bindings.

Instance Methods
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
GetAllNormalClients(self)
Exactly the same as GetAllClients, except only clients with type "normal" are returned.
source code
 
IsEmpty(self, Workspace)
Returns true if the given Workspace has no clients.
source code
 
GetVisibleWorkspaceList(self)
Returns a list of all visible workspaces in order of their physical position: left to right and then top to bottom.
source code
 
GetHiddenWorkspaceList(self)
Returns a list of all hidden workspaces.
source code
 
LoadConfig(self)
Returns a ConfigParser.RawConfigParser instance of your script-name.cfg file.
source code

Inherited from commands.WingoCommands: AddWorkspace, And, AutoCycle, AutoMakeMaster, AutoMaster, AutoMastersFewer, AutoMastersMore, AutoNext, AutoPrev, AutoResizeMaster, AutoResizeWindow, AutoSwitchNext, AutoSwitchPrev, AutoTile, AutoUntile, Close, CycleClientChoose, CycleClientHide, CycleClientNext, CycleClientPrev, Dale, Deiconify, False, Float, Focus, FocusRaise, FrameBorders, FrameFull, FrameNada, FrameSlim, GetActive, GetAllClients, GetClientHeight, GetClientList, GetClientName, GetClientStatesList, GetClientType, GetClientWidth, GetClientWorkspace, GetClientX, GetClientY, GetHead, GetHeadHeight, GetHeadWidth, GetHeadWorkspace, GetLayout, GetNumHeads, GetNumHeadsConnected, GetWorkspace, GetWorkspaceId, GetWorkspaceList, GetWorkspaceNext, GetWorkspacePrefix, GetWorkspacePrev, HeadCycle, HeadFocus, HeadFocusWithClient, HideClientFromPanels, Iconify, Input, MatchClientClass, MatchClientInstance, MatchClientIsTransient, MatchClientMapped, MatchClientName, MatchClientType, Maximize, Message, MouseMove, MouseResize, Move, MovePointer, MovePointerRelative, MoveRelative, Not, Or, Quit, Raise, RemoveWorkspace, RenameWorkspace, Resize, Restart, Script, ScriptConfig, SelectClient, SelectWorkspace, SetLayout, SetOpacity, Shell, ShowClientInPanels, TagGet, TagSet, ToggleFloating, ToggleIconify, ToggleMaximize, ToggleStackAbove, ToggleStackBelow, ToggleSticky, True, Unfloat, Unmaximize, WingoExec, WingoHelp, Workspace, WorkspaceGreedy, WorkspaceGreedyWithClient, WorkspaceHead, WorkspaceSendClient, WorkspaceToHead, WorkspaceWithClient

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

GetAllNormalClients(self)

source code 

Exactly the same as GetAllClients, except only clients with type "normal" are returned. (i.e., excludes "desktop" and "dock" clients.)

IsEmpty(self, Workspace)

source code 

Returns true if the given Workspace has no clients. (Including iconified clients.)

Workspace may be a workspace index (integer) starting at 0, or a workspace name.

LoadConfig(self)

source code 

Returns a ConfigParser.RawConfigParser instance of your script-name.cfg file. This should only be used inside a Wingo contrib script program.

If the config file is not readable, then the program will terminate with an error message.