JX Application Framework
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
JXWDManager Class Reference

#include <JXWDManager.h>

Inheritance diagram for JXWDManager:
[legend]

Classes

class  WDMenuNeedsUpdate
 

Public Types

enum  { kNoShortcutForDir = -1 }
 

Public Member Functions

 JXWDManager (JXDisplay *display, const bool wantShortcuts=true)
 
 ~JXWDManager () override
 
void GetPermanentDirectors (JPtrArray< JXWindowDirector > *directorList) const
 
void GetDirectors (JPtrArray< JXWindowDirector > *directorList) const
 
void PermanentDirectorCreated (JXWindowDirector *dir, const JString &shortcut=JString::empty, const JUtf8Byte *id=nullptr)
 
void DirectorCreated (JXWindowDirector *dir)
 
void DirectorDeleted (JXWindowDirector *dir)
 
void UpdateWDMenu (JXWDMenu *menu)
 
void HandleWDMenu (JXWDMenu *menu, const JIndex index)
 
- Public Member Functions inherited from JBroadcaster
 JBroadcaster ()
 
virtual ~JBroadcaster ()
 
JBroadcasteroperator= (const JBroadcaster &source)
 
bool HasSenders () const
 
JSize GetSenderCount () const
 
bool HasRecipients () const
 
JSize GetRecipientCount () const
 
virtual JString ToString () const
 
template<class T >
void ListenTo (const JBroadcaster *sender, const std::function< void(const T &)> &f)
 

Static Public Attributes

static const JUtf8BytekWDMenuNeedsUpdate = "WDMenuNeedsUpdate::JXWDManager"
 

Friends

class JXUpdateWDMenuTask
 

Additional Inherited Members

- Protected Member Functions inherited from JBroadcaster
 JBroadcaster (const JBroadcaster &source)
 
void ListenTo (const JBroadcaster *sender)
 
void StopListening (const JBroadcaster *sender)
 
void ClearWhenGoingAway (const JBroadcaster *sender, void *pointerToMember)
 
void StopListening (const JBroadcaster *sender, const std::type_info &messageType)
 
template<class T >
void Send (JBroadcaster *recipient, const T &message)
 
template<class T >
void Broadcast (const T &message)
 
virtual void Receive (JBroadcaster *sender, const Message &message)
 
void SendWithFeedback (JBroadcaster *recipient, Message *message)
 
void BroadcastWithFeedback (Message *message)
 
virtual void ReceiveWithFeedback (JBroadcaster *sender, Message *message)
 
virtual void ReceiveGoingAway (JBroadcaster *sender)
 

Detailed Description

Singleton class that provides the services for JXWDMenu, a menu of all
registered windows.  JXWindowDirectors must register themselves because
not all windows belong on the menu.  JXDocuments automatically register
themselves.

JXWindowDirectors must override GetMenuIcon() in order to display an
icon on JXWDMenu.  They can also override GetName() if they want to
display a name other than their window title.  JXDocuments can override
GetMenuIcon() if they want something other than the default plain file
icon.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kNoShortcutForDir 

Constructor & Destructor Documentation

◆ JXWDManager()

JXWDManager::JXWDManager ( JXDisplay display,
const bool  wantShortcuts = true 
)

◆ ~JXWDManager()

JXWDManager::~JXWDManager ( )
override

Member Function Documentation

◆ DirectorCreated()

void JXWDManager::DirectorCreated ( JXWindowDirector dir)

◆ DirectorDeleted()

void JXWDManager::DirectorDeleted ( JXWindowDirector dir)

Automatically called by ~JXWindowDirector.

◆ GetDirectors()

void JXWDManager::GetDirectors ( JPtrArray< JXWindowDirector > *  directorList) const
inline

◆ GetPermanentDirectors()

void JXWDManager::GetPermanentDirectors ( JPtrArray< JXWindowDirector > *  directorList) const
inline

◆ HandleWDMenu()

void JXWDManager::HandleWDMenu ( JXWDMenu menu,
const JIndex  index 
)

◆ PermanentDirectorCreated()

void JXWDManager::PermanentDirectorCreated ( JXWindowDirector dir,
const JString shortcut = JString::empty,
const JUtf8Byte id = nullptr 
)

◆ UpdateWDMenu()

void JXWDManager::UpdateWDMenu ( JXWDMenu menu)

Friends And Related Symbol Documentation

◆ JXUpdateWDMenuTask

friend class JXUpdateWDMenuTask
friend

Member Data Documentation

◆ kWDMenuNeedsUpdate

const JUtf8Byte * JXWDManager::kWDMenuNeedsUpdate = "WDMenuNeedsUpdate::JXWDManager"
static

The documentation for this class was generated from the following files: