JWM Source Documentation

group.h File Reference

Functions for handling window groups. More...

Go to the source code of this file.

Enumerations

enum  OptionType {
  OPTION_INVALID = 0, OPTION_STICKY = 1, OPTION_LAYER = 2, OPTION_DESKTOP = 3,
  OPTION_ICON = 4, OPTION_NOLIST = 5, OPTION_BORDER = 6, OPTION_NOBORDER = 7,
  OPTION_TITLE = 8, OPTION_NOTITLE = 9, OPTION_PIGNORE = 10, OPTION_MAXIMIZED = 11,
  OPTION_MINIMIZED = 12, OPTION_SHADED = 13, OPTION_OPACITY = 14, OPTION_MAX_H = 15,
  OPTION_MAX_V = 16, OPTION_NOFOCUS = 17
}
 Enumeration of group options. More...

Functions

void InitializeGroups ()
void StartupGroups ()
void ShutdownGroups ()
void DestroyGroups ()
struct GroupType * CreateGroup ()
 Create an empty group.
void AddGroupClass (struct GroupType *gp, const char *pattern)
 Add a window class to a group.
void AddGroupName (struct GroupType *gp, const char *pattern)
 Add a window name to a group.
void AddGroupOption (struct GroupType *gp, OptionType option)
 Add a group option that doesn't take a value.
void AddGroupOptionValue (struct GroupType *gp, OptionType option, const char *value)
 Add a group option that takes a value.
void ApplyGroups (struct ClientNode *np)
 Apply any matching groups to a client.

Detailed Description

Functions for handling window groups.

Author:
Joe Wingbermuehle
Date:
2004-2006

Definition in file group.h.


Enumeration Type Documentation

enum OptionType

Enumeration of group options.

Enumerator:
OPTION_INVALID 
OPTION_STICKY 

Start in the sticky state.

OPTION_LAYER 

Start on a specific layer.

OPTION_DESKTOP 

Start on a specific desktop.

OPTION_ICON 

Set the icon to use.

OPTION_NOLIST 

Don't display in the task list.

OPTION_BORDER 

Force a window border.

OPTION_NOBORDER 

Don't draw a window border.

OPTION_TITLE 

Force a window title bar.

OPTION_NOTITLE 

Don't draw a window title bar.

OPTION_PIGNORE 

Ignore program-specified location.

OPTION_MAXIMIZED 

Start maximized.

OPTION_MINIMIZED 

Start minimized.

OPTION_SHADED 

Start shaded.

OPTION_OPACITY 

Set the opacity.

OPTION_MAX_H 

Use horizontal maximization.

OPTION_MAX_V 

Use vertical maximization.

OPTION_NOFOCUS 

Don't focus on map.

Definition at line 17 of file group.h.


Function Documentation

void AddGroupClass ( struct GroupType *  gp,
const char *  pattern 
)

Add a window class to a group.

Parameters:
gpThe group.
patternA pattern to match with the window class.
void AddGroupName ( struct GroupType *  gp,
const char *  pattern 
)

Add a window name to a group.

Parameters:
gpThe group.
patternA pattern to match with the window name.
void AddGroupOption ( struct GroupType *  gp,
OptionType  option 
)

Add a group option that doesn't take a value.

Parameters:
gpThe group.
optionThe option.
void AddGroupOptionValue ( struct GroupType *  gp,
OptionType  option,
const char *  value 
)

Add a group option that takes a value.

Parameters:
gpThe group.
optionThe option.
valueThe option value.
void ApplyGroups ( struct ClientNode np)

Apply any matching groups to a client.

Parameters:
npThe client.
struct GroupType* CreateGroup ( ) [read]

Create an empty group.

Returns:
An empty group.
void DestroyGroups ( )
void InitializeGroups ( )
void ShutdownGroups ( )
void StartupGroups ( )