Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::UIShell

VCF::UIShell Class Reference

The desktop represents the Windowing systems bottom most control or "window" and is usually the first window the User sees when the system starts up. More...

#include <vcf/ApplicationKit/UIShell.h>

Inheritance diagram for VCF::UIShell:

VCF::Object List of all members.

Public Types

enum  FileOps { foCopy = 1, foMove, foDelete, foRename }

Public Member Functions

GraphicsContext * getContext ()
void beginPainting (Rect *clippingRect=NULL)
 Prepares the desktop for painting.
void endPainting ()
 called after finished painting on the desktop allows for native Windowing system cleanup to happen
bool supportsVirtualDirectories ()
bool hasFileSystemDirectory ()
String getDirectory ()
UIShellPeer * getUIShellPeer ()
uint32 getWidth ()
uint32 getHeight ()
Rect getUsableBounds ()
Point getCurrentMousePosition ()
void performFileOp (FileOps operationType, const std::vector< String > &srcFiles, const std::vector< String > &destFiles)
void copyFiles (const std::vector< String > &srcFiles, const std::vector< String > &destFiles)
void moveFiles (const std::vector< String > &srcFiles, const std::vector< String > &destFiles)
void deleteFiles (const std::vector< String > &srcFiles)
void copyFile (const String &srcFile, const String &destFile)
void moveFile (const String &srcFile, const String &destFile)
void deleteFile (const String &srcFile)
void launch (const String &fileName, const String &parameters)
void openTrash ()
void emptyTrash ()
void createFileShortcut (const String &originalFileName, const String &shortcutFileName)
MIMEType getMIMEType (const String &fileName)
void createFileAssociation (const FileAssociationInfo &info, bool forAllUsers)
void removeFileAssociation (const FileAssociationInfo &info, bool forAllUsers)

Static Public Member Functions

static UIShell * getUIShell ()

Protected Member Functions

 UIShell ()
virtual ~UIShell ()
void init ()
 called by the UIToolkit.

Static Protected Member Functions

static UIShell * create ()

Protected Attributes

GraphicsContext * context_
bool paintingInitialized_
UIShellPeer * peer_

Static Protected Attributes

static UIShell * shellInstance

Friends

class UIToolkit
class ApplicationKit

Detailed Description

The desktop represents the Windowing systems bottom most control or "window" and is usually the first window the User sees when the system starts up.

The UIShell is also sometimes refered to as the Shell, as in Microsoft Windows. A desktop may or may not allow files, i.e. it in fact is an actual location on the filesystem.

Member Enumeration Documentation

enum VCF::UIShell::FileOps
 

Enumerator:
foCopy 
foMove 
foDelete 
foRename 

Constructor & Destructor Documentation

VCF::UIShell::UIShell (   )  [protected]
 

virtual VCF::UIShell::~UIShell (   )  [protected, virtual]
 

Member Function Documentation

void VCF::UIShell::beginPainting (  Rect *  clippingRect = NULL  ) 
 

Prepares the desktop for painting.

MUST be called before calling getContext(), or errors may occur

Parameters:
Rect* specifies an optional rectangular region to clip the drawing to. The rectangles coords are screen coords.

void VCF::UIShell::copyFile (  const String &  srcFile,
const String &  destFile
) 
 

void VCF::UIShell::copyFiles (  const std::vector< String > &  srcFiles,
const std::vector< String > &  destFiles
) 
 

static UIShell* VCF::UIShell::create (   )  [static, protected]
 

void VCF::UIShell::createFileAssociation (  const FileAssociationInfo &  info,
bool  forAllUsers
) 
 

void VCF::UIShell::createFileShortcut (  const String &  originalFileName,
const String &  shortcutFileName
) 
 

void VCF::UIShell::deleteFile (  const String &  srcFile  ) 
 

void VCF::UIShell::deleteFiles (  const std::vector< String > &  srcFiles  ) 
 

void VCF::UIShell::emptyTrash (   ) 
 

void VCF::UIShell::endPainting (   ) 
 

called after finished painting on the desktop allows for native Windowing system cleanup to happen

GraphicsContext* VCF::UIShell::getContext (   )  [inline]
 

Point VCF::UIShell::getCurrentMousePosition (   ) 
 

String VCF::UIShell::getDirectory (   ) 
 

uint32 VCF::UIShell::getHeight (   ) 
 

MIMEType VCF::UIShell::getMIMEType (  const String &  fileName  ) 
 

static UIShell* VCF::UIShell::getUIShell (   )  [static]
 

UIShellPeer* VCF::UIShell::getUIShellPeer (   )  [inline]
 

Rect VCF::UIShell::getUsableBounds (   ) 
 

uint32 VCF::UIShell::getWidth (   ) 
 

bool VCF::UIShell::hasFileSystemDirectory (   ) 
 

void VCF::UIShell::init (   )  [protected]
 

called by the UIToolkit.

repeated calls after the first initialization do nothing

void VCF::UIShell::launch (  const String &  fileName,
const String &  parameters
) 
 

void VCF::UIShell::moveFile (  const String &  srcFile,
const String &  destFile
) 
 

void VCF::UIShell::moveFiles (  const std::vector< String > &  srcFiles,
const std::vector< String > &  destFiles
) 
 

void VCF::UIShell::openTrash (   ) 
 

void VCF::UIShell::performFileOp (  FileOps  operationType,
const std::vector< String > &  srcFiles,
const std::vector< String > &  destFiles
) 
 

void VCF::UIShell::removeFileAssociation (  const FileAssociationInfo &  info,
bool  forAllUsers
) 
 

bool VCF::UIShell::supportsVirtualDirectories (   ) 
 

Friends And Related Function Documentation

friend class ApplicationKit [friend]
 

friend class UIToolkit [friend]
 

Member Data Documentation

GraphicsContext* VCF::UIShell::context_ [protected]
 

bool VCF::UIShell::paintingInitialized_ [protected]
 

UIShellPeer* VCF::UIShell::peer_ [protected]
 

UIShell* VCF::UIShell::shellInstance [static, protected]
 

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information